enkore/X1000.md

## X1000.md

      
    Raw
  

              X1000.md
            
          
    Specification Formatting Conventions

Misc - Workgroup: 0x10c Standards Committee
Authors

James Rhodes - jrhodes@redpointsoftware.com.au

This draft provides guidelines on formatting draft specifications
for submission to the 0x10c standards committee.  It is designed
to loosely correlate with the formatting of RFCs.
Introduction

Currently there are no standards defined for the formatting
of standards to the committee.  This RFC proposes using the
standards already in place in RFCs globally.
Requirements Language

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in
Numbering RFCs

The numbering prefix of RFCs submitted to the 0x10c
standards committee begins at X1000, as these
RFCs are independent of the globally recognised list of RFCs.
Hence this document forms RFC X1000.
RFCs do not have a number assigned to them when they are
initially submitted as drafts.  Only once an RFC is voted to
be standard by the committee is it assigned the number, whichever
the next freely available number is in the numbering sequence.
Referencing RFCs

This is an example of how you would change the DOCTYPE if
you wanted to reference RFC X1000 in your own XRFC.
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY rfcx1000 SYSTEM
"https://raw.github.com/hach-que/0x10c-Standards/master/MISC/X1000_Spec_Formatting_Conventions.xml">
]>
Then in the references section, do:
&rfcx1000;
Formatting

Authors of RFCs for submission to the 0x10c standards
committee are RECOMMENDED to use xml2ref as specified in
When authors want to submit their RFC they MUST include
both the original source file if applicable (such as the
.xml file if using xml2rfc) and a resulting plain text
document that MUST formatted according to RFC conventions.
The website
Author Notation

Authors of RFCs MUST include their email address as part
of their author status in an RFC.
Authors of RFCs MAY include an URI that is unique to them.
Inclusion of other information is OPTIONAL.
Required Sections

Authors of RFCs MUST provide a section for security
considerations as specified in
Additional Notes

It is RECOMMENDED to authors of RFCs to look at the source
file of this RFCs to gain a guideline on how RFCs are
constructed with xml2rfc.
Security Considerations

This memo has no applicable security considerations.