User Tools

Site Tools


design:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Last revision Both sides next revision
design:start [2013/11/28 14:19]
rsewikiadmin [Discussion topics]
design:start [2015/10/13 08:36]
rsewikiadmin added reading list; removed discussion topics
Line 1: Line 1:
 RFC Design Team wiki space RFC Design Team wiki space
- 
-**Public read-only** 
- 
-===== IETF 88 RFC Format BoF slides ===== 
-{{design:​IETF88-Format-BoF.pdf|PDF file}} 
- 
-{{design:​IETF88-Format-BoF.pptx|PPTX file}} 
  
 ===== Introduction ===== ===== Introduction =====
Line 22: Line 15:
 By allowing for multiple Publication formats, readers can choose a format that works best for their circumstances. ​ The Text and PDF will be extremely basic and support the widest array of tools. ​ The HTML will allow more features and be readable by modern browsers. By allowing for multiple Publication formats, readers can choose a format that works best for their circumstances. ​ The Text and PDF will be extremely basic and support the widest array of tools. ​ The HTML will allow more features and be readable by modern browsers.
  
-Over the past few months, the [[design:​design-team|RFC Format Design Team]], formed ​in Berlin, has discussed the more detailed requirements for the XML Canonical format as well as the requirements of the different Publication formats and their associated character encoding. ​ The results of that discussion, including documentation on items discussed but decided against as requirements,​ are documented in the pages below.+Over the past two years, the [[design:​design-team|RFC Format Design Team]], formed ​during IETF 87, has discussed the more detailed requirements for the XML Canonical format as well as the requirements of the different Publication formats and their associated character encoding. ​ The results of that discussion, including documentation on items discussed but decided against as requirements,​ are documented in this wiki. 
 + 
 +==== Reading list ==== 
 +The RFC Format is a large project that has required several documents to capture ​the requirements found in each aspect of the work. The documents depend on each other, and are moving through the community review and publication process as a set to help keep those relationships intact. Several documents require understanding a separate document for full comprehension of the material. 
 + 
 +Below is the suggested reading order for the drafts that describe the new RFC format requirements. The design team has done a great job in pulling all fo this together, and many members of the community have reviewed these in parts and offered targeted feedback. Please take this time to review the drafts as a compendium, and then review the Statements of Work that describe the programming effort that will depend on these drafts as their requirements. 
 + 
 +1. The big picture 
 +  * Flanagan, H., "RFC Format Framework",​ Work in Progress, [[http://​datatracker.ietf.org/​doc/​draft-flanagan-rfc-framework/​|draft-flanagan-rfc-framework-04]],​ June 2015. 
 + 
 +2. The underlying vocabulary 
 +  * Hoffman, P., "The '​XML2RFC'​ version 3 Vocabulary",​ Work in Progress, [[https://​datatracker.ietf.org/​doc/​draft-hoffman-xml2rfc/​|draft-hoffman-xml2rfc-23]],​ September 2015. 
 + 
 +3. The outputs 
 +  * Hildebrand, J. and P. Hoffman, "​HyperText Markup Language Request For Comments Format",​ Work in Progress, [[https://​datatracker.ietf.org/​doc/​draft-hildebrand-html-rfc/​|draft-hildebrand-html-rfc-10]],​ August 2015. 
 +  * Flanagan, H., "​Requirements for Plain Text RFCs", Work in Progress, [[https://​datatracker.ietf.org/​doc/​draft-flanagan-plaintext/​|draft-flanagan-plaintext-08]],​ September 2015. 
 +  * Hansen, T., Masinter, L., and M. Hardy, "PDF for an RFC Series Output Document Format",​ Work in Progress, [[https://​datatracker.ietf.org/​doc/​draft-hansen-rfc-use-of-pdf/​|draft-hansen-rfc-use-of-pdf-08]],​ October 2015. 
 +  * Brownlee, N., "SVG Drawings for RFCs: SVG 1.2 RFC", Work in Progress, [[https://​datatracker.ietf.org/​doc/​draft-brownlee-svg-rfc/​|draft-brownlee-svg-rfc-12]],​ September 2015.
  
-==== Requirements ==== +4. Generalized requirements 
-  * [[design:utf8-requirements|Requirements for UTF-8 and Unicode]] +  * Flanagan, H., "The Use of Non-ASCII Characters in RFCs", Work in Progress, ​[[https://​www.ietf.org/​id/​draft-flanagan-nonascii-05.pdf|draft-flanagan-nonascii-05]], August 2015. *Please review the PDF version only!*
-  * [[design:​image-requirements|Requirements for Images]] +
-  * [[design:​anchor-requirements|Requirements for Anchors]] +
-  * [[design:​text-requirements|Requirements for Text Output]] +
-  * [[design:​html-requirements|Requirements for HTML Output]] +
-  ​[[design:​epub-requirements|Requirements for EPUB Output]] +
-  ​[[design:​pdf-requirements|Requirements for PDF Output]]+
  
 +5. Workflow and tools (note that the examples draft will not become an RFC, but is necessary for the project)
 +  * Hildebrand, J. and P. Hoffman, "RFC v3 Prep Tool Description",​ Work in Progress, [[https://​datatracker.ietf.org/​doc/​draft-hoffman-rfcv3-preptool/​|draft-hoffman-rfcv3-preptool-06]],​ September 2015.
 +  * Hoffman, P. and T. Hansen, "​Examples of the '​XML2RFC'​ Version 2 and 3 Vocabularies",​ Work in Progress, [[http://​datatracker.ietf.org/​doc/​draft-hoffman-rfcexamples/​|draft-hoffman-rfcexamples-03]],​ May 2015.
  
-==== Discussion topics ==== +6. The Statements of Work 
-  * [[design:formats|Discussions around on Non-Canonical Formats]] +  * http://​www.nostrum.com/​~rjsparks/​rfced/​
-  * [[design:​xml-tags|New or modified XML syntax]] +
-  * [[design:​tool|Ideas for the RFC tool]] +
-  * [[design:​svg|Thoughts on SVG]] +
-  * [[design:​utf-8|Thoughts on UTF-8]] +
-  * [[design:​pdf|Thoughts on PDF]]+
  
-==== Other information ==== 
-  * [[design:​existing-xml|Pre-reading - vocabulary and today'​s tools]] 
-  * [[design:​producing-output|How RFC Output Is Produced]] 
-  * [[design:​text-sample|Sample of Text Output]] 
-  * [[design:​html-notes|Notes on Existing HTML Formats]] 
-  * [[design:​front-back-matter|Proposed Content for Front and Back Matter]] 
-  * [[design:​format-errata|Non-Canonical Formats and the Errata system]] 
-  * [[design:​design-team|The RFC Format Design Team]] 
  
 ==== Format Requirements pulled from RFC 6949 ==== ==== Format Requirements pulled from RFC 6949 ====
design/start.txt · Last modified: 2019/05/07 09:31 by rsewikiadmin