xml2rfc FAQ March 2019
Russo Informational [Page]
Published:
Intended Status:
Informational
Author:
A. Russo
RFC Production Center

xml2rfc Frequently Asked Questions

Abstract

This is a list of frequently asked questions regarding xml2rfc. Please send questions or corrections to the xml2rfc mailing list.

Note: this FAQ is for version 3 of xml2rfc; the vocabulary has been changed significantly from version 2. For guidance on version 2, please see the FAQ for xml2rfc v2.

Table of Contents

1. The Basics

1.1. What is xml2rfc?

xml2rfc is a tool that lets you convert an XML source file into a text, HTML, PDF, expanded XML file, or various other options. It is available from https://xml2rfc.tools.ietf.org [xml2rfc] as a web-based service or for download. Version 3 of the tool adds new features and will be used by the RFC Editor to create RFCs. The current version is here:

1.2. Why should I use xml2rfc?

It's an easy way to create an Internet-Draft in the proper format. It handles boilerplate text and reference text. The HTML and PDF output formats have new features (such as including SVG figures and non-ASCII characters), and the source file can be used for metadata extraction. Also, the RFC Editor will make use of your source file. (For background, see the RFC Format FAQ.)

1.3. How much XML do I need to know?

You need the essentials. XML uses start and end tags, which are nested and matching, and they are case-sensitive. See the section "XML basics" of [Writing I-Ds and RFCs using XML (revised)] for more details.

1.4. Where can I get more information?

2. Creating a Draft

You have several choices when getting started with xml2rfc, such as:

2.2. Where can I get a template?

Several templates for xml2rfc v2 are available from https://tools.ietf.org/tools/templates [templates]. They include templates for a generic draft (e.g., draft-davies-template-bare.xml), as well as for a draft containing a MIB (e.g., mib-doc-template-xml.txt). They have not yet been updated for v3; when some are available, they will be posted in the same directory.

2.3. Can I do it without a template?

Sure. We recommend copying the front matter from a template or the XML source of an existing document, then going from there. Put <t> tags around paragraphs, and <figure><artwork> tags around figures. Use <![CDATA[ ... ]]> within sourcecode elements or artwork that contain the less than character (<). (See What is CDATA for? for more information.)

To get a citation like "[RFC2119]", use <xref target="RFC2119"/>. To get a cross-reference to another section like "see Section 3", use <xref target="s_using_refs"/> (assuming Section 3 has anchor="s_using_refs"). See Using References for more information.

2.4. How do I use the rfc element to create an Internet-Draft?

Use the category attribute to indicate the intended category of your draft, where std is Standards Track, info is Informational, exp is Experimental, bcp is Best Current Practice, and historic is Historic.

Use the submissionType attribute to indicate the intended document stream, where the value can be IETF, IAB, IRTF, or independent.

See Section A.1 of [RFC7991]

Use the docName attribute to indicate the filename.

If the document potentially updates or obsoletes any RFCs, use the updates and obsoletes attributes to indicate the relevant RFC numbers. For Internet-Drafts, this information will be displayed in the header, followed by "(if approved)".

For example, putting it together:

<rfc
   category="info"
   submissionType="IETF"
   ipr="trust200902"
   docName="draft-ietf-wgname-topic-00" 
   updates="1234, 1235" 
   obsoletes="1236"
   sortRefs="true">

Note: The attributes number and seriesNo will be added by the RFC Editor if your draft is approved for publication as an RFC.

Note: Some features that used to be processing instructions (in v2) are now attributes of the rfc element (in v3) -- for example, sortRefs and symRefs.

3. Using References

3.1. How do I put in a reference?

A set of online citation libraries are maintained on xml2rfc.tools.ietf.org [xml2rfc]. They include citations for RFCs, Internet-Drafts, and documents produced by the W3C and 3GPP, among others.

To make use of the citation libraries, there are 2 methods:

  1. define an ENTITY at the top:

    <!ENTITY RFC2119 SYSTEM "https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml">
    

    and use &RFC2119; in the references section

  2. Note: As long as they match, the name you use in the ENTITY definition and the &name; in the references section are your choice, and may be uppercase or lowercase (i.e., rfc2119 or RFC2119 or keywords). We suggest choosing uppercase (i.e., to match the anchor of the reference) in order to make it easier to be consistent.
  3. use an include in the references section

    <?rfc include="reference.RFC.2119.xml"?>
    

    For an Internet-Draft, the citation file uses the draft string. For example:

    <?rfc include="reference.I-D.ietf-wgname-topic.xml"?>
    

