PWG Namespace Policy - last updated 12 January 2006 (editor: imcdonald@sharplabs.com) This version available in the directory: ftp://ftp.pwg.org/pub/pwg/general/process in the file: pwg-namespace-policy-20060112.txt After approval by PWG Steering Committee, to be copied to the directory: ftp://ftp.pwg.org/pub/pwg/informational/ in the file: pwg-namespace-policy.txt This PWG Namespace Policy specifies in detail the naming conventions for PWG documents that were established in PWG Process/2.0 and contains: (1) a normative set of rules for PWG document filenames; (2) a normative ABNF for PWG document filenames; (3) an informative sequence of documents created by a hypothetical PWG working group 'ABC', including: (a) BOF for new working group; (b) development of working group charter; (c) development of requirements document; (d) development of protocol document; (e) minor revision of protocol document - new minor version; - with parameter, encoding, attribute, or value changes (f) technical brief about protocol performance; (g) submission of FAQ about protocol; (h) development of errata for protocol - errata directory; (i) development of implementors guide for protocol - best practices; (j) major revision of protocol document - new major version; - with possibly incompatible syntax or semantic changes (k) development of notifications protocol to PWG Informational; - no prototype blocks Candidate Standard status Future work to be included in examples: (1) Registrations: (a) registration of new keyword, enum, or value; (b) registration of new operation or semantic element; (2) XML Documents: (a) Legacy WSDL/1.1 and/or W3C WSDL/2.0 for new protocol; (b) XML Schema for new semantic elements; (c) DTD, RelaxNG, or Schematron schema for new semantic elements; (3) Mappings to other standards: (a) Mappings to DMTF CIM MOF and/or DMTF DMI MIF; (b) Mappings to OASIS WSDM in WS-* formats; (c) Mappings to W3C WS-Management in WS-* formats; (4) Formal Definition Languages: (a) UML; (b) ANSI Z; (c) ISO ASN.1; (d) IETF SMIv2 (for MIBs); ------------------------------------------------------------------------ PWG Namespace Policy Rules (normative) (1) A working draft revising a Candidate Standard or Standard MUST NOT include a standards number (51xy.z) in its filename. (2) A charter, standards-track (e.g., Candidate Standard), or informational (e.g., best practices) specification MUST be adopted by PWG Formal Approval before publication. (3) An errata specification MUST be adopted by PWG Call For Objections before publication. (4) A white paper (e.g., FAQ), working draft, or slides NEED NOT be approved before publication. (5) The file prefix 'tb' (technical brief) replaces the former 'wp' (white paper) to avoid visual confusion with 'wd' (working draft). (6) The file prefix 'bp' (best practices) replaces both the former 'dg' (developer's guide) and 'ht' (hints & tips). ------------------------------------------------------------------------ PWG Namespace Policy ABNF (normative) ; see RFC 2234 for base ABNF types (e.g., 'digit') pwg = white / draft / charter / info / std / errata / slides white = whitepfx "-" 1*(lowalpha / digit / "-") "-" date "." ext draft = draftpfx "-" wgdoc [version] "-" [infix] date "." ext charter = charterpfx "-" wg "-" "charter" "-" date "." ext info = infopfx "-" wgdoc version "-" date "." ext std = stdpfx "-" wgdoc version "-" date "-" stdnum "." ext errata = erratapfx "-" wgdoc version "-" date "-" stdnum "." ext slides = 1*(lowalpha / digit / "-") "-" date "." ext ; ; White Paper - 'pub/pwg/[wg]/white' - no approval required ; - 'pub/pwg/BOFs/[bof]' - no approval required ; whitepfx = "faq" / ; frequently asked questions "tb" ; technical brief (or note) ; ; Working Draft - 'pub/pwg/[wg]/wd' - no approval required ; draftpfx = "wd" / ; working draft "lcrc" ; last call review comments ; ; Charter - 'pub/pwg/[wg]/charter' - Formal Approval ; charterpfx = "ch" ; Charter (w/ scope/milestones) ; ; Informational - 'pub/pwg/informational' - Formal Approval ; infopfx = "req" / ; Requirements (w/ MUST/SHOULD) "bp" / ; Best Practice (w/ MUST/SHOULD) "info" ; Informational (w/ MUST/SHOULD) ; ; Standards Track - 'pub/pwg/[standards|candidates]' - Formal Approval ; stdpfx = "std" / ; Standard (w/ MUST/SHOULD) "cs" ; Candidate Standard ; (w/ MUST/SHOULD) ; ; Errata - 'pub/pwg/errata' - Call For Objections ; erratapfx = "err" ; Errata (to CS or STD) 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 ; (empty for WG charter) major = 1*digit ; NEED NOT be compatible minor = 1digit ; MUST be backwards compatible infix = "charter-" / ; Charter (w/ scope/milestones) "err-" ; Errata (to CS or STD) 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 (source) "gif" / ; GIF (image) "htm" / ; HTML (source) "html" / ; HTML (source) "jpg" / ; JPEG (image) "jpeg" / ; JPEG (image) "mib" / ; SNMP MIB (source) "pdf" / ; Adobe PDF (formatted) "ppt" / ; MS Powerpoint (slides) "txt" / ; UTF-8 Plaintext (source) "wsd" / ; WSDL Definitions (source) "wsdl" / ; WSDL Definitions (source) "xml" / ; XML Document (instance) "xsd" / ; XML Schema (source) 1*4lowalpha ; other 1-4 character extension ------------------------------------------------------------------------ PWG Namespace Policy Example (informative) 0) BOF on topic ABC is held at a PWG face-to-face - ftp://ftp.pwg.org/pub/pwg/BOFs/abc/tb-abc-paper-20040119.doc/pdf 1) Acronym is assigned to new ABC working group - '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/white papers - ftp://ftp.pwg.org/pub/pwg/abc/schemas - XML schemas, WSDL, etc. - 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 of ABC charter (working draft) - /pub/pwg/abc/wd/wd-abc-charter-20040304.doc/pdf 4) last draft to PWG Announce for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abc-charter-20040320.doc/pdf 5) "PWG ABC Working Group Charter/1.0" (approved charter) - /pub/pwg/abc/charter/ch-abc-charter-20040413.doc/pdf 6) first draft of ABC requirements (working draft) - /pub/pwg/abc/wd/wd-abcreq10-20040505.doc/pdf 7) last draft to PWG Announce for '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 for Formal Approval (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 for 'last call' (working draft) - /pub/pwg/abc/wd/wd-abc10-20050404.doc/pdf 13) last draft to PWG Announce for Formal Approval (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 of ABC protocol minor revision (working draft) - backward-compatible revisions - new minor version - /pub/pwg/abc/wd/wd-abc11-20060310.doc/pdf 18) last draft to PWG Announce for '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 for Formal Approval (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/wd/wd-abc11-err-20070128.doc/pdf 23) last draft to PWG Announce for Call For Objections (working draft) - /pub/pwg/abc/wd/wd-abc11-err-20070210.doc/pdf 24) "PWG ABC Protocol/1.1 Errata" (approved errata) - /pub/pwg/errata/err-abc11-err-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 for '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 for Formal Approval (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) - non-backward-compatible revisions - new major version - /pub/pwg/abc/wd/wd-abc20-20080424.doc/pdf 31) last draft to PWG Announce for '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 for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abc20-20080912.doc/pdf 34) "PWG ABC Protocol/2.0" (Candidate Standard) - /pub/pwg/candidates/cs-abc20-20081016-5109.1.doc/pdf 35) first draft ABC Notifications protocol (working draft) - non-backward-compatible revisions - new major version - /pub/pwg/abc/wd/wd-abcnotify-20090220.doc/pdf 36) last draft to PWG Announce for 'last call' (working draft) - /pub/pwg/abc/wd/wd-abcnotify-20090513.doc/pdf 37) last call review comments - with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abcnotify10-20090622.doc/pdf 38) last draft to PWG Announce for Formal Approval as Informational (no prototype blocks Candidate Standard status per PWG Process/2.0) - /pub/pwg/abc/wd/wd-abcnotify-20090715.doc/pdf 39) "PWG ABC Notifications/1.0" (Informational) - /pub/pwg/informational/info-abcnotify10-20090812.doc/pdf ------------------------------------------------------------------------