Metanorma
On this page

Metanorma-OGC library documentation

Library documentation for Metanorma-OGC, the Metanorma flavor for OGC standards. Synced from the upstream gem README at github.com/metanorma/metanorma-ogc.

Functionality

This gem processes Metanorma documents following a template for generating OGC standards and documents.

It provides the following functions:

  1. Compiles Metanorma input into the Metanorma-OGC XML format
  2. 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.
  3. 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)

Structure

This gem inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it.

Quickstart

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
geminstallmetanorma−ogc</code></pre></div></section></section><sectionid="usage"><h2id="usage">Usage</h2><p>Usingthe<code>metanorma</code>CLI:</p><divclass="code−block"data−code−block><pre><codeclass="language−console">gem install metanorma-ogc</code></pre></div></section></section><section id="_usage"><h2 id="_usage">Usage</h2><p>Using the <code>metanorma</code> CLI:</p><div class="code-block" data-code-block><pre><code class="language-console"> 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

Authoring

Please refer to the Metanorma-ISO documentation for general documentation.

Documentation

See Write Open Geospatial Consortium documents with Metanorma

Examples