Preferably, use the citation libraries when possible. However, another option is to include the complete reference element (see Section 3.2). Here's a template of a reference element:

    <reference anchor="" target="">
        <front>
            <title></title>
            <author initials="" surname="" fullname="">
                <organization />
            </author>
            <date month="" year="" />
        </front>
        <seriesInfo name="" value="" />
    </reference>

All are cited textually in the same manner -- by using xref elements where the target corresponds to the anchor of the reference element, e.g., <xref target="RFC2119" />. The anchors for RFCs are "RFCNNNN" (4 digits, using leading zeros) and the anchors for Internet-Drafts are "I-D.<name without "draft-ietf-" or the version number>".

3.2. How do I insert the full reference?

There are several ways to insert the full reference element from the citation library:

  1. Keep a local copy of the citation libraries. They are available from https://xml2rfc.tools.ietf.org [xml2rfc].
  2. Use a browser to look it up online, e.g., https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml, and copy the page source.
  3. Run xml2rfc with output mode set to XML. The output will include the complete reference elements for any entities and includes.

3.3. How do I change the reference tags from symbolic to numeric, i.e., from [RFC2119] to [1]?

In the rfc element, set the attribute symRefs="no" for symbolic references. This makes reference tags be numeric, e.g., [1], instead of symbolic, e.g., [RFC2119].

3.4. How do I make the reference tag [IKEv2] instead of [RFC4306]?

Use the displayreference element and set the to attribute to the nickname. Tip: place it before the references element. For example:

<displayreference target="RFC7296" to="IKEv2"/>
<references>
[...]
<xi:include
    href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7296.xml"/>

yields:

[IKEv2]
Kaufman, C., Hoffman, P., Nir, Y., Eronen, P., and T. Kivinen, "Internet Key Exchange Protocol Version 2 (IKEv2)", STD 79, RFC 7296, DOI 10.17487/RFC7296, October 2014, <https://www.rfc-editor.org/info/rfc7296>.

3.5. How do I get the references listed in alphabetical order?

In the rfc element, set the attribute sortRefs="yes". Note that sortRefs only has an effect if symRefs="yes".

3.6. How do I reference a URL?

The eref element for an external reference creates a link in the HTML output. For example:

<eref target="https://www.w3.org">

yields https://www.w3.org.

<eref target="https://www.w3.org">W3C Home Page</eref>

yields W3C Home Page.

Another option is using xref and creating a reference that uses the target attribute for the URL. For example:

    <reference anchor="W3C" target="https://www.w3.org/">
        <front>
            <title>World Wide Web Consortium (W3C)</title>
            <author/>
        </front>
    </reference>

yields

[W3C]     "World Wide Web Consortium (W3C)", <https://www.w3.org/>. 

3.7. How do I get two sections of references: Normative and Informative References?

Use the name element (child of the references element) as follows:

    <back>
      <references>
        <name>Normative References</name>
        ...
      </references>
      <references>
        <name>Informative References</name>
        ...
      </references>
    </back>

3.8. How do I make a cross-reference to another section?

Make sure the section you want to reference has an anchor attribute. For example:

  <section title="Security Considerations" anchor="sec_cons">

Then, refer to it with an xref element:

  See <xref target="sec_cons" />.

which yields the text output:

See Section 9.  

(where the number of that section is determined dynamically).

3.9. What about referring to a section in another document? or How do I link to a section in another RFC?

Use <xref> and set the sectionFormat attribute to various options.

sectionFormat="of":
See Section 1.3 of [RFC7991]
sectionFormat="comma":
See [RFC7991], Section 1.3
sectionFormat="parens":
See [RFC7991] (Section 1.3)
sectionFormat="bare":
See Section 1.3
(default) When sectionFormat is not set at all, the output is the same as "of":
See Section 1.3 of [RFC7991]

3.10. How do I get 'See Sections 2 and 3' instead of 'See Section 2 and Section 3'?

Use the format attribute. For example, assuming the anchor attributes for the relevant sections have the values "sec_cons" and "IANA_cons":

See Sections <xref target="s_creating" format="counter" /> and
<xref target="s_using_refs" format="counter" />.

yields the output:

See Sections 2 and 4.

Note: The format attribute can have the value "title", which displays the title of the section. For example,

See the <xref target="s_using_lists" format="title" />.

yields the output:

