PWG Namespace Policy - 20 August 2016 Editor: blueroofmusic@gmail.com Status: Initial Draft Abstract This policy document clarifies conventions for file and directory names and HTTP and FTP file system structure as described in the PWG Standards Development Process 3.0 and any later version, by defining formal naming and structuring rules for all directories and files on the PWG Server. This version is available in the directory: http://ftp.pwg.org/pub/pwg/general/process in the file: pwg-namespace-policy-20160820.txt Note: After approval by PWG Steering Committee, available in directory: http://ftp.pwg.org/pub/pwg/general/process in the file: pwg-namespace-policy.txt ------------------------------------------------------------------------ PWG Namespace Policy (Normative) Section 3 of the PWG Standards Development Process 3.0 defines working group phases (Charter, Development, Maintenance) and activities and the types of PWG internal documents and PWG standards documents. Section 4 defines lifecycles, editorial rules, status levels, and naming of PWG documents. Section 5 defines PWG informal and internal documents. Section 7 describes PWG document publication directories (with examples of FTP URI for PWG documents). Section 7 states that the current best practice on PWG document names is defined in this PWG namespace policy. This PWG Namespace Policy specifies the normative naming conventions for PWG documents: (1) a normative set of rules for PWG document simple filenames; (2) a normative ABNF for PWG document simple filenames; (3) a normative set of rules for PWG directory path names; (4) a normative ABNF for PWG directory pathnames; (5) an informative sequence of documents created by a hypothetical PWG workgroup 'ABC', including: (a) BOF whitepaper for proposed new workgroup; (b) directories created for proposed new workgroup; (c) development of new workgroup charter; (d) development of standards-track document; - PWG Candidate Standard (e) development of FAQ document; - PWG Informational (f) development of errata revision of standards-track document; - with parameter, encoding, attribute, or value changes (g) WG whitepapers for new work items; (h) development of updated workgroup charter for new work items; (i) development of normative implementors guide; - PWG Candidate Standard (j) WG whitepaper for new major version of standards-track document; (k) development of new major version of standards-track document; - with possibly incompatible syntax or semantic changes ------------------------------------------------------------------------ PWG Namespace Policy Future Work (informative) Future work to be possibly 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 standard number (e.g., '51xy.z') in its filename. (2) A charter or standards-track (e.g., Candidate Standard) document MUST be adopted by PWG Formal Approval before publication. (3) An errata minor revision MUST be adopted by PWG Call For Objections before publication. (4) A whitepaper, FAQ draft, slides, working draft, etc. MAY be published without any prior approval from PWG or WG officers. (5) An informational document (e.g., final FAQ) MUST be approved by PWG Steering Committee and relevant workgroup before publication and MAY require Call for Objections or Formal Approval per PWG SC. (6) The prefix 'white' (whitepaper) is used for consistency. (7) The prefix 'tb' (technical brief) is obsoleted by 'white' (white paper), for consistency of names. (8) The prefix 'err' (errata) is reserved for ONLY updates to PWG Process, PWG Intellectual Property Policy, etc. and MUST not be used to publish any workgroup products. ------------------------------------------------------------------------ PWG Namespace Policy ABNF (normative) ; see RFC 5234 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 ; ; whitepaper - 'pub/pwg/[wg]/white' - no approval required ; - 'pub/pwg/BOFs/[bof]' - no approval required ; whitepfx = "faq" / ; frequently asked questions "white" / ; whitepaper "tb" ; OBSOLETE - do not use ; ; 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 required ; charterpfx = "ch" ; charter (w/ scope and work items) ; ; Informational - 'pub/pwg/informational' - Formal Approval required ; infopfx = "req" / ; Requirements (w/ SHOULD/MAY) "bp" / ; Best Practice (w/ SHOULD/MAY) "info" ; Informational (w/ SHOULD/MAY) ; ; Standards Track - 'pub/pwg/standards' - Formal Approval required ; 'pub/pwg/candidates' - Formal Approval required ; stdpfx = "std" / ; Standard (w/ MUST/SHOULD) "cs" ; Candidate Standard ; (w/ MUST/SHOULD) ; ; Errata - 'pub/pwg/errata' - Call For Objections required ; erratapfx = "err" ; Errata - ONLY use for Process wgdoc = wg [doc] ; workgroup document wg = 2*(lowalpha) ; workgroup (in lowercase) doc = 2*(lowalpha) ; document (in lowercase) version = [major minor] ; version of protocol/interface ; (empty for WG charter) major = 1*digit ; MAY NOT be backwards compatible minor = 1digit ; MUST be backwards compatible infix = "charter-" / ; Charter (w/ scope/milestones) "errata-" ; Errata - ONLY use for Process 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 Classic (source) "docx" / ; MS Word XML (source) "gif" / ; GIF (image) "htm" / ; HTML (source) "html" / ; HTML (source) "jpg" / ; JPEG (image) "jpeg" / ; JPEG (image) "mib" / ; SNMP MIB (source) "pdf" / ; Adobe PDF (formatted) "png" / ; PNG (image) "ppt" / ; MS PowerPoint Classic (slides) "pptx" / ; MS PowerPoint XML (slides) "txt" / ; UTF-8 Plaintext (source) "wsd" / ; WSDL Definitions (source) "wsdl" / ; WSDL Definitions (source) "xls" / ; MS Excel Classic (spreadsheet) "xlsx" / ; MS Excel XML (spreadsheet) "xml" / ; XML Document (instance) "xsd" / ; XML Schema (source) 1*4lowalpha ; other 1-4 character extension ------------------------------------------------------------------------ PWG Namespace Policy Examples (informative) 0) BOF (Birds of a Feather) on topic ABC is held at a PWG face-to-face - http://ftp.pwg.org/pub/pwg/BOFs/abc/white-abc-20040119.doc/pdf 1) Proposed ABC workgroup assigned new acronym by PWG SC - 'abc' workgroup 'abc@pwg.org' mailing list is created 2) Proposed ABC WG directories are created, including: - http://ftp.pwg.org/pub/pwg/abc - workgroup root directory - http://ftp.pwg.org/pub/pwg/abc/charter - workgroup approved charters - http://ftp.pwg.org/pub/pwg/abc/wd - workgroup working drafts - http://ftp.pwg.org/pub/pwg/abc/white - workgroup informal documents - http://ftp.pwg.org/pub/pwg/abc/schemas - XML schemas, WSDL, etc. - http://ftp.pwg.org/pub/pwg/abc/minutes - workgroup minutes - http://ftp.pwg.org/pub/pwg/abc/slides - workgroup presentations 3) Initial draft of ABC WG charter (working draft) - /pub/pwg/abc/wd/wd-abc-charter-20040304.doc/pdf 4) Stable draft to PWG Announce for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abc-charter-20040320.doc/pdf 5) "PWG ABC Workgroup Charter" (approved charter) - /pub/pwg/abc/charter/ch-abc-charter-20040413.doc/pdf 6) Initial draft of ABC protocol (working draft) - /pub/pwg/abc/wd/wd-abc10-20041212.doc/pdf 7) Prototype draft of ABC protocol (working draft) - /pub/pwg/abc/wd/wd-abc10-20050204.doc/pdf - one or more PWG participants prototype and report results 8) Stable draft of ABC protocol for WG Last Call (working draft) - /pub/pwg/abc/wd/wd-abc10-20050306.doc/pdf 9) Stable draft to PWG Announce for PWG Last Call (working draft) - /pub/pwg/abc/wd/wd-abc10-20050404.doc/pdf 10) Last Call Review Comments with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abc10-20050503.doc/pdf 11) Stable draft to PWG Announce for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abc10-20050522.doc/pdf 12) Publication of "PWG ABC Protocol/1.0" (Candidate Standard) - /pub/pwg/candidates/cs-abc10-20050715-5199.1.doc/pdf 13) Initial draft of FAQ about ABC protocol (whitepaper) - /pub/pwg/abc/white/faq-abc-20060220.doc/pdf 14) Stable draft of FAQ about ABC protocol (whitepaper) - /pub/pwg/abc/white/faq-abc-20060310.doc/pdf 15) Publication of PWG SC and ABC WG approved FAQ about ABC protocol - /pub/pwg/informational/faq-abc-20060310.doc/pdf 16) Initial draft of ABC protocol errata revision (working draft) - backward-compatible revisions - new minor version - /pub/pwg/abc/wd/wd-abc11-20060310.doc/pdf 17) Stable draft to PWG Announce for PWG Last Call (working draft) - /pub/pwg/abc/wd/wd-abc11-20060812.doc/pdf 18) Last Call Review Comments with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abc11-20060912.doc/pdf 19) Stable draft to PWG Announce for Call for Objections or Formal Approval - /pub/pwg/abc/wd/wd-abc11-20060930.doc/pdf 20) "PWG ABC Protocol/1.1" (Candidate Standard) - /pub/pwg/candidates/cs-abc11-20061123-5109.1.doc/pdf 21) Initial draft of whitepaper for ABC PIN feature - /pub/pwg/abc/white/white-abcpin10-20061203.doc/pdf 22) Interim draft of whitepaper for ABC PIN feature - /pub/pwg/abc/white/white-abcpin10-20061222.doc/pdf 23) Initial draft of whitepaper for ABC Implementors Guide - /pub/pwg/abc/white/white-abcig10-20070110.doc/pdf 24) Interim draft of whitepaper for ABC Implementors Guide - /pub/pwg/abc/white/white-abcig10-20070125.doc/pdf 25) Initial draft of updated ABC charter for new work items - /pub/pwg/abc/wd/wd-abc-charter-200700128.doc/pdf 26) Stable draft to PWG Announce for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abc-charter-20070214.doc/pdf 27) "PWG ABC Workgroup Charter" (approved updated charter) - /pub/pwg/abc/charter/ch-abc-charter-20070310.doc/pdf 28) Interim draft of ABC Implementors Guide (working draft) - /pub/pwg/abc/wd/wd-abcig10-20070320.doc/pdf 29) Stable draft to PWG Announce for PWG Last Call (working draft) - /pub/pwg/abc/wd/wd-abcig10-20070427.doc/pdf 30) Last Call Review Comments with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abcig10-20070529.doc/pdf 31) Stable draft to PWG Announce for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abcig10-20070610.doc/pdf 32) Publication of "PWG ABC Protocol Implementors Guide/1.0" - /pub/pwg/candidates/cs-abcig10-20070719.doc/pdf 33) Initial draft of whitepaper for ABC protocol major revision - non-backward-compatible revisions - new major version - /pub/pwg/abc/white/white-abc20-20080424.doc/pdf 34) Interim draft of whitepaper for ABC protocol major revision - non-backward-compatible revisions - new major version - /pub/pwg/abc/white/white-abc20-20080601.doc/pdf 35) Revise ABC WG charter for new work item - see steps above 36) Interim draft of ABC protocol major revision (working draft) - /pub/pwg/abc/wd/wd-abc20-20080707.doc/pdf 37) Prototype draft of ABC protocol major revision (working draft) - /pub/pwg/abc/wd/wd-abc20-20080812.doc/pdf - one or more PWG participants prototype and report results 37) Stable draft to PWG Announce for PWG Last Call (working draft) - /pub/pwg/abc/wd/wd-abc20-20080925.doc/pdf 38) Last Call Review Comments with embedded issues and resolutions - /pub/pwg/abc/wd/lcrc-abc20-20081010.doc/pdf 39) Stable draft to PWG Announce for Formal Approval (working draft) - /pub/pwg/abc/wd/wd-abc20-20081108.doc/pdf 40) Publication of "PWG ABC Protocol/2.0" (Candidate Standard) - /pub/pwg/candidates/cs-abc20-20081218-5109.1.doc/pdf ------------------------------------------------------------------------