RSE Wiki Archive

This is an old revision of the document!

Draft-Edit, Review (what authors, ADs, and other interested parties worry about when writing and reviewing an I-D)

• Need to broader character encoding to respect author names
• Need to be able to update documents easily and see how they might look when published
• Need to be able to include graphics/images
• Need to be able to create new documents by hacking away at older ones
• Need be able to diff versions of a draft
• 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 semantically tag some document info, at least authors' names and references
• Want to be able to include equations
• Want a more flexible line length
• Want to be able to tag ownership/source of comments

RFC-Edit (additional requirements from RFC editors)

• Need source file to be editable by both authors and RFC editors
• Want a single, discrete source file for a draft (not multipel files and a make file)
• Want a publicly available “official” conversion tool (same source file producing the same output between I-D submission and RFC editing step)

RFC-Archive (what the RFC Editor worries about when publishing an RFC)

• Need format to be easily rendered in to other, potentially undefined formats (.txt, .html, other)
• Need one format to be the authoritative version, suitable for legal records
• 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't apply to docs published prior to the format change)
• Need a long-lived file format with an open specification, i.e., such that the community can continue to support it even if commercial support disappears

End consumption (what consumers of RFC worry about)

• Need to be able to see graphics/images
• 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
• Want to be able to link sections and jump ahead in the document
• Want intelligent html-style linking within references
• Want the RFC to be suitable for small screens/mobile devices
• Want to have neat printing (intelligent pagination)
• Want to be able to view equations
• Want a more flexible line length
• Want a single document to view (should not have to jump between two documents for complete information)