search

rfc-format / draft-iab-xml2rfc-v3-bis

-bis document for the RFC format xml2rfc v3 draft
6 stars 10 forks source link

readme

Structure

Note that the subsections of the main sections "Elements" and "Elements from v2 That Have Been Deprecated" of draft-iab-rfc7991bis.xml are auto-generated based on:

1) xml2rfcv3.rng, and 2) draft-iab-rfc7991bis.xml itself.

To change the (RNG) grammar, edit xml2rfcv3.rng and run "make":

xml2rfcv3-spec.xml: xml2rfcv3.rng rng2xml2rfc.xslt $(XSLT) $< rng2xml2rfc.xslt voc=v3 specsrc=draft-iab-rfc7991bis.xml > $@

xml2rfcv3-spec-deprecated.xml: xml2rfcv3.rng rng2xml2rfc.xslt $(XSLT) $< rng2xml2rfc.xslt specsrc=draft-iab-rfc7991bis.xml deprecated=yes > $@

This will generate xml2rfcv3-spec.xml and xml2rfcv3-spec-deprecated.xml, based on the grammar and the prose already present in draft-iab-rfc7991bis.xml.

Example source for :

--- snip ---

<workgroup> This element is used to specify the Working Group (IETF) or Research Group (IRTF) from which the document originates, if any. The recommended format is the official name of the Working Group (with some capitalization). In Internet-Drafts, this is used in the upper left corner of the boilerplate, replacing the "Network Working Group" string. Formatting software can append the words "Working Group" or "Research Group", depending on the "submissionType" property of the <rfc> element (). This element appears as a child element of <front> (). Content model: only text content.

--- snip ---

Within this section, elements can be added to the element and attribute descriptions and are supposed to round-trip through the re-generation process.

xml2rfcv3-spec.xml and xml2rfcv3-spec-deprecated.xml are re-inserted into the source file using refresh-inclusions.sh (documented at https://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#refreshing.inclusions). Note that this approach was chosen so that the source file remains self-contained.

Building

Building the spec requires:

1) java 2) xml2rfc 3) Saxon10he (https://mvnrepository.com/artifact/net.sf.saxon/Saxon-HE/10.2) 4) Trang (checked in)