README.adoc in asciidoctor-csd-0.1.0 vs README.adoc in asciidoctor-csd-0.2.2

- old
+ new

@@ -7,13 +7,18 @@ WARNING: This gem is still under development. == Functionality This gem processes http://asciidoctor.org/[Asciidoctor] documents following -a template for generating CSD International Standards. The following -outputs are generated. +a template for generating CSD International Standards. +The gem currently inherits from the https://github.com/riboseinc/asciidoctor-iso +gem, and aligns closely to it. Refer to the ISO gem +for guidance, including https://github.com/riboseinc/asciidoctor-iso/wiki/Guidance-for-authoring + +The following outputs are generated. + * (Optional) An HTML preview generated directly from the Asciidoctor document, using native Asciidocot formatting. ** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting. The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser], which is syntactically stricter than the common MathJax processor; @@ -225,30 +230,46 @@ `:title:`:: The main component of the English title of the document (mandatory). (The first line of the AsciiDoc document, which contains the title introduced with `=`, is ignored) `:doctype:`:: The document type (see CSD deliverables: The different types of -CSD publications) (mandatory). The permitted types are: `standard, governance`. +CSD publications) (mandatory). The permitted types are: ++ +-- +code:: Code Artifact +presentation:: Presentation +proposal:: Proposal; includes IETF DRAFT +standard:: Recommendation; includes IETF RFC +report:: report +-- +`:status:``:: The document status. The permitted types are: `proposal`, +`working-draft`, `committee-draft`, `draft-standard`, `final-draft`, +`published`, `withdrawn`. + `:technical-committee:`:: The name of the relevant CSD technical committee (mandatory) `:language:` :: The language of the document (only `en` for now) (mandatory) The attribute `:draft:`, if present, includes review notes in the XML output; these are otherwise suppressed. +== AsciiCSD features not also present in AsciiISO +* `+[keyword]#...#+`: encodes keywords, such as "MUST", "MUST NOT". (Encoded as +`<span class="keyword">...</span>`. + == Data Models The CSD Standard Document format is an instance of the https://github.com/riboseinc/isodoc-models[StandardDocument model]. Details of -this general model can be found on its page. +this general model can be found on its page. Details of the CSD modifications +to this general model can be found on the https://github.com/riboseinc/csd[CSD model] +repository. -=== CSD Document Model - -image::models/standard-document.png[] - - == Examples +* link:spec/examples/rfc6350.adoc[] is an AsciiCSD version of https://tools.ietf.org/html/rfc6350[RFC 6350]. +* link:spec/examples/rfc6350.html[] is an HTML file generated from the AsciiCSD. +* link:spec/examples/rfc6350.doc[] is a Word document generated from the AsciiCSD.