Differences

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

--- design:start [2013/09/15 08:07]
rsewikiadmin not sure why we have two text output links
+++ design:start [2013/11/28 14:19]
rsewikiadmin [Discussion topics]
@@ Line 1: / Line 1: @@
 RFC Design Team wiki space
-==== Expected Outputs of the Design Team ====
+**Public read-only**
-   - 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's Address section (I expect this to have an impact on the tools, but I don't know what that impact will look like)
-==== Open Questions ====
+===== IETF 88 RFC Format BoF slides =====
-   - How will unintentional variations in output be dealt with?
+{{design:IETF88-Format-BoF.pdf|PDF file}}
-   - Will the Publication formats be allowed to change, allowing for modifications if the transformation from XML introduces format-specific errors?  Who would judge whether the bug was in the Canonical format rather than the Publication format?
-   - How does xml2rfc fit in to this work?  What needs to change?
-   - Given the end goals, what tools are entirely missing? (i.e., is what we have now sufficient for diffs?)
-   - Will we have one or more "preferred" publication formats?
-==== Additional Pages on this Wiki ====
+{{design:IETF88-Format-BoF.pptx|PPTX file}}
-  * [[design:formats|Thoughts on Non-Canonical Formats]]
+===== Introduction =====
-  * [[design:producing-output|How RFC Output Is Produced]]
-  * [[design:text-sample|Sample of Text Output]]
+During IETF 86, the IAB formally approved the publication of "RFC Format Requirements and Future Development" (RFC 6949).  That RFC outlines the requirements gathered from the communities of interest regarding the Canonical format for the RFC Series.  With those requirements in hand, the next step is to explore how those requirements might be implemented and verify what is possible and reasonable for the Series going forward.
+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.  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.
+==== Requirements ====
+  * [[design:utf8-requirements|Requirements for UTF-8 and Unicode]]
+  * [[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]]
+==== Discussion topics ====
+  * [[design:formats|Discussions around on Non-Canonical Formats]]
+  * [[design:xml-tags|New or modified XML syntax]]
   * [[design:tool|Ideas for the RFC tool]]
   * [[design:svg|Thoughts on SVG]]
-  * [[design:image-requirements|Requirements for Images]]
-  * [[design:text-requirements|Requirements for the Text Outputs]]
   * [[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 ====

RSE Wiki Archive

User Tools

Site Tools

Differences

Page Tools