Re: [Rfc-markdown] [Tools-discuss] Reference to NIST document

Carsten Bormann <cabo@tzi.org> Sat, 19 June 2021 19:49 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 CB79B3A1E17; Sat, 19 Jun 2021 12:49:24 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: 0.001
X-Spam-Level:
X-Spam-Status: No, score=0.001 tagged_above=-999 required=5 tests=[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 35Vs1bFu7QEy; Sat, 19 Jun 2021 12:49:20 -0700 (PDT)
Received: from gabriel-2.zfn.uni-bremen.de (gabriel-2.zfn.uni-bremen.de [134.102.50.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 CFAE63A1E14; Sat, 19 Jun 2021 12:49:19 -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-2.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4G6mZh6Vvvz2xHd; Sat, 19 Jun 2021 21:49:16 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.7\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <11206.1624131864@localhost>
Date: Sat, 19 Jun 2021 21:49:16 +0200
Cc: Yaron Sheffer <yaronf.ietf@gmail.com>, tools-discuss <tools-discuss@ietf.org>, rfc-markdown@ietf.org
X-Mao-Original-Outgoing-Id: 645824956.404808-9ffe846ba7b3b8455608d9b91bb701e2
Content-Transfer-Encoding: quoted-printable
Message-Id: <4DDD2670-E934-43E3-8F8D-E51B53156180@tzi.org>
References: <CCFB604C-6084-43A4-AD25-97119E98601B@gmail.com> <16D370CB-6A8A-4659-AC06-80BB641F3D1C@tzi.org> <11206.1624131864@localhost>
To: Michael Richardson <mcr+ietf@sandelman.ca>
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/Nl4CykDGh-CXXIp4MslnBbWvWQ0>
Subject: Re: [Rfc-markdown] [Tools-discuss] Reference to NIST document
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: Sat, 19 Jun 2021 19:49:25 -0000


> On 2021-06-19, at 21:44, Michael Richardson <mcr+ietf@sandelman.ca> wrote:
> 
> 
> Carsten Bormann <cabo@tzi.org> wrote:
>> The NIST reference collections are really dusty at this point.
>> Kramdown-rfc does not do shopping around, so a NIST.* reference triggers lookup in bibxml2.
> 
>> I’m lazy and usually use DOIs for NIST references.
> 
>> Putting...
> 
>> informative:
>> NIST.SP.800-56a: DOI.10.6028/NIST.SP.800-56a
> 
> Is "NIST." an kramdown thing?

Kramdown-rfc recognizes NIST.* labels and tries to look them up in bibxml2.

However, the syntax above uses a DOI reference and then renames that, so the above magic is not applied.

> I recognize the DOI as being an alias, but I didn't know I could put a / in there.

Both / and _ should work; since the point of the rename is to get to choose an anchor of one’s liking (and so it doesn’t matter that “/“ cannot be in an anchor), I just copied the / from the original DOI.

> Is anything special done with a DOI?

If it looks like DOI.*, it will be looked up for you from doi.org, so you don’t need to supply your own reference.  doi.org info can be a bit sketchy, though, so better check, and use kramdown-rfc’s doilit tool plus some hand editing if you don’t like the result.

https://github.com/cabo/kramdown-rfc2629/wiki/Pitfalls#reference-anchors

Grüße, Carsten