Re: [Rfc-markdown] how to reference a draft, and a section within an RFC?
Tim Wicinski <tjw.ietf@gmail.com> Wed, 25 January 2023 23:44 UTC
Return-Path: <tjw.ietf@gmail.com>
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 82B40C14CE5D for <rfc-markdown@ietfa.amsl.com>; Wed, 25 Jan 2023 15:44:56 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.094
X-Spam-Level:
X-Spam-Status: No, score=-2.094 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 b6Y6aoAvqRls for <rfc-markdown@ietfa.amsl.com>; Wed, 25 Jan 2023 15:44:52 -0800 (PST)
Received: from mail-ej1-x633.google.com (mail-ej1-x633.google.com [IPv6:2a00:1450:4864:20::633]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 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 031ABC14CF12 for <rfc-markdown@ietf.org>; Wed, 25 Jan 2023 15:44:52 -0800 (PST)
Received: by mail-ej1-x633.google.com with SMTP id mg12so902977ejc.5 for <rfc-markdown@ietf.org>; Wed, 25 Jan 2023 15:44:51 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=ymBAL+feBDCzB25uR+snG8dyRJ8KvnnobJbUOvae0aw=; b=kCvvEEdYJyOpd9rFBcwdXDTZybmjs4CNuY/L1xUuuS+BVFpHfnUXK8xmBAifkB7mvR 6q3Bbib+Uq83K8ulqZwfP5qBw0fGqX+p+EvrFuksvntcO4cnEhaXm0xZhKOhwKmZShD/ NqZ8XZv7sEsK65Bd0YThOPX14yn/aBiIp32Jglh62vIEnf3ksZR/cMeXn7NeS8UGNvtZ sJss7fFZTqJvNVc9CLu5YWRBnLtyPPR/ENAJKFt5wM5qmUPVkicu6aW0zPEbzbZwGZTD EbZFrbmSue1WfyYyr5Hh1FMtQgQXhGvzlccbAkXY6hW67+b7ED4hQSNTc0xXcrnJFLCC yPIA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=ymBAL+feBDCzB25uR+snG8dyRJ8KvnnobJbUOvae0aw=; b=7CUz0Pkq+fXDNsLxvUUn3XtTJjOBBjEL2kItwLKdEyKsjcprvIXTEBnzr7PRUYj8QA rcHXK5e9Rdwl78HggjPr1UoJygJ7PaqJkCRnFqofvMGnzdoq5WKyRwmYvlCqmjy7KZqd GRt7od7Zfl/NN8epvTrCkTjYCFw9aO9GmuDgVTHkjg0PUkNezjS1Ys3nkpOCdqowtvfC ls2XgSFzrKXenSIvG6NmwB2x0KWfpoCm2qp5YYZ+qwy+EPLfd4gVgCobZt5St8qsnV0B 995UjjAMRKPkU9xo5Ru7ilI0NxCDdalIzmWtjYqH1TLAFmLrnPzPvRCU4RlfAk43NlPn T/bQ==
X-Gm-Message-State: AO0yUKVpYl+Q8rL7TwRFA35enpDHnB5zgX5jwHLkol+vqFgpUNtmGaba +Qr9hFziCWrG2sa1W6lTjQ59VdJYXSItgR8WNWUB+GAv
X-Google-Smtp-Source: AK7set+oUCxohnQ+ON3uIsQ3CbDVyuIDjQZ+r4te5/9yAGNGmfTaQt+JK44DjPlzxjcIlcqxXk7OaygX97HBMEAkAgw=
X-Received: by 2002:a17:906:3bda:b0:878:5f93:e797 with SMTP id v26-20020a1709063bda00b008785f93e797mr54016ejf.4.1674690290376; Wed, 25 Jan 2023 15:44:50 -0800 (PST)
MIME-Version: 1.0
References: <b0161e83-b2d7-9edc-50d8-ef19e5cc408e@nohats.ca> <944065C8-2CBD-4C46-AADB-D566A50C2129@tzi.org>
In-Reply-To: <944065C8-2CBD-4C46-AADB-D566A50C2129@tzi.org>
From: Tim Wicinski <tjw.ietf@gmail.com>
Date: Wed, 25 Jan 2023 18:44:39 -0500
Message-ID: <CADyWQ+ER3dytaWJoZ6zyeyOFcX5eRYHWqzQ32op2+ihoX0HhKg@mail.gmail.com>
To: Carsten Bormann <cabo@tzi.org>
Cc: Paul Wouters <paul@nohats.ca>, rfc-markdown@ietf.org
Content-Type: multipart/alternative; boundary="000000000000dde49605f31f372c"
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/DwjlOBBeXvEJRrLRXmOT6xr2OWM>
Subject: Re: [Rfc-markdown] how to reference a draft, and a section within an RFC?
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, 25 Jan 2023 23:44:56 -0000
Thanks Carsten. I had the same issue as Paul and I searched the I-D template repo looking for an example using a current draft. I had not considered the kramdown repo myself. And it seems the key is to not include the version number. tim On Wed, Jan 25, 2023 at 6:24 PM Carsten Bormann <cabo@tzi.org> wrote: > Hi Paul, > > On 25. Jan 2023, at 23:09, Paul Wouters <paul@nohats.ca> wrote: > > > > > > I've inherited a draft in this markdown format. > > Welcome to the club. > > > It seems to try to reference a section using: > > > > ({{rfcxxxx}}, Section x.y) > > The usual syntax is {{Section 3.11 of RFC8949}} > > If you haven’t included the RFC in the YAML header, you can do this right > inline with > > {{Section 3.11 of ?RFC8949}} — informative > {{Section 3.11 of !RFC8949}} — normative > > Or you can do this in the YAML header: > > normative: > RFC8949: > > (No further data are needed, as they are fetched from the bibxml server > bib.ietf.org.) > > > but that seems to not work? And this says you cannot do it: > > > > https://github.com/cabo/kramdown-rfc/issues/21 > > This is a very old issue, discussing the introduction of <relref seven > years ago (an xml2rfc innovation that already is deprecated). > > > Also, I can't find how to add a draft as reference. One would expect > > that {{draft-ietf-foobar}} would work, but it doesn’t. > > The standard bibxml is using I-D.ietf-foobar as the standard anchor; so > far we haven’t tried to change this. > > If you like this anchor format, you can define your own alias anchors in > the YAML header: > > normative: > draft-ietf-foobar: I-D.ietf-foobar > > > I checked the examples/ dir and couldn't find examples either. > > > > If there is documentation anywhere about the format, I would be > > happy to read it. > > The readme at https://rfc.space has some detailed documentation. > > A more introductory approach is taken by various wiki articles at this > space. > > Section references are specifically discussed at: > > https://github.com/cabo/kramdown-rfc/wiki/Syntax2#section-references > > More overview material at: > > https://github.com/cabo/kramdown-rfc/wiki/Syntax#references > > Also, this mailing list has some discussion of various kramdown features. > And of course, you can ask here (as you did!). > > Enjoy! > > Grüße, Carsten > > _______________________________________________ > Rfc-markdown mailing list > Rfc-markdown@ietf.org > https://www.ietf.org/mailman/listinfo/rfc-markdown >
- [Rfc-markdown] how to reference a draft, and a se… Paul Wouters
- Re: [Rfc-markdown] how to reference a draft, and … Carsten Bormann
- Re: [Rfc-markdown] how to reference a draft, and … Tim Wicinski
- Re: [Rfc-markdown] how to reference a draft, and … Carsten Bormann