RSE Wiki Archive

User Tools

Site Tools

Trace:
rfc_metadata_in_the_v3_era

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
rfc_metadata_in_the_v3_era [2019/09/10 17:00]
arusso 		rfc_metadata_in_the_v3_era [2019/09/10 17:10]
arusso
Line 6: Line 6:
     * removed file sizes. (Byte count is no longer included as metadata for each RFC.)     * removed file sizes. (Byte count is no longer included as metadata for each RFC.)
   * There is only one page count per RFC, even if it is available in multiple file formats.    * There is only one page count per RFC, even if it is available in multiple file formats. 
-    * For pre-v3 docs, it is the page count of the .txt file.+    * As a result, in rfc-index.xml, page-count has been "pulled up" a level. 
 +  * For page count, source of data will change. 
 +    * For pre-v3 docs, it is the page count of the .txt file (except for a handful of old RFCs where there is no .txt file).
     * For v3 docs, it will be the page count of the PDF file.     * For v3 docs, it will be the page count of the PDF file.
  
-== PDF naming conventions ==+=== PDF naming conventions ===
   * Externally, PDFs are listed simply as "PDF" (whether v3 or otherwise).   * Externally, PDFs are listed simply as "PDF" (whether v3 or otherwise).
   * Internally, the db holds "v3PDF" to mean v3 output; "PDF" is used for pre-v3.   * Internally, the db holds "v3PDF" to mean v3 output; "PDF" is used for pre-v3.
   * As before, .txt.pdf files are not listed in index files.   * As before, .txt.pdf files are not listed in index files.
  
-== TEXT naming conventions ==+=== TEXT naming conventions ===
   * Externally, .txt format (whether pre-v3 or not) is listed as "TEXT".\\ Exception: rfc-index.xml: will display "ASCII" (for pre-v3) and "TEXT" (afterwards). Rationale: other index files were already using the "TEXT" instead of "ASCII", so they weren't changed to start differentiating.   * Externally, .txt format (whether pre-v3 or not) is listed as "TEXT".\\ Exception: rfc-index.xml: will display "ASCII" (for pre-v3) and "TEXT" (afterwards). Rationale: other index files were already using the "TEXT" instead of "ASCII", so they weren't changed to start differentiating.
   * Internally, the db holds "TEXT" to mean v3 output; "ASCII" is used for pre-v3.   * Internally, the db holds "TEXT" to mean v3 output; "ASCII" is used for pre-v3.
  
-== New resource: JSON files of RFC metadata == +=== New resource: JSON files of RFC metadata === 
-  * RFC-specific JSON files will be made available this week.+  * RFC-specific JSON files will be made available the week of Sept 10.
   * Each file will contain data similar to an entry in rfc-index.xml.   * Each file will contain data similar to an entry in rfc-index.xml.
   * Sample files - see mail 24 June 2019 (RFC metadata in the datatracker & sample JSON files for rfc-editor.org).   * Sample files - see mail 24 June 2019 (RFC metadata in the datatracker & sample JSON files for rfc-editor.org).
 +
 +=== Examples ===
  
 Example: RFC4254 Example: RFC4254
Line 38: Line 42:
  
     <format>     <format>
-        <file-format>TEXT</file-format>+        <file-format>ASCII</file-format>
         <file-format>HTML</file-format>         <file-format>HTML</file-format>
     </format>     </format>
rfc_metadata_in_the_v3_era.txt · Last modified: 2019/09/11 15:42 by arusso

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki