formatreq
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
formatreq [2012/05/30 12:24] rsewikiadmin |
formatreq [2013/05/31 09:25] (current) rsewikiadmin |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== RFC 6949 ====== | ||
| + | Note that the requirements have been gathered and published as [[http:// | ||
| + | |||
| + | ---- | ||
| + | |||
| The RFC Series has been in existence for over 40 years. | The RFC Series has been in existence for over 40 years. | ||
| Line 19: | Line 24: | ||
| - | So, the community and the RFC Editor have decided to review the canonical format of the RFC series and discuss whether it needs to change and, if change is required, what the change should look like. This wiki page attempts to capture the requirements of the community regarding format for the RFC, including suggestions that will be fed back to the IETF regarding similar changes to the Internet-Draft format. | + | So, the community and the RFC Editor have decided to review the canonical format of the RFC series and discuss whether it needs to change |
| ---- | ---- | ||
| === Fundamental requirement === | === Fundamental requirement === | ||
| - | * Any new format MUST continue the persistence and convertibility | + | * Any new format MUST continue the level of persistence found in the existing format |
| * While the canonical source format MUST be easily converted in to a variety of other formats, a single canonical display format must exist to satisfy the requirements of legal and content disputes | * While the canonical source format MUST be easily converted in to a variety of other formats, a single canonical display format must exist to satisfy the requirements of legal and content disputes | ||
| Line 31: | Line 36: | ||
| //Note that requiring change to I-D format is outside the purview of the RFC Series Editor. | //Note that requiring change to I-D format is outside the purview of the RFC Series Editor. | ||
| - | ^ Feature | + | ^ Feature |
| - | | Need broader character encoding for author names | | + | | Need broader character encoding for author names | No |
| - | | Need to be able to update documents easily and see how they might look when published | + | | Need to be able to update documents easily and see how they might look when published |
| - | | Need to be able to include graphics/ | + | | Need to be able to include |
| - | | Need to be able to create new documents by hacking away at older ones | Yes | | | + | | Need to be able to create new documents by hacking away at older ones | Yes |
| - | | Need be able to diff versions of a draft | Yes | | | + | | Need be able to diff versions of a draft |
| - | | Need format to be easily rendered in to other, potentially undefined formats (.txt, .html, other) | + | | Need format to be easily rendered in to other, potentially undefined formats (.txt, .html, other) |
| - | | Need to be able to search document and document repositories with tools such as *grep | Yes | | | + | | Need to be able to search document and document repositories with tools such as *grep |
| - | | Want broader character encoding for body of document | + | | Want broader character encoding for body of document |
| - | | Want the ability to denote protocol examples using the character sets those examples support | + | | Want the ability to denote protocol examples using the character sets those examples support |
| - | | Want the ability to semantically tag some document info, at least authors' | + | | Want the ability to semantically tag some document info, at least authors' |
| - | | Want to be able to include equations | **No** | + | | Want to be able to include equations |
| - | | Want a more flexible line length | + | | Want a more flexible line length |
| - | | Want to be able to tag ownership/ | + | | Want to be able to tag ownership/ |
| Line 51: | Line 56: | ||
| === RFC-Edit === | === RFC-Edit === | ||
| // | // | ||
| - | ^ Feature | + | ^ Feature |
| - | | Need source file to be editable by both authors and RFC editors | + | | Need source file to be editable by both authors and RFC editors |
| - | | Want a single, discrete source file for a draft (not multiple files and a make file) | Yes | | + | | Want a single, discrete source file for a draft (not multiple files and a make file) | No |
| - | | Want a publicly available " | + | | Want a publicly available " |
| Line 60: | Line 65: | ||
| === RFC-Archive === | === RFC-Archive === | ||
| //what the RFC Editor worries about when publishing an RFC// | //what the RFC Editor worries about when publishing an RFC// | ||
| - | ^ Feature | + | ^ Feature |
| - | | Need source format to be easily rendered in to other, potentially undefined formats (.txt, .html, other) | + | | Need source format to be easily rendered in to other, potentially undefined formats (.txt, .html, other) |
| - | | Need one source and display format to be the authoritative version, suitable for legal records | + | | Need one source and display format to be the authoritative version, suitable for legal records |
| - | | Need to be able to create new documents by hacking away at older ones | Yes | | | + | | Need to be able to create new documents by hacking away at older ones |
| - | | Need backward compatibility to recreate documents originally created in an older version of the output tools (backward compatibility issue doesn' | + | | Need backward compatibility to recreate documents originally created in an older version of the output tools (backward compatibility issue doesn' |
| - | | Need a long-lived file format with an open specification, | + | | Need a long-lived file format with an open specification, |
| Line 71: | Line 76: | ||
| === End consumption === | === End consumption === | ||
| ^ Feature | ^ Feature | ||
| - | | Need to be able to see non-ASCII graphics/ | + | | Need to be able to see non-ASCII graphics/ |
| - | | Need to be able to search document and document repositories with tools such as *grep | Yes | | | + | | Need to be able to search document and document repositories with tools such as *grep |
| - | | Need to be able to create new documents by hacking away at older ones | Yes | | | + | | Need to be able to create new documents by hacking away at older ones |
| - | | Want intelligent html-style linking within references | + | | Want intelligent html-style linking within references |
| - | | Want the RFC to be suitable for small screens/ | + | | Want the RFC to be suitable for small screens/ |
| - | | Want to have neat printing (intelligent pagination) | + | | Want to have neat printing (intelligent pagination) | Yes (but limited to a narrowly defined page format) | Yes | But there is disagreement as to what that would actually look like | |
| - | | Want to be able to view equations | + | | Want to be able to view equations |
| - | | Want a more flexible line length | + | | Want a more flexible line length |
| - | | Want a single document to view (should not have to jump between two documents for complete information) | + | | Want a single document to view (should not have to jump between two documents for complete information) | Yes (usually) | **No** |
formatreq.1338405888.txt.gz · Last modified: 2012/05/30 12:24 by rsewikiadmin
Page Tools
