design:start
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
design:start [2013/09/15 08:37] rsewikiadmin added page to discuss impact on errata system |
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 | ||
| - | ==== Expected Outputs of the Design Team ==== | + | ===== Introduction ===== |
| - | - examples of Publication outputs (they may be done manually and are designed to show what things will look like) a specification or set of specifications on what needs to be done to create the necessary tools for XML to be the canonical format that in turn creates four publication formats | + | |
| - | - documentation on what areas we have discussed and resolved internally so when I take this back out to the community, I can point to something that says "we discussed that issue, not discussing it again unless you have some new information that is relevant" | + | |
| - | - clear guidelines on how different scripts (see RFC 6365 for terminology clarification) will be allowed in specific sections of an RFC now that the UTF-8 encoding will be allowed in the Author' | + | |
| - | - an SVG profile for tags allowed/ | + | |
| - | - document the requirements for the XML format and the transformation tool(s) | + | |
| - | ==== Open Questions ==== | + | During IETF 86, the IAB formally approved the publication of "RFC Format Requirements and Future Development" |
| - | - How will unintentional variations in output be dealt with? | + | |
| - | - Will the Publication formats be allowed to change, allowing for modifications if the transformation from XML introduces format-specific errors? | + | |
| - | - How does xml2rfc fit in to this work? What needs to change? | + | |
| - | - Given the end goals, | + | |
| - | - Will we have one or more " | + | |
| - | ==== Additional Pages on this Wiki ==== | + | The direction we are exploring is one where the Canonical format - the format that is authoritative for content of an RFC - is XML using the xml2rfc DTD. From that format, four Publication formats will be rendered: Text, HTML, PDF, and EPUB. We are focusing on the xml2rfc DTD as something most likely to meet the requirements as defined in a reasonable time frame and budget because xml2rfc is: |
| + | |||
| + | * well-known by many in the authoring community as well as the RFC Editor; | ||
| + | * has a start on meeting most of the requirements already; | ||
| + | * is based on a solid mark-up language that is expected to exist for the foreseeable future. | ||
| + | |||
| + | Authors may continue to submit XML or text files when their I-Ds are approved for publication. | ||
| + | |||
| + | By allowing for multiple Publication formats, readers can choose a format that works best for their circumstances. | ||
| + | |||
| + | Over the past two years, the [[design: | ||
| + | |||
| + | ==== 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", | ||
| + | |||
| + | 2. The underlying vocabulary | ||
| + | * Hoffman, P., "The ' | ||
| + | |||
| + | 3. The outputs | ||
| + | * Hildebrand, J. and P. Hoffman, " | ||
| + | * Flanagan, H., " | ||
| + | * Hansen, T., Masinter, L., and M. Hardy, "PDF for an RFC Series Output Document Format", | ||
| + | * Brownlee, N., "SVG Drawings for RFCs: SVG 1.2 RFC", Work in Progress, [[https:// | ||
| + | |||
| + | 4. Generalized requirements | ||
| + | * Flanagan, H., "The Use of Non-ASCII Characters in RFCs", Work in Progress, [[https:// | ||
| + | |||
| + | 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", | ||
| + | * Hoffman, P. and T. Hansen, " | ||
| + | |||
| + | 6. The Statements of Work | ||
| + | * http:// | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| - | * [[design: | ||
| ==== Format Requirements pulled from RFC 6949 ==== | ==== Format Requirements pulled from RFC 6949 ==== | ||
design/start.txt · Last modified: 2019/05/07 09:31 by rsewikiadmin
Page Tools
