[Tools-discuss] New tool: bibxml2rfc
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Tools-discuss] New tool: bibxml2rfc



I've just put up a prototype version of a new tool: bibxml2rfc,
which is a reference tool for xml2rfc in the style of bibtex.

URL: https://svn.resiprocate.org/rep/ietf-drafts/ekr/bibxml2rfc

Here's the description from the internal documentation.

     bibxml2rfc is a bibliography helper program for xml2rfc files.
     One of the motivations for bibxml2rfc is that it's hard
     to work with xml2rfc in offline settings. Either you need
     to download the entire database or manually enter each
     database entry. In either case, you need to significantly
     edit your XML file to add a new reference. bibxml2rfc
     is intended to mitigate these issues.
     
     When handed an XML file, bibxml2rfc tries to identify the
     references and construct an appropriate bibliography. The
     general procedure is as follows:
     
     - Find all <xref> elements in the XML file (<file>)
     - Extract the "target" attributes.
     - Look in the local bibliography cache (references/) for files
       named <target>.xml.
     - If no cached entry is found or the the target appears to be
       an I-D (starts with "I-D."), then try to fetch an entry out
       of the appropriate repository on xml.resource.org.
     - Build two files:
       + <file>-normative containing reference entries for the
         normative references
       + <file>-informative containing reference entries for the
         informative references
     
     bibxml2rfc determines whether a reference is normative or
     informative by looking at the 'norm' attribute in the <xref>
     element. If it is 'true', then the reference is normative.
     Note that a single instance of 'norm="true"' is sufficient
     to mark a reference normative, so if multiple <xref> elements
     are present, only one need be so marked.

There's also a simple tool (bibxml2rfc-merge) to produce merged
xml2rfc files for submission.

Arguably, this should be part of xml2rfc proper, but I was in
a bit of a hurry and this was the easiest thing for me to write.
Comments, bugs, etc. welcome.

-Ekr


_______________________________________________
Tools-discuss mailing list
Tools-discuss at ietf.org
https://www.ietf.org/mailman/listinfo/tools-discuss



Note: Messages sent to this list are the opinions of the senders and do not imply endorsement by the IETF.