Re: normative references to IANA registries

["HANSEN, TONY L" <tony@xxxxxxx>]

Alia,

 

> I really think that a bit more visibility - including on the xml2rfc.ietf.org page - with a pointer or two - would speed interest and adoption.  

 

Care to contribute text? (Gosh, almost like working on an I-D. :-) )

 

                Tony Hansen

 

From: ietf <ietf-bounces@xxxxxxxx> on behalf of Alia Atlas <akatlas@xxxxxxxxx>
Date: Tuesday, August 1, 2017 at 9:01 AM
To: Carsten Bormann <cabo@xxxxxxx>
Cc: Michael Richardson <mcr+ietf@xxxxxxxxxxxx>, IETF Discussion Mailing List <ietf@xxxxxxxx>
Subject: Re: normative references to IANA registries

 

Carsten,

 

On Tue, Aug 1, 2017 at 3:32 AM, Carsten Bormann <cabo@xxxxxxx> wrote:

On Aug 1, 2017, at 02:45, Michael Richardson <mcr+ietf@xxxxxxxxxxxx> wrote:
>
>
> Carsten Bormann <cabo@xxxxxxx> wrote:
>>> So I wonder out loud: shouldn't all of the IANA registries have clear
>>> reference files that could be normatively referenced?
>
>> Try referencing, say, {{!IANA.cbor-tags}} — it just works :-)
>
> wow. I'm sure it's documented in some place so obvious I can't see it.

https://xml2rfc.tools.ietf.org/ is the place that talks about bibxml8 references.
kramdown-rfc is just mapping all the IANA.* references to bibxml8, as in

https://xml2rfc.tools.ietf.org/public/rfc/bibxml8/reference.IANA.cbor-tags.xml

> Is the "cbor-tags" part the last part of the IANA registry URL?

Apparently.

bibxml8/index.cgi:

    if ($IANAref =~ m(^/?reference.IANA[.]([^/]+)[.](xml|kramdown)$)) {
        my $IANAref = $1;
…
            my $a = get("http://www.iana.org/assignments/$IANAref/“);

kramdown-rfc is, somewhat ironically maybe, using the xml version then :-) (getting the kramdown [really: YAML] version isn't even implemented at xml2rfc.ietf.org, but there is no need to).

 

It would be very helpful to  have the kramdown version at xml2rfc.ietf.org.

Simply going to github (https://github.com/cabo/kramdown-rfc2629)  to download and run the kramdown converter to xml doesn't work trivially on a Windows machine.  I go to http://xml2rfc.tools.ietf.org/experimental.html#kramdown to run it.

 

Since this is the only time that I use kramdown (or any markdown language), it would be quite helpful to

also have a pointer to the syntax to use.  I end up googling and looking at random kramdown documentation 

and hoping.  The error-checking is also a bit frustrating - I had an extra space in front of a - for separating

the authors and the document failed to convert at all with no error.  Not being familiar enough with kramdown,

it was completely non-obvious. 

 

Regardless of the above digression, kramdown-rfc is really awesome and makes it much easier to write drafts!

I've converted over to doing so.  I really think that a bit more visibility - including on the xml2rfc.ietf.org page - with a pointer or two - would speed interest and adoption.  

 

Thank you for your work on this!

Alia