Functionality
This gem processes Asciidoctor documents following a template for generating ITU 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.
-
an XML representation of the document, intended as a document model for ITU documents.
-
The XML representation is processed in turn to generate the following outputs as end deliverable ITU documents.
-
HTML
-
AsciiMathML is to be used for mathematical formatting. The gem uses the Ruby AsciiMath parser, which is syntactically stricter than the common MathJax processor; if you do not get expected results, try bracketing terms your in AsciiMathML expressions.
-
Usage
The preferred way to invoke this gem is via the metanorma
script:
$ metanorma --type itu a.adoc # output HTML
$ metanorma --type itu --extensions html a.adoc # output just HTML
$ metanorma --type itu --extensions xml a.adoc # output RSD XML
The gem translates the document into Metanorma XML format, and then validates its output against the Metanorma 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 into HTML.
Installation
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-acme
$ gem install metanorma-cli
Documentation
Examples
-
spec/examples/rfc6350.adoc is an Metanorma Asciidoctor version of RFC 6350.
-
spec/examples/rfc6350.html is an HTML file generated from the Asciidoctor.
-
spec/examples/rfc6350.doc is a Word document generated from the Asciidoctor.