See Using Lists.

4. Using Lists

4.1. How do I get different kinds of lists?

For bulleted lists, use the <ul> element.

For an empty list (indentation only), use the <ul> element with empty="true".

For definition lists (a.k.a. hanging lists in xml2rfc v2), use the <dl> element. See Section 4.4.

For numbers or letters, use the type attribute of the <ol> element; examples below.

For full details, see Section 2.34.5 of [RFC7991]

  • type="1" --> 1, 2, 3, ...
  • type="I" --> I, II, III, ...
  • type="i" --> i, ii, iii, ...
  • type="a" --> a, b, c, ...
  • type="A" --> A, B, C, ...
  • type="REQ%d:" --> [See Section 4.2.]

4.2. How do I get a list like (1), (2), (3) or (a), (b), (c)?

(1)
(2)    is   <ol type="(%d)">
(3)

(a)
(b)    is   <ol type="(%c)">
(c)

REQ1:
REQ2:  is   <ol type="REQ%d:">
REQ3:

4.3. How do I get continuous numbering in a list that is split by text (or across sections)?

Set the group attribute to the same value for each <ol> element. For example:

 <ol type="REQ%d:" group="reqs">
  <li>MUST do a</li>
  <li>MUST do b</li>
</ol>
<t>Here is text in between.</t>
<ol type="REQ%d:" group="reqs">
  <li>SHOULD do c</li>
  <li>SHOULD do d</li>
</ol>
<t>Here is more text in between.</t>
<ol type="REQ%d:" group="reqs">
  <li>MAY do e</li>
  <li>MAY do f</li>
</ol>

yields:

REQ1:
MUST do a
REQ2:
MUST do b

Here is text in between.

REQ3:
SHOULD do c
REQ4:
SHOULD do d

Here is more text in between.

REQ5:
MAY do e
REQ6:
MAY do f

4.4. How do I get indentation? or How do I use definition lists?

Use a <dl> element (definition list), where each <dt> (term) in has a corresponding <dd> (description).

For example:

<dl>
  <dt>Unassigned:</dt>
  <dd>Unused and available for assignment via
  documented procedures.</dd>
  
  <dt>Reserved:</dt>
  <dd>Not to be assigned.  Reserved values are
  held for special uses, such as to extend the namespace
  when it become exhausted.  Reserved values are not
  available for general assignment.</dd>
</dl>

yields:

Unassigned:
Unused and available for assignment via documented procedures.
Reserved:
Not to be assigned. Reserved values are held for special uses, such as to extend the namespace when it become exhausted. Reserved values are not available for general assignment.

Note: The appearance is slightly different in the text output.

Use newline="true" to get a line break after the term. For example:

<dl newline="true">
  <dt>Unassigned:</dt>
  <dd>Unused and available for assignment via
  documented procedures.</dd>
  
  <dt>Reserved:</dt>
  <dd>Not to be assigned.  Reserved values are
  held for special uses, such as to extend the namespace
  when it become exhausted.  Reserved values are not
  available for general assignment.</dd>
</dl>

yields:

Unassigned:
Unused and available for assignment via documented procedures.
Reserved:
Not to be assigned. Reserved values are held for special uses, such as to extend the namespace when it become exhausted. Reserved values are not available for general assignment.

5. The Finer Points

5.1. What is CDATA for?

A CDATA block is left alone by xml2rfc. It does not try to parse XML inside of a CDATA block. (For example, if a figure contains "<", you don't have to use &lt;) So it is especially good for when there are XML examples in the document.

5.2. What are the entities used for special characters?

To prevent these characters from being parsed as XML, use

&amp; for &
&lt; for <
&gt; for >

In addition, the following entities are defined:

&apos; for '
&quot; for "
&nbsp; for non-breaking space
&nbhy; for non-breaking hyphen

5.3. How do I indicate the editor of the document?

Use the role attribute of the author element. For example:

<author initials="J" surname="Doe" fullname="John Doe" role="editor">

5.4. How do I insert questions for my coauthors?

You can use comments <!-- --> or <cref> elements. Comments are only visible in the XML source file.

Example of using comments:

<!-- [JD] This point needs revision.-->

<cref> will show up in the output when the attribute display="true" (which is the default).

Example of using <cref>:

<cref anchor="Q1" source="JD">This point needs revision.</cref>

yields

This point needs revision.JD

6. Miscellaneous

6.1. How do I know if my XML is valid?

xml2rfc validates it. Also, you can run rfclint: https://pypi.org/project/rfclint/.

6.2. Can I get a different kind of HTML output?

Yes, rfc2629.xslt by Julian Reschke provides a different kind of HTML output than the HTML output mode of xml2rfc. See "Transforming RFC7749-formatted XML through XSLT" for more information.

6.3. Is there a tool that will turn my text file into an XML file (i.e., id2xml)?

Yes, id2xml is available here: https://pypi.org/project/id2xml/. It is available as a web service on https://xml2rfc.tools.ietf.org/.

7. New with v3

7.1. How do I convert my XML file from v2 to v3 so I can make use of the new features?

On the command line: xml2rfc --v2v3 inputfile.xml

Using the web service (https://xml2rfc.tools.ietf.org/experimental.html), select "Output format: convert v2 to v3 XML".

7.2. What are the new features with v3?

Some highlights are including Unicode characters, text formatting, and SVG diagrams. For complete details, see Section 1.3 of [RFC7991]

7.3. How do I insert non-ASCII characters?

With encoding="utf-8" in your XML file, you can use non-ASCII characters in the following locations:

  • author name and organization (fullname, initials, and surname attributes; organization element). The asciiFullname, asciiInitials, and asciiSurnames attributes hold the ASCII equivalents.
  • author's postal address (street, city, region, code, and country elements) and author's email address. Each of these elements has an ascii attribute to hold the ASCII equivalent, which will also appear in the output format.
  • body of the document (using the <u> element; see below)

The <u> element goes around a Unicode character; set the format attribute (using the keywords num, name, lit, char, and ascii) to determine what is displayed in the output. See Section A.1 of [I-D.levkowetz-xml2rfc-v3-implementation-notes]

format="num-lit":
a single character U+6C34 ("水"), often representing "water"
format="num-name":
a single character U+6C34 (CJK UNIFIED IDEOGRAPH-6C34), often representing "water"
format="num-lit-name":
a single character U+6C34 ("水", CJK UNIFIED IDEOGRAPH-6C34), often representing "water"
format="num-name-lit":
a single character U+6C34 (CJK UNIFIED IDEOGRAPH-6C34, "水"), often representing "water"
format="name-lit-num":
a single character CJK UNIFIED IDEOGRAPH-6C34 ("水", U+6C34), often representing "water"
format="lit-name-num" (default):
a single character "水" (CJK UNIFIED IDEOGRAPH-6C34, U+6C34), often representing "water"
format="{lit} character ({num})":
the "水" character (U+6C34)

For background, see [RFC7997].

7.4. How do I insert a table?

For example:

<table anchor="table_ex">
  <name>IETF Meetings in 2005</name>
  <thead>
    <tr>
      <th align='center'>IETF #</th>
      <th align='center'>City</th>
      <th align='center'># of Attendees</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td align="center">62</td>
      <td align="center">Minneapolis</td>
      <td align="center">1133</td>
    </tr>
    <tr> 
      <td align="center">63</td>
      <td align="center">Paris</td>
      <td align="center">1450</td>
    </tr>
    <tr>
      <td align="center">64</td>
      <td align="center">Vancouver</td>
      <td align="center">1240</td>
    </tr>
  </tbody>
</table>

yields:

Table 1: IETF Meetings in 2005
IETF # City # of Attendees
62 Minneapolis 1133
63 Paris 1450
64 Vancouver 1240

Data from https://www.ietf.org/how/meetings/past/.

For full details, see Section 2.54 of [RFC7991]

7.5. How do I generate SVG that will be accepted in an RFC?

You can check your SVG file against the SVG Tiny 1.2 spec on the experimental page (https://xml2rfc.tools.ietf.org/experimental.html), and a script called svgcheck is available here: https://pypi.org/project/svgcheck/.

For more information, see [RFC7996] and Tips on creating SVG files.

7.6. How do I include SVG in my document?

From RFC 7991:

There are at least five ways to include SVG in artwork in Internet-Drafts:

  • Inline, by including all of the SVG in the content of the element, such as: <artwork type="svg"><svg xmlns="http://www.w3.org/2000/ svg...">
  • Inline, but using XInclude (see Appendix B.1), such as: <artwork type="svg"><xi:include href=...>
  • As a data: URI, such as: <artwork type="svg" src="data:image/ svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3...">
  • As a URI to an external entity, such as: <artwork type="svg" src="http://www.example.com/...">
  • As a local file, such as: <artwork type="svg" src="diagram12.svg">

For any given SVG artwork, you can provide an ASCII art equivalent (for use in the text output) by using the <artset> element. For example:

<figure>
  <name>TCP Header Format</name>
  <artset>
    <artwork alt="TCP Header" type="svg">
      <xi:include
   href="https://www.rfc-editor.org/materials/format/svg/tcp-header.svg"/>
    </artwork>
    <artwork alt="TCP Header from RFC 793" type="ascii-art">
       [... ASCII ART ...]
    </artwork>
 </artset>
</figure>
    

Which yields:

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 Source Port Destination Port 0 Sequence Number 8 Acknowledgement Number 16 Data Offset Reserved Urg Ack Psh Rst Syn Fin Window 24 Checksum Urgent Pointer 32 Options Padding 40 Data 48
Figure 1: TCP Header Format

7.7. How do I get bold, italics, or a fixed-width font?

Use

  • <em> for italics,
  • <strong> for bold, and
  • <tt> for fixed-width font.

7.8. How do I get subscript and superscript?

Use <sub> for subscript, and <sup> for superscript.

Example (from RFC 6330):

  • x0 = (y + i) mod 28
  • x1 = (floor(y / 28) + i) mod 28
  • x2 = (floor(y / 216) + i) mod 28
  • x3 = (floor(y / 224) + i) mod 28

7.9. What are the possible values for the type of the sourcecode element?

abnf, asn.1, bash, c++, c, cbor, dtd, java, javascript, json, mib, perl, pseudocode, python, rnc, xml, and yang.

For details, see Section 2.48.4 of [RFC7991]

7.10. Do I have to use the bcp14 element each time a keyword (e.g., "MUST") appears in my document?

It is not a MUST, but it makes the usage more clear.

SHOULD without the <bcp14> element, SHOULD with it.

7.11. What is the best way to print a hardcopy?

Print the PDF.

7.12. How do I download the XML source files for all RFCs?

The source files of RFCs have changed over time. Most RFCs have NROFF source files; sometimes an XML file has been archived. You can request an XML source file directly from rfc-editor@rfc-editor.org. For RFCs created after the transition to using xml2rfc v3, the XML files will be available for download from https://www.rfc-editor.org/retrieve/bulk.

7.13. What has been deprecated from xml2rfc v2?

See Section 1.3.3 of [RFC7991]

8. Informative References

[howto]
Rose, M., "Writing I-Ds and RFCs using XML (revised)", , <https://xml2rfc.ietf.org/authoring/draft-mrose-writing-rfcs.html>.
[I-D.levkowetz-xml2rfc-v3-implementation-notes]
Levkowetz, H., "Implementation notes for RFC7991, "The 'xml2rfc' Version 3 Vocabulary"", Internet-Draft draft-levkowetz-xml2rfc-v3-implementation-notes-08, , <https://www.ietf.org/archive/id/draft-levkowetz-xml2rfc-v3-implementation-notes-08>.
[IKEv2]
Kaufman, C., Hoffman, P., Nir, Y., Eronen, P., and T. Kivinen, "Internet Key Exchange Protocol Version 2 (IKEv2)", STD 79, RFC 7296, DOI 10.17487/RFC7296, , <https://www.rfc-editor.org/info/rfc7296>.
[RFC7991]
Hoffman, P., "The "xml2rfc" Version 3 Vocabulary", RFC 7991, DOI 10.17487/RFC7991, , <https://tools.ietf.org/html/rfc7991>.
[RFC7996]
Brownlee, N., "SVG Drawings for RFCs: SVG 1.2 RFC", RFC 7996, DOI 10.17487/RFC7996, , <https://www.rfc-editor.org/info/rfc7996>.
[RFC7997]
Flanagan, H., Ed., "The Use of Non-ASCII Characters in RFCs", RFC 7997, DOI 10.17487/RFC7997, , <https://www.rfc-editor.org/info/rfc7997>.
[templates]
"Templates directory", , <https://tools.ietf.org/tools/templates/>.
[W3C]
"World Wide Web Consortium (W3C)", <https://www.w3.org/>.
[xml2rfc]
"xml2rfc", , <https://xml2rfc.ietf.org/>.

Acknowledgments

This FAQ was made possible by the tools, documentation, and test files created by Henrik Levkowetz, Julian Reschke, Paul Hoffman, and Sandy Ginoza.

Author's Address

Alice Russo
RFC Production Center