asciidoctor-rfc 0.9.0 → 0.9.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +20 -8
- data/README.adoc +2 -2
- data/asciidoctor-rfc.gemspec +1 -1
- data/docs/installation.md +21 -0
- data/docs/navigation.md +10 -0
- data/docs/overview.md +5 -0
- data/lib/asciidoctor/rfc/common/base.rb +9 -0
- data/lib/asciidoctor/rfc/v2/base.rb +4 -2
- data/lib/asciidoctor/rfc/v3/base.rb +6 -1
- data/lib/asciidoctor/rfc/version.rb +1 -1
- data/lib/metanorma/rfc/processor_v2.rb +5 -1
- data/lib/metanorma/rfc/processor_v3.rb +5 -1
- data/spec/examples/davies-template-bare-06.xml.orig.txt +448 -0
- data/spec/examples/draft-iab-html-rfc-bis.xml.orig.txt +2298 -0
- data/spec/examples/draft-iab-rfc-framework-bis.xml.orig.txt +896 -0
- data/spec/examples/draft-ietf-core-block-xx.xml.orig.txt +1176 -0
- data/spec/examples/hoffmanv2.xml.orig.txt +280 -0
- data/spec/examples/mib-doc-template-xml-06.xml.orig.txt +672 -0
- data/spec/examples/rfc1149.md.2.xml.txt +168 -0
- data/spec/examples/rfc2100.md.2.xml.txt +168 -0
- data/spec/examples/rfc3514.md.2.xml.txt +336 -0
- data/spec/examples/rfc5841.md.2.xml.txt +504 -0
- data/spec/examples/rfc748.md.2.xml.txt +168 -0
- data/spec/examples/rfc7511.md.2.xml.txt +448 -0
- data/spec/examples/skel.xml.orig.txt +112 -0
- data/spec/examples/stupid-s.xml.orig.txt +784 -0
- metadata +21 -4
@@ -0,0 +1,896 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
Internet Architecture Board H. Flanagan
|
6
|
+
Internet-Draft RFC Editor
|
7
|
+
Intended status: Informational June 23, 2016
|
8
|
+
Expires: December 25, 2016
|
9
|
+
|
10
|
+
|
11
|
+
RFC Format Framework
|
12
|
+
draft-iab-rfc-framework-06
|
13
|
+
|
14
|
+
Abstract
|
15
|
+
|
16
|
+
The canonical format for the RFC Series has been plain-text, ASCII-
|
17
|
+
encoded for several decades. After extensive community discussion
|
18
|
+
and debate, the RFC Editor will be transitioning to XML as the
|
19
|
+
canonical format using the XML2RFC version 3 vocabulary. Different
|
20
|
+
publication formats will be rendered from that base document. These
|
21
|
+
changes are intended to increase the usability of the RFC Series by
|
22
|
+
offering documents that match the needs of a wider variety of
|
23
|
+
stakeholders. With these changes, however, comes an increase in
|
24
|
+
complexity for authors, consumers, and the publisher of RFCs. This
|
25
|
+
document serves as the framework that describes the problems being
|
26
|
+
solved and summarizes the many documents that capture the specific
|
27
|
+
requirements for each aspect of the change in format.
|
28
|
+
|
29
|
+
Editorial Note (To be removed by RFC Editor)
|
30
|
+
|
31
|
+
Discussion of this draft takes place on the rfc-interest mailing list
|
32
|
+
(rfc-interest@rfc-editor.org), which has its home page at
|
33
|
+
https://www.rfc-editor.org/mailman/listinfo/rfc-interest.
|
34
|
+
|
35
|
+
Status of This Memo
|
36
|
+
|
37
|
+
This Internet-Draft is submitted in full conformance with the
|
38
|
+
provisions of BCP 78 and BCP 79.
|
39
|
+
|
40
|
+
Internet-Drafts are working documents of the Internet Engineering
|
41
|
+
Task Force (IETF). Note that other groups may also distribute
|
42
|
+
working documents as Internet-Drafts. The list of current Internet-
|
43
|
+
Drafts is at http://datatracker.ietf.org/drafts/current/.
|
44
|
+
|
45
|
+
Internet-Drafts are draft documents valid for a maximum of six months
|
46
|
+
and may be updated, replaced, or obsoleted by other documents at any
|
47
|
+
time. It is inappropriate to use Internet-Drafts as reference
|
48
|
+
material or to cite them other than as "work in progress."
|
49
|
+
|
50
|
+
This Internet-Draft will expire on December 25, 2016.
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
Flanagan Expires December 25, 2016 [Page 1]
|
57
|
+
|
58
|
+
Internet-Draft RFC Format Framework June 2016
|
59
|
+
|
60
|
+
|
61
|
+
Copyright Notice
|
62
|
+
|
63
|
+
Copyright (c) 2016 IETF Trust and the persons identified as the
|
64
|
+
document authors. All rights reserved.
|
65
|
+
|
66
|
+
This document is subject to BCP 78 and the IETF Trust's Legal
|
67
|
+
Provisions Relating to IETF Documents
|
68
|
+
(http://trustee.ietf.org/license-info) in effect on the date of
|
69
|
+
publication of this document. Please review these documents
|
70
|
+
carefully, as they describe your rights and restrictions with respect
|
71
|
+
to this document. Code Components extracted from this document must
|
72
|
+
include Simplified BSD License text as described in Section 4.e of
|
73
|
+
the Trust Legal Provisions and are provided without warranty as
|
74
|
+
described in the Simplified BSD License.
|
75
|
+
|
76
|
+
Table of Contents
|
77
|
+
|
78
|
+
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
|
79
|
+
2. Problem Statement . . . . . . . . . . . . . . . . . . . . . . 3
|
80
|
+
3. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
|
81
|
+
4. Overview of the Decision Making Process . . . . . . . . . . . 4
|
82
|
+
5. Key Changes . . . . . . . . . . . . . . . . . . . . . . . . . 6
|
83
|
+
6. Canonical Format Documents . . . . . . . . . . . . . . . . . 6
|
84
|
+
6.1. XML for RFCs . . . . . . . . . . . . . . . . . . . . . . 6
|
85
|
+
7. Publication Format Documents . . . . . . . . . . . . . . . . 8
|
86
|
+
7.1. HTML . . . . . . . . . . . . . . . . . . . . . . . . . . 8
|
87
|
+
7.2. PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
|
88
|
+
7.3. Plain Text . . . . . . . . . . . . . . . . . . . . . . . 9
|
89
|
+
7.4. Potential Future Publication Formats . . . . . . . . . . 9
|
90
|
+
7.4.1. EPUB . . . . . . . . . . . . . . . . . . . . . . . . 9
|
91
|
+
8. Figures and Artwork . . . . . . . . . . . . . . . . . . . . . 9
|
92
|
+
8.1. SVG . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
|
93
|
+
9. Content and Page Layout . . . . . . . . . . . . . . . . . . . 10
|
94
|
+
9.1. Non-ASCII Characters . . . . . . . . . . . . . . . . . . 10
|
95
|
+
9.2. Style Guide . . . . . . . . . . . . . . . . . . . . . . . 10
|
96
|
+
9.3. CSS Requirements . . . . . . . . . . . . . . . . . . . . 10
|
97
|
+
10. Transition Plan . . . . . . . . . . . . . . . . . . . . . . . 10
|
98
|
+
10.1. Statement of Work and RFP for Tool Development . . . . . 10
|
99
|
+
10.2. Testing and Transition . . . . . . . . . . . . . . . . . 10
|
100
|
+
10.3. Completion . . . . . . . . . . . . . . . . . . . . . . . 12
|
101
|
+
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
|
102
|
+
12. Security Considerations . . . . . . . . . . . . . . . . . . . 12
|
103
|
+
13. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 12
|
104
|
+
14. Appendix - Change log . . . . . . . . . . . . . . . . . . . . 12
|
105
|
+
14.1. draft-iab-rfc-framework-05 to -06 . . . . . . . . . . . 13
|
106
|
+
14.2. draft-iab-rfc-framework-04 to -05 . . . . . . . . . . . 13
|
107
|
+
14.3. draft-iab-rfc-framework-03 to -04 . . . . . . . . . . . 13
|
108
|
+
14.4. draft-iab-rfc-framework-02 to -03 . . . . . . . . . . . 13
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
Flanagan Expires December 25, 2016 [Page 2]
|
113
|
+
|
114
|
+
Internet-Draft RFC Format Framework June 2016
|
115
|
+
|
116
|
+
|
117
|
+
14.5. draft-iab-rfc-framework-01 to -02 . . . . . . . . . . . 13
|
118
|
+
14.6. draft-iab-rfc-framework-00 to -01 . . . . . . . . . . . 13
|
119
|
+
15. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
|
120
|
+
15.1. Normative References . . . . . . . . . . . . . . . . . . 13
|
121
|
+
15.2. Informative References . . . . . . . . . . . . . . . . . 14
|
122
|
+
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 16
|
123
|
+
|
124
|
+
1. Introduction
|
125
|
+
|
126
|
+
"RFC Series Format Requirements and Future Development" discussed the
|
127
|
+
need for additional features within RFCs such as non-ASCII characters
|
128
|
+
to respect author names, more advanced artwork than ASCII art, and
|
129
|
+
documents that could display properly on a wide variety of devices
|
130
|
+
[RFC6949]. Based on the discussions with the IETF community as well
|
131
|
+
as other communities of interest, the RFC Series Editor decided to
|
132
|
+
explore a change to the format of the Series [XML-ANNOUNCE]. This
|
133
|
+
document serves as the framework that describes the problems being
|
134
|
+
solved and summarizes the documents created to-date that capture the
|
135
|
+
specific requirements for each aspect of the change in format.
|
136
|
+
|
137
|
+
Key changes to the publication of RFCs are highlighted, and a
|
138
|
+
transition plan that will take the Series from a plain-text, ASCII-
|
139
|
+
only format to the new formats is described on the rfc-interest
|
140
|
+
mailing list [RFC-INTEREST].
|
141
|
+
|
142
|
+
This document is concerned with the production of RFCs, focusing on
|
143
|
+
the published formats. It does not address any changes to the
|
144
|
+
processes each stream uses to develop and review their submissions
|
145
|
+
(specifically, how Internet-Drafts will be developed). While I-Ds
|
146
|
+
have a similar set of issues and concerns, directly addressing those
|
147
|
+
issues for I-Ds will be discussed within each document stream.
|
148
|
+
|
149
|
+
The details described in this document are expected to change based
|
150
|
+
on experience gained in implementing the RFC Production Center's
|
151
|
+
toolset. Revised documents will be published capturing those changes
|
152
|
+
as the toolset is completed. Other implementers must not expect
|
153
|
+
those changes to remain backwards-compatible with the details
|
154
|
+
described this document.
|
155
|
+
|
156
|
+
2. Problem Statement
|
157
|
+
|
158
|
+
There are nearly three billion people connected to the Internet, and
|
159
|
+
individuals from 45 countries or more regularly attending IETF
|
160
|
+
meetings over the last five years [ISTATS]. The Internet is now
|
161
|
+
global, and while the world has changed from when the first RFCs were
|
162
|
+
published, the Series remains critical to defining protocols,
|
163
|
+
standards, best practices, and more for this global network that
|
164
|
+
continues to grow. In order to make RFCs easily viewable to the
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
Flanagan Expires December 25, 2016 [Page 3]
|
169
|
+
|
170
|
+
Internet-Draft RFC Format Framework June 2016
|
171
|
+
|
172
|
+
|
173
|
+
largest number of people possible, across a wide array of devices,
|
174
|
+
and to respect the diversity of authors and reference materials while
|
175
|
+
still recognizing the archival aspects of the Series, it is time to
|
176
|
+
update the tightly prescribed format of the RFC Series.
|
177
|
+
|
178
|
+
All changes to the format of the RFC Series must consider the
|
179
|
+
requirements of a wide set of communities, over an extended length of
|
180
|
+
time. For example, existing authors and implementers, lawyers that
|
181
|
+
argue Intellectual Property Rights (IPR), educators, managers, and
|
182
|
+
policy-makers that need to know what to list in potential RFPs for
|
183
|
+
their organizations, all have preferences and requirements for their
|
184
|
+
specific needs. The immediate needs of today's communities must be
|
185
|
+
balanced with the needs for long-term archival storage.
|
186
|
+
|
187
|
+
3. Terminology
|
188
|
+
|
189
|
+
The following terminology is used as described in RFC 6949:
|
190
|
+
|
191
|
+
ASCII: Coded Character Set - 7-bit American Standard Code for
|
192
|
+
Information Interchange, ANSI X3.4-1986
|
193
|
+
|
194
|
+
Canonical format: the authorized, recognized, accepted, and
|
195
|
+
archived version of the document
|
196
|
+
|
197
|
+
Metadata: information associated with a document so as to provide,
|
198
|
+
for example, definitions of its structure, or of elements within
|
199
|
+
the document such as its topic or author
|
200
|
+
|
201
|
+
Publication format: display and distribution format as it may be
|
202
|
+
read or printed after the publication process has completed
|
203
|
+
|
204
|
+
Reflowable text: text that automatically wraps to the next line in
|
205
|
+
a document as the user moves the margins of the text, either by
|
206
|
+
resizing the window or changing the font size
|
207
|
+
|
208
|
+
Revisable format: the format that will provide the information for
|
209
|
+
conversion into a Publication format; it is used or created by the
|
210
|
+
RFC Editor
|
211
|
+
|
212
|
+
Submission format: the format submitted to the RFC Editor for
|
213
|
+
editorial revision and publication
|
214
|
+
|
215
|
+
4. Overview of the Decision Making Process
|
216
|
+
|
217
|
+
Requirements, use cases, concerns, and suggestions were collected
|
218
|
+
from the communities of interest at every stage of the RFC format
|
219
|
+
update project. Input was received through the rfc-interest mailing
|
220
|
+
list, as well as in several face-to-face sessions at IETF meetings.
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
Flanagan Expires December 25, 2016 [Page 4]
|
225
|
+
|
226
|
+
Internet-Draft RFC Format Framework June 2016
|
227
|
+
|
228
|
+
|
229
|
+
Regular conversations were held with the IETF, IRTF, IAB, and IAOC
|
230
|
+
chairs, and the Independent Stream Editor, to discuss high-level
|
231
|
+
stream requirements. Updates regarding the status of the project
|
232
|
+
were provided to the IETF community during the IETF Technical Plenary
|
233
|
+
as well as Format BoFs or IAB sessions at IETF 84, IETF 85, IETF 88,
|
234
|
+
IETF 89, and IETF 90 [IETF84] [IETF85] [IETF88] [IETF89] [IETF90].
|
235
|
+
|
236
|
+
The first document published, RFC 6949, provided the first solid
|
237
|
+
documentation on what the requirements were for the Series and in
|
238
|
+
effect was the output from the first year of discussion on the topic
|
239
|
+
of RFC format. That RFC, as with all of the RFCs that informed the
|
240
|
+
format update work, was published as an IAB stream document, thus
|
241
|
+
following the process described in RFC 4845, "Process for Publication
|
242
|
+
of IAB RFCs" [RFC4845].
|
243
|
+
|
244
|
+
After the high-level requirements were published, the RFC Series
|
245
|
+
Editor (RSE) brought together an RFC Format Design Team to start
|
246
|
+
working out the necessary details to develop the code needed to
|
247
|
+
create new and changed formats. The design team discussed moving
|
248
|
+
away from the existing xml2rfc vocabulary, but with such a strong
|
249
|
+
existing support base within the community and no clear value with
|
250
|
+
other XML vocabularies or schemas, the decision was made to work with
|
251
|
+
the XML2RFC version 2 (xml2rfc v2) model and use it as the base for
|
252
|
+
the new format world [RFC7749]. Part of this discussion included a
|
253
|
+
decision to stop using an XML document type definition (DTD) in favor
|
254
|
+
of a Regular Language for XML Next General (Relax NG) model using a
|
255
|
+
defined vocabulary. While the bi-weekly calls for this team were
|
256
|
+
limited to Design Team members, review of the decisions as documented
|
257
|
+
in the drafts produced by this team were done publicly through
|
258
|
+
requests for feedback on the rfc-interest mailing list. Several of
|
259
|
+
the drafts produced by the Design Team, including the xml2rfc v2 and
|
260
|
+
v3 drafts and the SVG profile drafts, were sent through an early
|
261
|
+
GenART review before starting the process to be accepted as an IAB
|
262
|
+
stream draft [GEN-ART] [I-D.iab-xml2rfc].
|
263
|
+
|
264
|
+
While the IETF community provided the majority of input on the
|
265
|
+
process, additional outreach opportunities were sought to gain input
|
266
|
+
from an even broader audience. Informal discussions were held with
|
267
|
+
participants at several International Association of Scientific,
|
268
|
+
Technical, and Medical Publisher events, and presentations made at
|
269
|
+
technical conferences such as the TERENA Networking Conference 2014
|
270
|
+
and NORDUnet 2014 [TNC2014] [NDN2014].
|
271
|
+
|
272
|
+
In order to respond to concerns regarding responses to subpoenas and
|
273
|
+
to understand the requirements for lawyers, advice was requested from
|
274
|
+
the IETF Trust legal team regarding what format or formats would be
|
275
|
+
considered reasonable when responding to a subpoena request for an
|
276
|
+
RFC.
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
Flanagan Expires December 25, 2016 [Page 5]
|
281
|
+
|
282
|
+
Internet-Draft RFC Format Framework June 2016
|
283
|
+
|
284
|
+
|
285
|
+
Given that several other standards development organizations (SDOs)
|
286
|
+
do not offer plain-text documents, and in fact may offer more than
|
287
|
+
one format for their standards, informal input was sought from them
|
288
|
+
regarding their experience with supporting one or more non-plain-text
|
289
|
+
formats for their standards.
|
290
|
+
|
291
|
+
Finally, the entire process was reviewed regularly with the RFC
|
292
|
+
Series Oversight Committee and regular updates provided to the IAB
|
293
|
+
and IESG [RSOC]. They have offered support and input throughout the
|
294
|
+
process.
|
295
|
+
|
296
|
+
Where consensus was not reached during the process, the RSE made any
|
297
|
+
necessary final decisions, as per the guidance in RFC 6635, "RFC
|
298
|
+
Editor Model (Version 2)" [RFC6635].
|
299
|
+
|
300
|
+
5. Key Changes
|
301
|
+
|
302
|
+
At the highest level, the changes being made to the RFC Format
|
303
|
+
involve breaking away from a pure-ASCII plain text and moving to
|
304
|
+
canonical format that includes all the information required for
|
305
|
+
rendering a document into a wide variety of publication formats. The
|
306
|
+
RFC Editor will become responsible for more than just the plain-text
|
307
|
+
file and the PDF-from-text format created at time of publication;
|
308
|
+
they will be creating several different formats in order to meet the
|
309
|
+
diverse requirements of the community.
|
310
|
+
|
311
|
+
The final XML file produced by the RFC Editor will be considered the
|
312
|
+
canonical format for RFCs; it is the lowest common denominator that
|
313
|
+
holds all the information intended for an RFC. PDF/A-3 will be the
|
314
|
+
publication format offered in response to subpoenas for RFCs
|
315
|
+
published through this new process, and will be developed with an eye
|
316
|
+
towards long-term archival storage. HTML will be the focus of
|
317
|
+
providing the most flexible set of features for an RFC, including
|
318
|
+
JavaScript to provide pointers to errata and other metadata. Plain-
|
319
|
+
text will continue to be offered in order to support existing tool
|
320
|
+
chains where practicable and the individuals who prefer to read RFCs
|
321
|
+
in this format.
|
322
|
+
|
323
|
+
6. Canonical Format Documents
|
324
|
+
|
325
|
+
6.1. XML for RFCs
|
326
|
+
|
327
|
+
Key points regarding the XML format:
|
328
|
+
|
329
|
+
o The canonical format for RFCs is XML using the XML2RFC version 3
|
330
|
+
(xml2rfc v3) vocabulary. This file must contain all information
|
331
|
+
necessary to render a variety of formats; any question about what
|
332
|
+
was intended in the publication will be answered from this format.
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
Flanagan Expires December 25, 2016 [Page 6]
|
337
|
+
|
338
|
+
Internet-Draft RFC Format Framework June 2016
|
339
|
+
|
340
|
+
|
341
|
+
o Authors may submit drafts in xml2rfc v2 vocabulary, but the final
|
342
|
+
publication will convert that to xml2rfc v3 vocabulary.
|
343
|
+
|
344
|
+
o SVG is supported and will be embedded in the final XML file.
|
345
|
+
|
346
|
+
o There will be automatically generated identifiers for sections,
|
347
|
+
paragraphs, figures, and tables in the final XML file.
|
348
|
+
|
349
|
+
o The XML file will not contain any xml2rfc v3 vocabulary elements
|
350
|
+
or attributes that have been marked deprecated.
|
351
|
+
|
352
|
+
o A Document Type Definition (DTD) will no longer be used. The
|
353
|
+
grammar will be defined using RelaxNG.
|
354
|
+
|
355
|
+
o The final XML file will contain, verbatim, the appropriate
|
356
|
+
boilerplate as applicable at time of publication specified by RFC
|
357
|
+
5741 or its successors [RFC5741].
|
358
|
+
|
359
|
+
o The final XML will be self-contained with all the information
|
360
|
+
known at publication time. For instance, all features that
|
361
|
+
reference externally-defined input will be expanded. This
|
362
|
+
includes all uses of xinclude, src attributes (such as in
|
363
|
+
<artwork> or <sourcecode> elements), include-like processing
|
364
|
+
instructions, and externally defined entities.
|
365
|
+
|
366
|
+
o The final XML will not contain comments or processing
|
367
|
+
instructions.
|
368
|
+
|
369
|
+
o The final XML will not contain src attributes for <artwork> or
|
370
|
+
<sourcecode> elements.
|
371
|
+
|
372
|
+
[RFC7749] describes the xml2rfc v2 vocabulary. While in wide use
|
373
|
+
today, this vocabulary previously had not been formally documented.
|
374
|
+
In order to understand what needed to change in the vocabulary to
|
375
|
+
allow for a more simple experience and additional features for
|
376
|
+
authors, the current vocabulary needed to be fully described. This
|
377
|
+
document will be obsoleted by the RFC published from draft-iab-
|
378
|
+
xml2rfc.
|
379
|
+
|
380
|
+
[I-D.iab-xml2rfc] Describes the xml2rfc v3 vocabulary. The design
|
381
|
+
goals in this vocabulary were to make the vocabulary more intuitive
|
382
|
+
for authors, and to expand the features to support the changes being
|
383
|
+
made in the publication process. This draft, when published, will
|
384
|
+
obsolete the RFC 7749.
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
Flanagan Expires December 25, 2016 [Page 7]
|
393
|
+
|
394
|
+
Internet-Draft RFC Format Framework June 2016
|
395
|
+
|
396
|
+
|
397
|
+
7. Publication Format Documents
|
398
|
+
|
399
|
+
7.1. HTML
|
400
|
+
|
401
|
+
[I-D.iab-html-rfc] - Describes the semantic HTML that will be
|
402
|
+
produced by the RFC Editor from the xml2rfc v3 files.
|
403
|
+
|
404
|
+
Key points regarding the HTML output:
|
405
|
+
|
406
|
+
o The HTML will be rendered from the XML file; it will not be
|
407
|
+
derived from the plain-text publication format.
|
408
|
+
|
409
|
+
o The body of the document will use a subset of HTML. The documents
|
410
|
+
will include CSS for default visual presentation; it can be
|
411
|
+
overwritten by a local CSS file.
|
412
|
+
|
413
|
+
o SVG is supported and will be included in the HTML file.
|
414
|
+
|
415
|
+
o Text will be reflowable.
|
416
|
+
|
417
|
+
o JavaScript will be supported on a limited basis. It will not be
|
418
|
+
permitted to overwrite or change any text present in the rendered
|
419
|
+
html. It may, on a limited basis, add additional text that
|
420
|
+
provides post-publication metadata or pointers if warranted. All
|
421
|
+
such text will be clearly marked as additional.
|
422
|
+
|
423
|
+
7.2. PDF
|
424
|
+
|
425
|
+
[I-D.iab-rfc-use-of-pdf] - Describes the tags and profiles that will
|
426
|
+
be used to create the new PDF format, including both the internal
|
427
|
+
structure and the visible layout of the file. A review of the
|
428
|
+
different versions of PDF is offered, with a recommendation of what
|
429
|
+
PDF standard should apply to RFCs.
|
430
|
+
|
431
|
+
Key points regarding the PDF output:
|
432
|
+
|
433
|
+
o The PDF file will be rendered from the XML file; it will not be
|
434
|
+
derived from the plain-text publication format.
|
435
|
+
|
436
|
+
o The PDF publication format will conform to the PDF/A-3 standard
|
437
|
+
and will embed the canonical XML source.
|
438
|
+
|
439
|
+
o The PDF will look more like the HTML publication format than the
|
440
|
+
plain-text publication format.
|
441
|
+
|
442
|
+
o The PDF will include a rich set of tags and metadata within the
|
443
|
+
document
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
Flanagan Expires December 25, 2016 [Page 8]
|
449
|
+
|
450
|
+
Internet-Draft RFC Format Framework June 2016
|
451
|
+
|
452
|
+
|
453
|
+
o SVG is supported and will be included in the PDF file.
|
454
|
+
|
455
|
+
7.3. Plain Text
|
456
|
+
|
457
|
+
[I-D.iab-rfc-plaintext] - Describes the details of the plain text
|
458
|
+
format, focusing in particular on what is changing from the existing
|
459
|
+
plain-text output.
|
460
|
+
|
461
|
+
Key points regarding the plain-text output:
|
462
|
+
|
463
|
+
o The plain-text document will no longer be the canonical version of
|
464
|
+
an RFC.
|
465
|
+
|
466
|
+
o The plain-text format will be UTF-8 encoded; non-ASCII characters
|
467
|
+
will be allowed.
|
468
|
+
|
469
|
+
o A Byte Order Mark (BOM) will be added at the start of each file.
|
470
|
+
|
471
|
+
o Widow and orphan control for the plain-text publication format
|
472
|
+
will not have priority for the developers creating the rendering
|
473
|
+
code [TYPOGRAPHY].
|
474
|
+
|
475
|
+
o Authors may choose to have pointers to line art in other
|
476
|
+
publication formats in place of ASCII art in the .txt file.
|
477
|
+
|
478
|
+
o Both a paginated and an unpaginated plain-text file will be
|
479
|
+
created.
|
480
|
+
|
481
|
+
o Running headers and footers will not be used.
|
482
|
+
|
483
|
+
7.4. Potential Future Publication Formats
|
484
|
+
|
485
|
+
7.4.1. EPUB
|
486
|
+
|
487
|
+
This format is intended for use by ebook readers and will be
|
488
|
+
available for RFCs after the requirements have been defined. No
|
489
|
+
draft is currently available.
|
490
|
+
|
491
|
+
8. Figures and Artwork
|
492
|
+
|
493
|
+
8.1. SVG
|
494
|
+
|
495
|
+
[I-D.iab-svg-rfc] Describes the profile for SVG line art. SVG is an
|
496
|
+
XML-based vocabulary for creating line drawings; SVG information will
|
497
|
+
be embedded within the canonical XML at time of publication.
|
498
|
+
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
Flanagan Expires December 25, 2016 [Page 9]
|
505
|
+
|
506
|
+
Internet-Draft RFC Format Framework June 2016
|
507
|
+
|
508
|
+
|
509
|
+
9. Content and Page Layout
|
510
|
+
|
511
|
+
9.1. Non-ASCII Characters
|
512
|
+
|
513
|
+
There are security and readability implications to moving outside the
|
514
|
+
ASCII range of characters. [I-D.iab-rfc-nonascii] focuses on exactly
|
515
|
+
where and how non-ASCII characters may be used in an RFC, with an eye
|
516
|
+
towards keeping the documents as secure and readable as possible
|
517
|
+
given the information that needs to be expressed.
|
518
|
+
|
519
|
+
9.2. Style Guide
|
520
|
+
|
521
|
+
The RFC Style Guide [RFC7322] was revised to remove as much page
|
522
|
+
formatting information as possible, focusing instead on grammar,
|
523
|
+
structure, and content of RFCs. Some of the changes recommended,
|
524
|
+
however, informed the XML v3 vocabulary.
|
525
|
+
|
526
|
+
9.3. CSS Requirements
|
527
|
+
|
528
|
+
[I-D.iab-rfc-css] describe how the CSS classes mentioned in the HTML
|
529
|
+
format draft, "HyperText Markup Language Request for Comments
|
530
|
+
Format", should be used to create an accessible and responsive design
|
531
|
+
for the HTML format.
|
532
|
+
|
533
|
+
10. Transition Plan
|
534
|
+
|
535
|
+
10.1. Statement of Work and RFP for Tool Development
|
536
|
+
|
537
|
+
Existing tools for the creation of RFCs will need to be updated, and
|
538
|
+
new tools created, to implement the updated format. As the
|
539
|
+
requirements gathering effort, described in the various documents
|
540
|
+
described earlier int this draft, finishes the bulk of the work, the
|
541
|
+
Tools Development Team of the IETF will work with the RSE to develop
|
542
|
+
Statements of Work (SoWs). Those SoWs will first be reviewed within
|
543
|
+
the Tools Development Team, the Tools Management Committee, and go
|
544
|
+
out for a public comment period. After public review, the SoWs will
|
545
|
+
be attached to a Request for Proposal (RFP) and posted as per the
|
546
|
+
IASA bid process [IASA-RFP].
|
547
|
+
|
548
|
+
Once bids have been received, reviewed, and awarded, coding will
|
549
|
+
begin.
|
550
|
+
|
551
|
+
10.2. Testing and Transition
|
552
|
+
|
553
|
+
During the I-D review and approval process, authors and stream-
|
554
|
+
approving bodies will select drafts to run through the proposed new
|
555
|
+
publication process. While the final RFCs published during this time
|
556
|
+
will continue as plain-text and immutable once published, the
|
557
|
+
|
558
|
+
|
559
|
+
|
560
|
+
Flanagan Expires December 25, 2016 [Page 10]
|
561
|
+
|
562
|
+
Internet-Draft RFC Format Framework June 2016
|
563
|
+
|
564
|
+
|
565
|
+
feedback process is necessary to bootstrap initial testing. These
|
566
|
+
early tests will target finding issues with the proposed xml2rfc v3
|
567
|
+
vocabulary that result in poorly formed publication formats as well
|
568
|
+
as issues that prevent proper review of submitted drafts.
|
569
|
+
|
570
|
+
Feedback will result in regular iteration of the basic code and XML
|
571
|
+
vocabulary. In order to limit the amount of time the RFC Production
|
572
|
+
Center (RPC) spends on testing and QA, their priority will be to edit
|
573
|
+
and publish documents; therefore, community assistance will be
|
574
|
+
necessary to help move this stage along. A mailing list and
|
575
|
+
experimental source directory on the RFC Editor website will be
|
576
|
+
created for community members willing to assist in the detailed
|
577
|
+
review of the XML and publication formats. Editorial checks of the
|
578
|
+
publication formats by the community are out of scope; the focus will
|
579
|
+
be the QA of each available output, checking for inconsistencies
|
580
|
+
across formats.
|
581
|
+
|
582
|
+
The purpose of testing phase is to work with the community to
|
583
|
+
identify and fix bugs in the process and the code, before producing
|
584
|
+
canonical, immutable XML, and to collect additional feedback on the
|
585
|
+
usability of the new publication formats.
|
586
|
+
|
587
|
+
Any modifications to the draft review process, up to and including
|
588
|
+
AUTH48, will happen with the community and the stream approving
|
589
|
+
bodies as we learn more about the features and outputs of the new
|
590
|
+
publication tools. Defining those processes is out of scope for this
|
591
|
+
document.
|
592
|
+
|
593
|
+
Success will be measured by the closure of all bugs which had been
|
594
|
+
identified by the RPC and the Tools Development team as fatal and
|
595
|
+
consensus on the readiness of the XML vocabulary and final XML files
|
596
|
+
for publication. The actual rendering engine can go through further
|
597
|
+
review and iteration, as the publication formats may be republished
|
598
|
+
as needed.
|
599
|
+
|
600
|
+
Authors are not required to submit their approved drafts in an XML
|
601
|
+
format, though they are strongly encouraged to do so; plain-text will
|
602
|
+
also remain an option for the foreseeable future. However, documents
|
603
|
+
submitted as plain-text cannot include such features as SVG artwork.
|
604
|
+
The RPC will generate an XML file if necessary for basic processing
|
605
|
+
and subsequent rendering into the approved output formats.
|
606
|
+
|
607
|
+
A known risk at this point of the transition is the difficulty in
|
608
|
+
quantifying the resources required from the RPC. This phase will
|
609
|
+
require more work on the part of the RPC to support both old and new
|
610
|
+
publication processes for at least six months. There is potential
|
611
|
+
for confusion as consumers of RFCs find some documents published at
|
612
|
+
this time with a full set of outputs, while other documents only have
|
613
|
+
|
614
|
+
|
615
|
+
|
616
|
+
Flanagan Expires December 25, 2016 [Page 11]
|
617
|
+
|
618
|
+
Internet-Draft RFC Format Framework June 2016
|
619
|
+
|
620
|
+
|
621
|
+
plain text. There may be a delay in publication as new bugs are
|
622
|
+
found that must be fixed before the files can be converted into the
|
623
|
+
canonical format and associated publication formats.
|
624
|
+
|
625
|
+
Final success of the transition will be measured by the closure of
|
626
|
+
all bugs which had been identified by the RPC and the Tools
|
627
|
+
Development team as major or critical. There must also be rough
|
628
|
+
consensus from the community regarding the utility of the new
|
629
|
+
formats.
|
630
|
+
|
631
|
+
10.3. Completion
|
632
|
+
|
633
|
+
Authors may submit XML (preferred) or plain text. The XML drafts
|
634
|
+
submitted for publication will be converted to canonical XML format
|
635
|
+
and published with all available publication formats. All authors
|
636
|
+
will be expected to review the final documents as consistent with the
|
637
|
+
evolving procedures for reviewing drafts.
|
638
|
+
|
639
|
+
Success for this phase will be measured by a solid understanding by
|
640
|
+
the RSE and the IAOC of the necessary costs and resources required
|
641
|
+
for long-term support of the new format model.
|
642
|
+
|
643
|
+
11. IANA Considerations
|
644
|
+
|
645
|
+
This document has no actions for IANA.
|
646
|
+
|
647
|
+
12. Security Considerations
|
648
|
+
|
649
|
+
Changing the format for RFCs involves modifying a great number of
|
650
|
+
components to publication. Understanding those changes and the
|
651
|
+
implications for the entire tool chain is critical so as to avoid
|
652
|
+
unintended bugs that would allow unintended changes to text.
|
653
|
+
Unintended changes to text could in turn corrupt a standard, practice
|
654
|
+
or critical piece of information about a protocol.
|
655
|
+
|
656
|
+
13. Acknowledgements
|
657
|
+
|
658
|
+
With many thanks to the RFC Format Design Team for their efforts in
|
659
|
+
making this transition successful: Nevil Brownlee (ISE), Tony Hansen,
|
660
|
+
Joe Hildebrand, Paul Hoffman, Ted Lemon, Julian Reschke, Adam Roach,
|
661
|
+
Alice Russo, Robert Sparks (Tools Team liaison), and Dave Thaler.
|
662
|
+
|
663
|
+
14. Appendix - Change log
|
664
|
+
|
665
|
+
To be removed by RFC Editor
|
666
|
+
|
667
|
+
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
Flanagan Expires December 25, 2016 [Page 12]
|
673
|
+
|
674
|
+
Internet-Draft RFC Format Framework June 2016
|
675
|
+
|
676
|
+
|
677
|
+
14.1. draft-iab-rfc-framework-05 to -06
|
678
|
+
|
679
|
+
xml2rfcv2: minor clarifications
|
680
|
+
|
681
|
+
14.2. draft-iab-rfc-framework-04 to -05
|
682
|
+
|
683
|
+
Introduction: minor clarifications
|
684
|
+
|
685
|
+
Updated references
|
686
|
+
|
687
|
+
14.3. draft-iab-rfc-framework-03 to -04
|
688
|
+
|
689
|
+
Introduction: editorial changes
|
690
|
+
|
691
|
+
Clarified that submitted plain text will be converted to XML by the
|
692
|
+
RPC; the XML will be used to render all output formats.
|
693
|
+
|
694
|
+
14.4. draft-iab-rfc-framework-02 to -03
|
695
|
+
|
696
|
+
HTML output: clarified expectations around use of JavaScript.
|
697
|
+
|
698
|
+
14.5. draft-iab-rfc-framework-01 to -02
|
699
|
+
|
700
|
+
Introduction: Removed some unnecessary history.
|
701
|
+
|
702
|
+
14.6. draft-iab-rfc-framework-00 to -01
|
703
|
+
|
704
|
+
Decision Making Process: noted taht other XML schemas and
|
705
|
+
vocabularies were considered by the design team
|
706
|
+
|
707
|
+
XML for RFCs: "boilerplate at time of publication"
|
708
|
+
|
709
|
+
HTML: clarified that JavaScript should not impact readability of the
|
710
|
+
document as it looked at time of publication
|
711
|
+
|
712
|
+
15. References
|
713
|
+
|
714
|
+
15.1. Normative References
|
715
|
+
|
716
|
+
[I-D.iab-html-rfc]
|
717
|
+
Hildebrand, J. and P. Hoffman, "HyperText Markup Language
|
718
|
+
Request For Comments Format", draft-iab-html-rfc-03 (work
|
719
|
+
in progress), June 2016.
|
720
|
+
|
721
|
+
[I-D.iab-rfc-css]
|
722
|
+
Flanagan, H., "CSS Requirements for RFCs", draft-iab-rfc-
|
723
|
+
css-01 (work in progress), July 2016.
|
724
|
+
|
725
|
+
|
726
|
+
|
727
|
+
|
728
|
+
Flanagan Expires December 25, 2016 [Page 13]
|
729
|
+
|
730
|
+
Internet-Draft RFC Format Framework June 2016
|
731
|
+
|
732
|
+
|
733
|
+
[I-D.iab-rfc-nonascii]
|
734
|
+
Flanagan, H., "The Use of Non-ASCII Characters in RFCs",
|
735
|
+
draft-iab-rfc-nonascii-02 (work in progress), April 2016.
|
736
|
+
|
737
|
+
[I-D.iab-rfc-plaintext]
|
738
|
+
Flanagan, H., "Requirements for Plain-Text RFCs", draft-
|
739
|
+
iab-rfc-plaintext-03 (work in progress), May 2016.
|
740
|
+
|
741
|
+
[I-D.iab-rfc-use-of-pdf]
|
742
|
+
Hansen, T., Masinter, L., and M. Hardy, "PDF for an RFC
|
743
|
+
Series Output Document Format", draft-iab-rfc-use-of-
|
744
|
+
pdf-02 (work in progress), May 2016.
|
745
|
+
|
746
|
+
[I-D.iab-svg-rfc]
|
747
|
+
Brownlee, N., "SVG Drawings for RFCs: SVG 1.2 RFC", draft-
|
748
|
+
iab-svg-rfc-02 (work in progress), February 2016.
|
749
|
+
|
750
|
+
[I-D.iab-xml2rfc]
|
751
|
+
Hoffman, P., "The "xml2rfc" version 3 Vocabulary", draft-
|
752
|
+
iab-xml2rfc-04 (work in progress), June 2016.
|
753
|
+
|
754
|
+
[RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format
|
755
|
+
Requirements and Future Development", RFC 6949, May 2013.
|
756
|
+
|
757
|
+
This is a primary reference work.
|
758
|
+
|
759
|
+
[RFC7749] Reschke, J., "The "xml2rfc" Version 2 Vocabulary",
|
760
|
+
RFC 7749, DOI 10.17487/RFC7749, February 2016,
|
761
|
+
<https://www.rfc-editor.org/info/rfc7749>.
|
762
|
+
|
763
|
+
15.2. Informative References
|
764
|
+
|
765
|
+
[GEN-ART] IETF, "General Area Review Team (Gen-ART)", n.d.,
|
766
|
+
<http://www.ietf.org/iesg/directorate/gen-art.html>.
|
767
|
+
|
768
|
+
[IASA-RFP]
|
769
|
+
IETF Administrative Support Activity, "RFPs and RFIs",
|
770
|
+
n.d., <http://iaoc.ietf.org/rfps-rfis.html>.
|
771
|
+
|
772
|
+
[IETF84] Flanagan, H., "IETF 84 Proceedings: RFC Format (rfcform)",
|
773
|
+
n.d., <http://www.ietf.org/proceedings/84/rfcform.html>.
|
774
|
+
|
775
|
+
[IETF85] Flanagan, H., "IETF 85 Proceedings: RFC Format (rfcform)",
|
776
|
+
n.d., <http://www.ietf.org/proceedings/85/rfcform.html>.
|
777
|
+
|
778
|
+
[IETF88] Flanagan, H., "IETF 88 Proceedings: RFC Format (rfcform)",
|
779
|
+
n.d., <http://www.ietf.org/proceedings/88/rfcform.html>.
|
780
|
+
|
781
|
+
|
782
|
+
|
783
|
+
|
784
|
+
Flanagan Expires December 25, 2016 [Page 14]
|
785
|
+
|
786
|
+
Internet-Draft RFC Format Framework June 2016
|
787
|
+
|
788
|
+
|
789
|
+
[IETF89] Flanagan, H., "IETF 89 Proceedings: RFC Format (rfcform)",
|
790
|
+
n.d., <http://www.ietf.org/proceedings/89/rfcform.html>.
|
791
|
+
|
792
|
+
[IETF90] Flanagan, H., "IETF 90 Proceedings: RFC Format (rfcform)",
|
793
|
+
n.d., <http://www.ietf.org/proceedings/90/rfcform.html>.
|
794
|
+
|
795
|
+
[ISTATS] "Internet Live Stats", n.d.,
|
796
|
+
<http://www.internetlivestats.com/internet-users/>.
|
797
|
+
|
798
|
+
[NDN2014] "28th NORDUnet Conference 2014", 2014,
|
799
|
+
<https://events.nordu.net/display/NORDU2014/
|
800
|
+
BoF%27s+and+side+meetings>.
|
801
|
+
|
802
|
+
[RFC-INTEREST]
|
803
|
+
RFC Editor, "rfc-interest -- A list for discussion of the
|
804
|
+
RFC series and RFC Editor functions.", n.d.,
|
805
|
+
<https://www.rfc-editor.org/mailman/listinfo/
|
806
|
+
rfc-interest>.
|
807
|
+
|
808
|
+
[RFC4845] Daigle, L., Ed. and Internet Architecture Board, "Process
|
809
|
+
for Publication of IAB RFCs", RFC 4845,
|
810
|
+
DOI 10.17487/RFC4845, July 2007,
|
811
|
+
<https://www.rfc-editor.org/info/rfc4845>.
|
812
|
+
|
813
|
+
[RFC5741] Daigle, L., Ed., Kolkman, O., Ed., and IAB, "RFC Streams,
|
814
|
+
Headers, and Boilerplates", RFC 5741,
|
815
|
+
DOI 10.17487/RFC5741, December 2009,
|
816
|
+
<https://www.rfc-editor.org/info/rfc5741>.
|
817
|
+
|
818
|
+
[RFC6635] Kolkman, O., Ed., Halpern, J., Ed., and IAB, "RFC Editor
|
819
|
+
Model (Version 2)", RFC 6635, DOI 10.17487/RFC6635, June
|
820
|
+
2012, <https://www.rfc-editor.org/info/rfc6635>.
|
821
|
+
|
822
|
+
[RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322,
|
823
|
+
DOI 10.17487/RFC7322, September 2014,
|
824
|
+
<https://www.rfc-editor.org/info/rfc7322>.
|
825
|
+
|
826
|
+
[RSOC] IAB, "RFC Editor Program: The RSOC", n.d.,
|
827
|
+
<http://www.iab.org/activities/programs/
|
828
|
+
rfc-editor-program/>.
|
829
|
+
|
830
|
+
[TNC2014] Flanagan, H., "IETF Update - 'What's Hot?' - RFC Update",
|
831
|
+
n.d., <https://tnc2014.terena.org/core/presentation/84>.
|
832
|
+
|
833
|
+
[TYPOGRAPHY]
|
834
|
+
Butterick, M., "Butterick's Practical Typography", n.d.,
|
835
|
+
<http://practicaltypography.com/
|
836
|
+
widow-and-orphan-control.html>.
|
837
|
+
|
838
|
+
|
839
|
+
|
840
|
+
Flanagan Expires December 25, 2016 [Page 15]
|
841
|
+
|
842
|
+
Internet-Draft RFC Format Framework June 2016
|
843
|
+
|
844
|
+
|
845
|
+
[XML-ANNOUNCE]
|
846
|
+
"Subject: [rfc-i] Direction of the RFC Format Development
|
847
|
+
effort", n.d., <http://www.rfc-editor.org/pipermail/
|
848
|
+
rfc-interest/2013-May/005584.html>.
|
849
|
+
|
850
|
+
Author's Address
|
851
|
+
|
852
|
+
Heather Flanagan
|
853
|
+
RFC Editor
|
854
|
+
|
855
|
+
Email: rse@rfc-editor.org
|
856
|
+
URI: http://orcid.org/0000-0002-2647-2220
|
857
|
+
|
858
|
+
|
859
|
+
|
860
|
+
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
|
877
|
+
|
878
|
+
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
|
887
|
+
|
888
|
+
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
|
894
|
+
|
895
|
+
|
896
|
+
Flanagan Expires December 25, 2016 [Page 16]
|