This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
design:text-requirements [2013/09/26 07:44] rsewikiadmin |
design:text-requirements [2013/10/09 13:57] paul Added Paul comments |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ==== Requirements for Text Output ==== | + | ==== Requirements for Text Output ==== |
- | Policy requirements: | + | The following assumes that there is going to be only one text-only non-canonical format, that its intended consumer |
- | * an RFC may include ASCII art OR SVG, but not both | + | |
- | * Paul asks: Why? The term "ASCII art" | + | |
- | * HF: Taking this back to the list for discussion. | + | |
- | * the .txt publication output | + | |
- | * we could potentially include direct links to the HTML anchors, but Heather is concerned about future failure | + | |
- | * Paul says he is not at all concerned as long as the URLs are structured to be long-lived. He thinks that having direct links makes much more sense for someone who is going to process the text format using tools. | + | |
- | * HF: Taking this back to the list for discussion | + | |
- | * non-ASCII characters in the Author' | + | |
- | * Wasn't this supposed to be "with exceptions allowed by the RSE"? | + | |
- | * HF: What I've been telling the community is that we would start small, with just author names, | + | |
- | Technical requirements: | + | The text-only format must have the same page height limitations as the current RFC format. It must contain the same headers and footers and page break character as the current RFC format. There is no requirement that the text-only format use widow and orphan control; the use case for this is to allow similar referencing of paragraphs from the text-only format to the canonical format and non-canonical HTML format. |
- | The paginated .txt publication | + | The text-only |
- | * maintain a similar look and feel to existing text output. | + | |
+ | The text-only format must represent all SVG-based artwork as a "see reference" | ||
- | ----- | + | === ASCII vs. UTF-8 for Text Output === |
- | For reference: | + | |
- | Current requirements re: page breaking | + | |
- | #172: page-breaking enhancements | + | As of 2013-10-09, it is not clear whether or not the text output will be ASCII or UTF-8. The following assumes ASCII. If the format |
- | Improve the PI autobreaks=" | + | |
- | - the middle | + | |
- | | + | |
- | | + | |
- | | + | |
- | doesn' | + | |
- | Ticket URL: <http://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/ | + | The text-only format must have the same character-set limitations as the current RFC format. For new RFCs that have non-ASCII characters in them, each such character must be represented as //[*U+xxxx*]//, |
+ | //Dave thinks: disagree with the above paragraph. I'm leaning towards saying there should be a separate UTF-8 (e.g. .utf8) text version. | ||
- | Current internal guidance to the RPC: | + | //Paul thinks: if there are two versions, |
- | + | ||
- | "3+ lines held together" | + | |
- | Keep a section title with the first 3 lines of the section. | + | |
- | Keep a figure on one page. This includes its title (if any). | + | |
- | - if figure does not fit on one page, break between discrete items in the figure. | + | |
- | Keep a table on one page. This includes its title (if any). | + | |
- | - if table does not fit on one page, break between rows. | + | |
- | Keep a term with its definition. | + | |
- | - if definition is long (over 5 lines), keep at least the first 3 lines of the definition with the term. | + | |
- | Keep a given reference on one page. | + | |
- | Start Appendix A on a new page. | + | |
- | + | ||
- | More subjective: | + | |
- | Keep intro text with what it's introducing. | + | |
- | Break pseudocode nicely. | + | |