Re: [Rfc-markdown] [Tools-discuss] kramdown / i-d-template breakage
Carsten Bormann <cabo@tzi.org> Wed, 29 June 2022 18:54 UTC
Return-Path: <cabo@tzi.org>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 12C4AC14F73A; Wed, 29 Jun 2022 11:54:43 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.91
X-Spam-Level:
X-Spam-Status: No, score=-6.91 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_HI=-5, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01] autolearn=unavailable autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id nE_lxAU52MV5; Wed, 29 Jun 2022 11:54:38 -0700 (PDT)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [IPv6:2001:638:708:32::15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C3B26C14F73F; Wed, 29 Jun 2022 11:54:37 -0700 (PDT)
Received: from smtpclient.apple (p5089ad4f.dip0.t-ipconnect.de [80.137.173.79]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4LY9cS5NxKzDCbV; Wed, 29 Jun 2022 20:54:32 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.100.31\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <CF55F37F-A12E-400B-82AA-2C15DC0B8CE3@akamai.com>
Date: Wed, 29 Jun 2022 20:54:32 +0200
Cc: tools-discuss <tools-discuss@ietf.org>, rfc-markdown@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <0BF5D4BC-CDD6-4C46-A771-B63014D50707@tzi.org>
References: <87F5177C-A50B-4F67-88C7-CA25FE503D8C@akamai.com> <BA840C6C-EB9B-47EB-82D5-D825BE6BFF73@tzi.org> <CF55F37F-A12E-400B-82AA-2C15DC0B8CE3@akamai.com>
To: "Salz, Rich" <rsalz=40akamai.com@dmarc.ietf.org>
X-Mailer: Apple Mail (2.3696.100.31)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/0GWvQR6MSQV6mui89qMpSOBi9zQ>
Subject: Re: [Rfc-markdown] [Tools-discuss] kramdown / i-d-template breakage
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 29 Jun 2022 18:54:43 -0000
On 29. Jun 2022, at 18:50, Salz, Rich <rsalz=40akamai.com@dmarc.ietf.org> wrote: > > - title: Information Technology - ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER) This breaks, because colon in YAML is used to separate keys and values, and you have two colons in the same line. Yaron gave you one solution (surrounding the text in quotes). YAML also has less intrusive ways to deal with long text snippets. My personal favorite in this case is to use the > signifier: title: > Information Technology - ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER) So you start a text block (which will be treated as a single 1d string) with a > on its own, and use indented text to fill it in. That keeps the text clean and makes the line breaks inconsequential. For further reading I can recommend: https://github.com/cabo/kramdown-rfc/wiki/Syntax#pitfalls-in-yaml Grüße, Carsten
- Re: [Rfc-markdown] [Tools-discuss] kramdown / i-d… Carsten Bormann
- Re: [Rfc-markdown] [Tools-discuss] kramdown / i-d… Carsten Bormann
- Re: [Rfc-markdown] [Tools-discuss] kramdown / i-d… Salz, Rich