User Tools

Site Tools


rfc_metadata_in_the_v3_era

Differences

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

Link to this comparison view

Next revision
Previous revision
rfc_metadata_in_the_v3_era [2019/09/11 15:42]
127.0.0.1 external edit
rfc_metadata_in_the_v3_era [2023/02/14 09:52] (current)
jmahoney this wiki doesn't support tags
Line 1: Line 1:
-=====Notes on RFC metadata in the v3 era=====+ 
 +===== Notes on RFC metadata in the v3 era =====
  
   * New XSD is in place (10 Sept 2019): https://www.rfc-editor.org/in-notes/rfc-index.xsd   * New XSD is in place (10 Sept 2019): https://www.rfc-editor.org/in-notes/rfc-index.xsd
Line 11: Line 12:
     * 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 ====
   * One JSON file per RFC was made available 11 September 2019.   * One JSON file per RFC was made available 11 September 2019.
   * Each file contains data similar to an entry in rfc-index.xml.   * Each file contains data similar to an entry in rfc-index.xml.
   * Sample file: https://www.rfc-editor.org/rfc/rfc5234.json   * Sample file: https://www.rfc-editor.org/rfc/rfc5234.json
  
-=== Examples ===+==== Examples ====
  
 Example: RFC4254 Example: RFC4254
Line 51: Line 52:
 "format":["ASCII","HTML"],"page_count":"24" "format":["ASCII","HTML"],"page_count":"24"
 </code> </code>
----------------+ 
 + 
 +---- 
  
 Example: RFC8888 (v3 era) Example: RFC8888 (v3 era)
rfc_metadata_in_the_v3_era.1568241724.txt.gz · Last modified: 2019/09/11 15:42 by 127.0.0.1