"xml2rfc" Version 3 Preparation Tool Description
RFC 7998
Internet Architecture Board (IAB) P. Hoffman
Request for Comments: 7998 ICANN
Category: Informational J. Hildebrand
ISSN: 2070-1721 Mozilla
December 2016
"xml2rfc" Version 3 Preparation Tool Description
Abstract
This document describes some aspects of the "prep tool" that is
expected to be created when the new xml2rfc version 3 specification
is deployed.
Status of This Memo
This document is not an Internet Standards Track specification; it is
published for informational purposes.
This document is a product of the Internet Architecture Board (IAB)
and represents information that the IAB has deemed valuable to
provide for permanent record. It represents the consensus of the
Internet Architecture Board (IAB). Documents approved for
publication by the IAB are not a candidate for any level of Internet
Standard; see Section 2 of RFC 7841.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc7998.
Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document.
Hoffman & Hildebrand Informational [Page 1]
RFC 7998 v3 Prep Tool December 2016
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. xml2rfc v3 Prep Tool Usage Scenarios . . . . . . . . . . . . 4
3. Internet-Draft Submission . . . . . . . . . . . . . . . . . . 4
4. Canonical RFC Preparation . . . . . . . . . . . . . . . . . . 5
5. What the v3 Prep Tool Does . . . . . . . . . . . . . . . . . 5
5.1. XML Sanitization . . . . . . . . . . . . . . . . . . . . 6
5.1.1. XInclude Processing . . . . . . . . . . . . . . . . . 6
5.1.2. DTD Removal . . . . . . . . . . . . . . . . . . . . . 6
5.1.3. Processing Instruction Removal . . . . . . . . . . . 6
5.1.4. Validity Check . . . . . . . . . . . . . . . . . . . 6
5.1.5. Check "anchor" . . . . . . . . . . . . . . . . . . . 6
5.2. Defaults . . . . . . . . . . . . . . . . . . . . . . . . 6
5.2.1. "version" Insertion . . . . . . . . . . . . . . . . . 6
5.2.2. "seriesInfo" Insertion . . . . . . . . . . . . . . . 7
5.2.3. <date> Insertion . . . . . . . . . . . . . . . . . . 7
5.2.4. "prepTime" Insertion . . . . . . . . . . . . . . . . 7
5.2.5. <ol> Group "start" Insertion . . . . . . . . . . . . 7
5.2.6. Attribute Default Value Insertion . . . . . . . . . . 7
5.2.7. Section "toc" attribute . . . . . . . . . . . . . . . 7
5.2.8. "removeInRFC" Warning Paragraph . . . . . . . . . . . 8
5.3. Normalization . . . . . . . . . . . . . . . . . . . . . . 8
5.3.1. "month" Attribute . . . . . . . . . . . . . . . . . . 8
5.3.2. ASCII Attribute Processing . . . . . . . . . . . . . 8
5.3.3. "title" Conversion . . . . . . . . . . . . . . . . . 9
5.4. Generation . . . . . . . . . . . . . . . . . . . . . . . 9
5.4.1. "expiresDate" Insertion . . . . . . . . . . . . . . . 9
5.4.2. <boilerplate> Insertion . . . . . . . . . . . . . . . 9
5.4.2.1. Compare <rfc> "submissionType" and <seriesInfo>
"stream" . . . . . . . . . . . . . . . . . . . . 9
5.4.2.2. "Status of this Memo" Insertion . . . . . . . . . 9
5.4.2.3. "Copyright Notice" Insertion . . . . . . . . . . 10
5.4.3. <reference> "target" Insertion . . . . . . . . . . . 10
5.4.4. <name> Slugification . . . . . . . . . . . . . . . . 10
5.4.5. <reference> Sorting . . . . . . . . . . . . . . . . . 10
5.4.6. "pn" Numbering . . . . . . . . . . . . . . . . . . . 10
5.4.7. <iref> Numbering . . . . . . . . . . . . . . . . . . 11
5.4.8. <xref> Processing . . . . . . . . . . . . . . . . . . 11
5.4.8.1. "derivedContent" Insertion (with Content) . . . . 11
5.4.8.2. "derivedContent" Insertion (without Content) . . 11
5.4.9. <relref> Processing . . . . . . . . . . . . . . . . . 12
5.5. Inclusion . . . . . . . . . . . . . . . . . . . . . . . . 12
5.5.1. <artwork> Processing . . . . . . . . . . . . . . . . 12
5.5.2. <sourcecode> Processing . . . . . . . . . . . . . . . 14
Show full document text