This gem processes Metanorma documents following a template for generating OGC standards and documents.
It provides the following functions:
-
Compiles Metanorma input into the Metanorma-OGC XML format
-
Validates XML output against the Metanorma-OGC 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.
-
-
Metanorma-OGC XML is then converted into desired output formats.
The following outputs are supported:
-
Primary: the canonical Metanorma-OGC XML representation (
.xml
). -
Secondary: the Metanorma-OGC XML representation is processed to generate the following outputs as end deliverable OGC documents.
-
HTML (
.html
) -
PDF (
.pdf
) -
Word (
.doc
)
-
This gem inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it.
Please see https://www.metanorma.com for instructions to get started.
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-cli
$ gem install metanorma-ogc
Using the metanorma
CLI:
$ metanorma --type ogc a.adoc # output HTML
$ metanorma --type ogc --extensions html a.adoc # output just HTML
$ metanorma --type ogc --extensions xml a.adoc # output Metanorma XML
Please refer to the Metanorma-ISO documentation for general documentation.
-
Metanorma-ISO general documentation: https://www.metanorma.com/software/metanorma-iso/
-
Metanorma-ISO guidance: https://www.metanorma.com/software/metanorma-iso/docs/guidance/
-
Example documents are avalable at the mn-samples-ogc repository.
-
Document templates are available at the mn-templates-ogc repository.