search

reschke / xml2rfc

A formatter for the "xml2rfc" vocabulary, implemented in XSLT.
12 stars 5 forks source link

Warning of "initials" from IETF-provided BibXML #14

Open ronaldtse opened 6 years ago

ronaldtse commented 6 years ago

Coming from https://github.com/riboseinc/asciidoctor-rfc/issues/81.

Our draft here (https://github.com/riboseinc/rfc-openpgp-oscca) has produced this output

$ saxon draft-ribose-openpgp-oscca-01.xml rfc2629.xslt  > a.html
...
WARNING: @initials 'A': did you mean 'A.'?
WARNING: @initials 'S': did you mean 'S.'?
WARNING: @initials 'X': did you mean 'X.'?
WARNING: @initials 'R': did you mean 'R.'?
WARNING: @initials 'W': did you mean 'W.'?
WARNING: @initials 'P': did you mean 'P.'?
WARNING: @initials 'R': did you mean 'R.'?
WARNING: @initials 'W': did you mean 'W.'?
WARNING: @initials 'S': did you mean 'S.'?
WARNING: @initials 'S': did you mean 'S.'?
WARNING: @initials 'X': did you mean 'X.'?
...

And these @initials warnings are due to BibXML references directly fetched from IETF.

wget https://xml2rfc.tools.ietf.org/public/rfc/bibxml-ids/reference.I-D.oscca-cfrg-sm3.xml

Content:

<reference anchor="I-D.oscca-cfrg-sm3">
<front>
<title>The SM3 Cryptographic Hash Function</title>
<author initials="S" surname="Shen" fullname="Sean Shen">
    <organization/>
</author>
<author initials="X" surname="Lee" fullname="XiaoDong Lee">
    <organization/>
</author>
<author initials="R" surname="Tse" fullname="Ronald Tse">
    <organization/>
</author>
<author initials="W" surname="Wong" fullname="Wai Wong">
    <organization/>
</author>
<author initials="P" surname="Yang" fullname="Paul Yang">
    <organization/>
</author>
<date month="November" day="14" year="2017"/>
<abstract><t>This document describes the SM3 cryptographic hash algorithm ...</t></abstract>
</front>
<seriesInfo name="Internet-Draft" value="draft-oscca-cfrg-sm3-02"/>
<format type="TXT" target="http://www.ietf.org/internet-drafts/draft-oscca-cfrg-sm3-02.txt"/>
</reference>

The best thing to do here seems to be fixing https://xml2rfc.tools.ietf.org/public/rfc/... to return correctly specified @initials?

reschke commented 6 years ago

...or to clarify the exact format of initials and possibly remove the warning...

ronaldtse commented 6 years ago

@reschke they're probably not mutually exclusive?

  1. What is the "exact format of initials"? Maybe it should be specified in the RFC.

  2. Will fixing https://xml2rfc.tools.ietf.org/public/rfc/ be possible?

reschke commented 6 years ago

  1. It would need to go into the style guide. See https://tools.ietf.org/html/draft-flanagan-7322bis-02#section-4.1.1 - once that is clarified, the xml2rfc docs could be aligned.

  2. Fixing the references might be possible, but we first would have to find out what "fixing" means.

ronaldtse commented 6 years ago

I've just posted a ticket to Heather's draft. Hope we can get this resolved soon!