Metanorma
On this page

Metanorma-NIST library documentation

Library documentation for Metanorma-NIST, the Metanorma flavor for NIST publications. Synced from the upstream gem README at github.com/metanorma/metanorma-nist.

Functionality

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

It provides the following functions:

  1. Compiles Metanorma input into the Metanorma-NIST XML format
  2. Validates XML output against the Metanorma-NIST 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-NIST XML is then converted into desired output formats.

The following outputs are supported:

  • Primary: the canonical Metanorma-NIST XML representation (.xml).
  • Secondary: the Metanorma-NIST XML representation is processed to generate the following outputs as end deliverable NIST 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−nist</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-nist</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 nist a.adoc                   # output HTML
$ metanorma --type nist --extensions html a.adoc # output just HTML
$ metanorma --type nist --extensions xml a.adoc  # output Metanorma XML

Authoring

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

Approach

Document model

The NIST SP 800 document model is detailed here:

It is an instance of the StandardDocument model.

Document input

Document input to Metanorma is for the compilation of content into the Metanorma XML document.

The Metanorma-NIST processor supports AsciiDoc input.

Similar to Markdown, AsciiDoc is a lightweight markup format, but combines the rigor and expressivity of DocBook. A number of editors (through plugins) support preview of AsciiDoc files, so textual content can be previewed without running the Metanorma toolchain.

The Metanorma processor automates numbering of headings, figures, tables etc, automatically generates references and citations, and the resulting output presentations.

Note
The Asciidoctor gem is used for AsciiDoc input parsing.
Note
documentation has been moved to metanorma.org

Examples

See https://gitlab.com/metanorma/mn-samples-nist (private repository)