RSE Wiki Archive

Policy requirements:

• an RFC may include ASCII art OR SVG, but not both
  • Paul asks: Why? The term “ASCII art” is under-specified. The IETF community does not agree what is and is not “ASCII art”. For instance, in RFC 5996, Figure 1 is clearly “art”. However, the exchanges starting on page 10 might be considered art or not. If this RFC were in the new format and the authors wanted to make Figure 1 in SVG, why should they be forced to make the exchanges into SVG? And what about the text figures on page 48? I propose that this requirement be dropped.
• the .txt publication output will include links to the info pages where there are images
  • we could potentially include direct links to the HTML anchors, but am concerned about future failure of links; info page links are likely to be more stable
• non-ASCII characters in the Author's Address section only (for now - this will expand in the future)

Technical requirements: The .txt publication format must

• use classic/branded headers on the first page
• have paginated output
• use classic/branded footers on each page
• support UTF-8 encoding
• max of 80 character width for images

Current requirements re: page breaking for xml2rfc v2

#172: page-breaking enhancements
Improve the PI autobreaks="yes". Currently, it seems to be "yes" by default but has no effect. It should prevent a page break from appearing in
- the middle of a figure (see Figure 1 in the attached file)
- in the middle of a reference (see Section 10.2 in the attached file)
- between a section title and the first sentence (see Section 5 in the attached file). This is the same as #72, which is marked fixed, but doesn't seem to be for this case.
If there is an Appendix A, insert a page break before it. (This could be tied to rfcedstyle="yes", as it's RFC Editor style.) Or, improve the ability to insert a page break -- vspace blankLines="100"

doesn't always work.

Ticket URL: <http://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/172>]

Current internal guidance to the RPC:

"3+ lines held together"  i.e., at the bottom of a page, there is not a single line or 2 lines (unless they are their own paragraph).
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. (Example: text that introduces a list, an equation, or a piece of pseudocode)
Break pseudocode nicely.