User Tools

Site Tools


formatsummary

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
formatsummary [2012/07/19 11:13]
rsewikiadmin
formatsummary [2012/07/28 08:33]
rsewikiadmin
Line 5: Line 5:
  
 This is a summation of the more polarizing issues related to RFC format. ​ Many participants in the discussion have dropped off in reaction to the sheer quantity of discussion around these and the other topics. ​ To bring everyone back up to speed, this list the more contentious topics.  ​ This is a summation of the more polarizing issues related to RFC format. ​ Many participants in the discussion have dropped off in reaction to the sheer quantity of discussion around these and the other topics. ​ To bring everyone back up to speed, this list the more contentious topics.  ​
 +
 +====== Definitions ======
 +Source format, aka Submission format, Input format = the format used by authors, etc., when writing an I-D. Currently: XML (can be uploaded to the I-D submission tool currently), NROFF, .doc, .txt
 +  * may or may not be the same as any other format (though it would make the workflow somewhat simpler for the RFC Editor if it were); ​
 +  * will be converted to another format for further processing and publication if necessary
 +
 +Canonical format = the authorized, recognized, accepted, official version of the document
 +  * other document types may be derived from this format; may or may not be one of the possible output formats
 +
 +Archival format = currently the printed, paper copy AND the digital .txt of the RFC
 +  * currently the same as the canonical format
 +
 +Output format, Display format = format as it may be read or printed after publication process has completed; currently ASCII, PDF, and HTML are common output or display formats
 +  * For I-D: TXT*, PDF*, PS*, HTML.
 +  * For RFC: TXT, .TXT.PDF, Enhanced PDF (rare)
 +  * Outside RFC Editor: HTML (via rfcmarkup), HTML (via datatracker),​ PDF, perhaps others.
 +
 ====== Physical format ====== ====== Physical format ======
 Pagination Pagination
Line 18: Line 35:
  
 Character encoding - UTF-8 Character encoding - UTF-8
-  * For8: Allows authors to spell their names correctly; certain special characters in equations or quoted from other texts allowed; citations of web pages using more international characters possible; in discussions of internationalization,​ actually being able to +  * For: Allows authors to spell their names correctly; certain special characters in equations or quoted from other texts allowed; citations of web pages using more international characters possible; in discussions of internationalization,​ actually being able to illustrate the issue is rather helpful, and you can't illustrate a Unicode code point with "​U+nnnn"​.
-illustrate the issue is rather helpful, and you can't illustrate a Unicode code point with "​U+nnnn"​.+
   * Against: Exactly what characters are allowed and where the line should be drawn remains unclear (why some characters commonly used in European languages and not other, non-Latin characters? This is just pushing the problem around.)   * Against: Exactly what characters are allowed and where the line should be drawn remains unclear (why some characters commonly used in European languages and not other, non-Latin characters? This is just pushing the problem around.)
-  * Additional thoughts: just moving from ASCII to UTF-8 (as opposed to UTF-8 and HTML or XML) leaves us with dependencies on the local file systems and processors to be configured properly and do the right thing with the document, where as browsers will recognize UTF-8 and can declare the encoding definitively+  * Additional thoughts: just moving from ASCII to UTF-8 (as opposed to UTF-8 and HTML or XML) leaves us with dependencies on the local file systems and processors to be configured properly and do the right thing with the document ​though adding a byte-order mark (BOM) to the beginning of each non-HTML UTF-8 text file will go a long way towards recognition; ​browsers will recognize UTF-8 and can declare the encoding definitively
  
  
Line 28: Line 44:
   * Against: Not enough people use mobile devices, and those that can can generally scroll, so this should be treated as an edge case at best   * Against: Not enough people use mobile devices, and those that can can generally scroll, so this should be treated as an edge case at best
   * Additional thoughts: interesting numbers regarding mobile device web browsing: http://​mobithinking.com/​mobile-marketing-tools/​latest-mobile-stats/​b#​mobilepageviews and http://​mobithinking.com/​mobile-marketing-tools/​latest-mobile-stats/​b#​mobile-only   * Additional thoughts: interesting numbers regarding mobile device web browsing: http://​mobithinking.com/​mobile-marketing-tools/​latest-mobile-stats/​b#​mobilepageviews and http://​mobithinking.com/​mobile-marketing-tools/​latest-mobile-stats/​b#​mobile-only
- 
- 
-ASCII art 
-  * For: Dependence on advanced diagrams (or any diagrams) causes accessibility issues 
-  * Against: It does not allow for reflow ​ 
-  * Additional thoughts: If we go beyond ASCII art, need to pick just one format: GIF? PNG? SVG? 
- 
- 
  
  
Line 47: Line 55:
  
 ASCII art ASCII art
-  * For: It forces people to rely more on words and clear written descriptions than the diagrams; each diagram is relatively simple and discrete +  * For: Dependence on advanced diagrams (or any diagrams) causes accessibility issues; ​forces people to rely more on words and clear written descriptions than the diagrams; each diagram is [relativelysimple and discrete 
-  * Against: ​The often poor, limited ​diagrams are a hindrance to visual thinkers +  * Against: ​It does not allow for reflow; the limitations to the diagrams are a hindrance to visual thinkers 
-  * Additional thoughts: If we go beyond ASCII art and have the normative diagrams be entirely separate documents, we may not need to limit ourselves to one graphic format (but doing so may make things simpler)+  * Additional thoughts: If we go beyond ASCII art and have the normative diagrams be entirely separate documents, we may not need to limit ourselves to one graphic format (but doing so may make things simpler).  Also, if we go beyond ASCII art, wneed to pick just one format: GIF? PNG? SVG? 
 + 
 + 
 +Graphic art / Advanced diagrams 
 +  * For: makes it easy to include complex equations; some people consider graphic art easier to understand/​read 
 +  * Against: may take pressure away from authors to focus on clear language 
 +  * Additional thoughts: if an ASCII format continues to be used, graphic art may be used and referenced as a separate document; it can be internal to a document in either the XML or HTML proposed formats
  
  
Line 60: Line 74:
   * For: Ability to semantically tag some document info, at least authors'​ names and references is useful   * For: Ability to semantically tag some document info, at least authors'​ names and references is useful
   * Against: Metadata is unnecessary overhead   * Against: Metadata is unnecessary overhead
-  * Additional thoughts: there is no list of tags that will be required for XML or HTML that would build-in required simplification and support for the archival nature of the series (that people can work longer with a simplified set of tags), and until we have that, we cannot talk about tags+  * Additional thoughts: there is no complete ​list of tags that will be required for XML or HTML that would build-in required simplification and support for the archival nature of the series (that people can work longer with a simplified set of tags), and until we have that, we cannot talk about tags (note that a list has been started in the XML format I-D)
  
  
formatsummary.txt · Last modified: 2019/09/18 13:02 by rsewikiadmin