This gem processes Asciidoctor documents following a template for generating CSAND documents.
The gem currently inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it. Refer to the ISO gem documentation for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring
The following outputs are generated.
(Optional) An HTML preview generated directly from the Asciidoctor document, using native Asciidoctor formatting.
an XML representation of the document, intended as a document model for CSAND International Standards.
The XML representation is processed in turn to generate the following outputs as end deliverable CSAND standard drafts.
This AsciiDoc syntax for writing CSAND standards is hereby named "AsciiCSAND".
The preferred way to invoke this gem is via the
$ metanorma --type csand a.adoc # output just HTML $ metanorma --type csand a.adoc --extensions html # output just HTML $ metanorma --type csand a.adoc --extensions xml # output CSAND XML
The gem translates the document into CSAND XML format, and then validates its output against the CSAND XML document model; errors are reported to console against the XML, and are intended for users to check that they have provided all necessary components of the document.
The gem then converts the XML to HTML, and
outputs that files with the appropriate
The gem can also be invoked directly within asciidoctor, though this is deprecated:
$ asciidoctor -b csand -r 'asciidoctor-csand' a.adoc
If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup repository has instructions on setting up your machine to run Metanorma scripts such as this one. You need only run the following in a Terminal console:
$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup) $ gem install metanorma-csand