IETF Logo Mail Archive

Re: [Rfc-markdown] new kramdown-rfc2629 feature in 1.5.13

Michael Richardson <mcr@sandelman.ca> Sun, 31 October 2021 18:28 UTC

Return-Path: <mcr@sandelman.ca>
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 F05DC3A114F for <rfc-markdown@ietfa.amsl.com>; Sun, 31 Oct 2021 11:28:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, 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 O6qeBHQHmOfd for <rfc-markdown@ietfa.amsl.com>; Sun, 31 Oct 2021 11:28:02 -0700 (PDT)
Received: from tuna.sandelman.ca (tuna.sandelman.ca [209.87.249.19]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 2A9A03A1150 for <rfc-markdown@ietf.org>; Sun, 31 Oct 2021 11:28:01 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by tuna.sandelman.ca (Postfix) with ESMTP id 9B8CF181F7; Sun, 31 Oct 2021 14:29:21 -0400 (EDT)
Received: from tuna.sandelman.ca ([127.0.0.1]) by localhost (localhost [127.0.0.1]) (amavisd-new, port 10024) with LMTP id sG8mYe4WQJEZ; Sun, 31 Oct 2021 14:29:18 -0400 (EDT)
Received: from sandelman.ca (obiwan.sandelman.ca [IPv6:2607:f0b0:f:2::247]) by tuna.sandelman.ca (Postfix) with ESMTP id 50BCD181F2; Sun, 31 Oct 2021 14:29:18 -0400 (EDT)
Received: from localhost (localhost [IPv6:::1]) by sandelman.ca (Postfix) with ESMTP id 1D25888; Sun, 31 Oct 2021 14:27:56 -0400 (EDT)
From: Michael Richardson <mcr@sandelman.ca>
To: Carsten Bormann <cabo@tzi.org>, rfc-markdown@ietf.org
In-Reply-To: <A4D113A2-6388-446C-9D03-E95ECA29A0DD@tzi.org>
References: <a1849958-8325-4474-9578-ce1f093cc49c@www.fastmail.com> <22597.1635514020@localhost> <A4D113A2-6388-446C-9D03-E95ECA29A0DD@tzi.org>
X-Mailer: MH-E 8.6+git; nmh 1.7+dev; GNU Emacs 26.1
X-Face: $\n1pF)h^`}$H>Hk{L"x@)JS7<%Az}5RyS@k9X%29-lHB$Ti.V>2bi.~ehC0; <'$9xN5Ub# z!G,p`nR&p7Fz@^UXIn156S8.~^@MJ*mMsD7=QFeq%AL4m<nPbLgmtKK-5dC@#:k
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg="pgp-sha512"; protocol="application/pgp-signature"
Date: Sun, 31 Oct 2021 14:27:56 -0400
Message-ID: <18092.1635704876@localhost>
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/3OxTXM4SwQIU7vEj-NJxcPQH-P0>
Subject: Re: [Rfc-markdown] new kramdown-rfc2629 feature in 1.5.13
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: Sun, 31 Oct 2021 18:28:07 -0000

Carsten Bormann <cabo@tzi.org> wrote:
    > When I misappropriated that feature for kramdown-rfc, I used it for
    > automatic indexing of terms.
    > Of course, you still want to add index entries manually as well.

    > (There is also the {::boilerplate bcp14-tagged} hack that uses the
    > abbrev mechanism.)

Oh, is that what -tagged does :-)

    > Martin’s contribution is that, besides an index, you can now also use
    > the abbrev feature to provide automatic glossary links.
    > Whether a glossary makes sense in a draft depends a lot on how many
    > terms the reader has to juggle in their minds.
    > Instead of a glossary, you can also simply point back to the sections
    > (or the ABNF/CDDL) defining the term.

I do like it.  Particularly for drafts that use a lot of terms in a specific
way.   draft-ietf-rats-architecture might benefit from it.

    > BTW, in 1.5.15, I have introduced the pseudo attribute “noabbrev” that
    > you can set to true to suppress abbrev processing for a paragraph or a
    > span.

okay.

--
]               Never tell me the odds!                 | ipv6 mesh networks [
]   Michael Richardson, Sandelman Software Works        |    IoT architect   [
]     mcr@sandelman.ca  http://www.sandelman.ca/        |   ruby on rails    [

v2.23.0 | Report a Bug | By Email