[Rfc-markdown] 1.5.3: Clean up indented quotes, asides, and blockquotes

Carsten Bormann <cabo@tzi.org> Fri, 23 July 2021 20:50 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 259303A18E5 for <rfc-markdown@ietfa.amsl.com>; Fri, 23 Jul 2021 13:50:33 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.897
X-Spam-Level:
X-Spam-Status: No, score=-1.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id LloSVZytdZ7r for <rfc-markdown@ietfa.amsl.com>; Fri, 23 Jul 2021 13:50:27 -0700 (PDT)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [134.102.50.15]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9D7423A18DE for <rfc-markdown@ietf.org>; Fri, 23 Jul 2021 13:50:27 -0700 (PDT)
Received: from [192.168.217.118] (p548dcc89.dip0.t-ipconnect.de [84.141.204.137]) (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 4GWhKW64pbz2xLk; Fri, 23 Jul 2021 22:50:23 +0200 (CEST)
From: Carsten Bormann <cabo@tzi.org>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
X-Mao-Original-Outgoing-Id: 648766217.171847-74558442cbf3180a9d8edde7250fbd46
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.7\))
Date: Fri, 23 Jul 2021 22:50:22 +0200
Message-Id: <79E64C7B-7DA0-493B-9F20-01B1D991D3BE@tzi.org>
To: rfc-markdown@ietf.org
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/YPowIJohku3j3r5BbGo8OPgVMwY>
Subject: [Rfc-markdown] 1.5.3: Clean up indented quotes, asides, and blockquotes
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
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: Fri, 23 Jul 2021 20:50:33 -0000

While moving yet another draft to markdown, I noticed a little problem with xml2rfc’s handling of v2 list syntax:

https://trac.ietf.org/trac/xml2rfc/ticket/658#ticket
"#658 (sourcecode in lists creates invalid XML in v2v3) – xml2rfc”

1.5.3 works around this specific problem by using v3 syntax instead.

Note that RFCXMLv3 weirdnesses such as not allowing sourcecode in
asides will need additional workarounds (e.g., by interspersing a
figure when that nesting is detected).

While this was being done, I also added a few
default ALDs to make life easier:

{:quote: gi="blockquote"}
{:aside: gi="aside"}
{:markers: sourcecode-markers="true"}
{:unnumbered: numbered="false"}
{:vspace: vspace="0"}
{:removeinrfc: removeinrfc="true"}
{:notoc: toc="exclude"}

For instance, the new ALDs mean that you now can say

# Acknowledgements
{:unnumbered}

Instead of

# Acknowledgements
{: numbered=“false”}

The two changes together now allow you to do

{:aside}
> This approach avoids having to put in XML syntax,
> which always is a little more to type and to make
> mistakes in.

(➔) Use {:aside} or {:quote} before a markdown blockqoute to get an RFCXML aside or blockquote (default for a markdown blockquote continues to be just indented paragraph, not the more elaborate v3 “blockquote” mechanism that almost, but not entirely looks like “aside”).

Of course, the old variant based on using raw XML still works:

<aside markdown=“1”>
This approach avoids having to put in XML syntax,
which always is a little more to type and to make
mistakes in.
</aside>

Less than 36 hours before the I-D repo reopens for IETF 111…
Happy I-D writing.

Grüße, Carsten