PWG Namespace Policy - last updated 7 October 2004 (editor: imcdonald@sharplabs.com) DRAFT - DRAFT - DRAFT Available in the directory: ftp://ftp.pwg.org/pub/pwg/general/process/ in the file: pwg-namespace-policy-20041007.txt This PWG Namespace Policy specifies in detail the naming conventions for PWG documents established in PWG Process 2.0 and contains: (1) a normative ABNF for PWG document filenames; (2) an informative sequence of documents created by a hypothetical PWG working group 'ABC', including: (a) development of working group charter; (b) development of requirements document; (c) development of protocol document; (d) minor revision of protocol document - new minor version - with parameter, encoding, attribute, or value changes (d) technical brief about protocol performance (e) submission of FAQ about protocol (f) development of errata for protocol - errata directory (g) development of implementors guide for protocol - best practices (h) major revision of protocol document - new major version - with possibly incompatible syntax or semantic changes Not yet included in examples: (1) Registrations: (a) registration of new keyword, enum, or value; (b) registration of new operation or semantic element ------------------------------------------------------------------------ Notes: (1) A working draft revising a Candidate Standard or Standard MUST NOT include the standards number (51xy.z) in its filename. (2) The file prefix 'wp' (white paper) has been replaced by 'tb' (technical brief) and NEED NOT be approved. (3) The file prefix 'ht' (hints & tips) has been removed. (4) The file prefix 'dg' (developer's guide) has been replaced by 'bp' (best practice) and MUST be approved by a Formal Vote (because it uses SHOULD and SHOULD NOT). (5) In the ABNF below 'class' is used, with 'white paper', 'draft', and 'standards track' and 'informational' document types. ------------------------------------------------------------------------ PWG Namespace Policy ABNF (normative) ; see RFC 2234 for base ABNF types (e.g., 'digit') pwgfile = whitefile / draftfile / stdfile / infofile whitefile = whitepfx "-" 1*(lowalpha / digit / "-") "-" date "." ext draftfile = draftpfx "-" wgdoc version "-" date "." ext stdfile = stdpfx "-" wgdoc version "-" date "-" stdnum "." ext infofile = infopfx "-" wgdoc version "-" date "." ext whitepfx = "faq" / ; frequently asked questions "tb" ; technical brief (note) draftpfx = "wd" / ; working draft "lcrc" ; last call review comments stdpfx = "std" / ; Standard (w/ MUST) "cs" / ; Candidate Standard (w/ MUST) "err" ; Errata (to CS or STD) infopfx = "req" / ; Requirements (w/ SHOULD) "bp" ; Best Practice (w/ SHOULD) "ch" ; Charter (w/ scope/milestones) wgdoc = wg [doc] ; working group document wg = 2*(lowalpha) ; working group (in lowercase) doc = 2*(lowalpha) ; document (empty for protocol) version = [major minor] ; version of protocol/interface major = 1*digit ; NEED NOT be compatible minor = 1digit ; MUST be backwards compatible date = year month day ; 8-digit date year = 4digit month = 2digit day = 2digit stdnum = "51" 2digit "." 1*digit ; IEEE/ISTO PWG standard number ext = "doc" / ; MS Word document source "htm" / ; HTML document source "pdf" / ; Adobe PDF document formatted "txt" / ; UTF-8 document plaintext "xml" / ; XML document source "xsd" / ; XML schema source 1*3lowalpha ; other 1-3 character extension ------------------------------------------------------------------------ PWG Namespace Policy Example (informative) 1) ABC WG acronym is assigned - 'abc' working group 'abc@pwg.org' mailing list is created 2) ABC WG directories are created, including: - ftp://ftp.pwg.org/pub/pwg/abc - working group root directory - ftp://ftp.pwg.org/pub/pwg/abc/charter - working group charter - ftp://ftp.pwg.org/pub/pwg/abc/wd - working drafts - ftp://ftp.pwg.org/pub/pwg/abc/white - FAQs/technical briefs/hints - ftp://ftp.pwg.org/pub/pwg/abc/schemas - XML schemas - ftp://ftp.pwg.org/pub/pwg/abc/minutes - working group minutes - ftp://ftp.pwg.org/pub/pwg/abc/slides - slides and presentations 3) first draft ABC charter (technical brief) - /pub/pwg/abc/wd/tb-ch-abc10-20040304.doc/pdf 4) last draft to PWG Announce - Formal Vote (technical brief) - /pub/pwg/abc/wd/tb-ch-abc10-20040320.doc/pdf 5) "PWG ABC Workng Group Charter/1.0" (approved charter) - /pub/pwg/abc/charter/ch-abc10-20040413.doc/pdf 6) first draft ABC requirements (working draft) - /pub/pwg/abc/wd/wd-abcreq10-20040505.doc/pdf 7) last draft to PWG Announce - 'last call' (working draft) - /pub/pwg/abc/wd/wd-abcreq10-20040814.doc/pdf 8) last call review comments - with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abc10-20040912.doc/pdf 9) last draft to PWG Announce - Formal Vote (working draft) - /pub/pwg/abc/wd/wd-abcreq10-20040916.doc/pdf 10) "PWG ABC Requirments/1.0" (Candidate Standard) - /pub/pwg/informational/req-abcreq10-20041108.doc/pdf 11) first draft ABC protocol (working draft) - /pub/pwg/abc/wd/wd-abc10-20041212.doc/pdf 12) last draft to PWG Announce - 'last call' (working draft) - /pub/pwg/abc/wd/wd-abc10-20050404.doc/pdf 13) last draft to PWG Announce - Formal Vote (working draft) - /pub/pwg/abc/wd/wd-abc10-20050404.doc/pdf 14) "PWG ABC Protocol/1.0" (Candidate Standard) - /pub/pwg/candidates/cs-abc10-20050715-5109.1.doc/pdf 15) technical brief on ABC protocol performance (white paper) - /pub/pwg/abc/white/tb-abc-performance-20060113.doc/pdf 16) FAQ about ABC protocol (white paper) - /pub/pwg/abc/white/faq-abc-20060220.doc/pdf 17) first draft ABC protocol minor revision (working draft) - technical revisions - new minor version - /pub/pwg/abc/wd/wd-abc11-20060310.doc/pdf 18) last draft to PWG Announce - 'last call' (working draft) - /pub/pwg/abc/wd/wd-abc11-20060812.doc/pdf 19) last call review comments - with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abc11-20060912.doc/pdf 20) last draft to PWG Announce - Formal Vote (working draft) - /pub/pwg/abc/wd/wd-abc11-20060930.doc/pdf 21) "PWG ABC Protocol/1.1" (Candidate Standard) - /pub/pwg/candidates/cs-abc11-20061123-5109.1.doc/pdf 22) first draft ABC errata report (working draft) - /pub/pwg/abc/white/tb-err-abc11-20070128.doc/pdf 23) last draft to PWG Announce - Call For Objections (working draft) - /pub/pwg/abc/white/tb-err-abc11-20070210.doc/pdf 24) "PWG ABC Protocol/1.1 Errata" (approved errata) - /pub/pwg/errata/err-abc11-20070228-5109.1.doc/pdf 25) first draft ABC implementors guide (working draft) - /pub/pwg/abc/wd/wd-abcimp11-20070310.doc/pdf 26) last draft to PWG Announce - 'last call' (working draft) - /pub/pwg/abc/wd/wd-abcimp11-20070427.doc/pdf 27) last call review comments - with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abcimp11-20070529.doc/pdf 28) last draft to PWG Announce - Formal Vote (working draft) - /pub/pwg/abc/wd/wd-abcimp11-20070610.doc/pdf 29) "PWG ABC Protocol/1.1 Implementors Guide" (Best Practices) - /pub/pwg/informational/bp-abcimp11-20070719.doc/pdf 30) first draft ABC protocol major revision (working draft) - technical revisions - new minor version - /pub/pwg/abc/wd/wd-abc20-20080424.doc/pdf 31) last draft to PWG Announce - 'last call' (working draft) - /pub/pwg/abc/wd/wd-abc20-20080707.doc/pdf 32) last call review comments - with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abc20-20080810.doc/pdf 33) last draft to PWG Announce - Formal Vote (working draft) - /pub/pwg/abc/wd/wd-abc20-20080912.doc/pdf 34) "PWG ABC Protocol/1.1" (Candidate Standard) - /pub/pwg/candidates/cs-abc20-20081016-5109.1.doc/pdf ------------------------------------------------------------------------