Metanorma-BIPM library documentation

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

Functionality

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

Usage

The preferred way to invoke this gem is via the metanorma script:

$ metanorma --type bipm a.adoc                   # output HTML and PDF
$ metanorma --type bipm --extensions html a.adoc # output just HTML
$ metanorma --type bipm --extensions pdf a.pdf   # output just PDF
 $metanorma --type bipm --extensions xml a.adoc # output Metanorma XML</code></pre></div><p>The gem translates the document into Metanorma XML format, and then validates its output against the BIPM 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.</p><p>The gem then converts the XML into output formats such as HTML and PDF.</p><section id="_usage_installation"><h3 id="_usage_installation">Installation</h3><p>If you are using a Mac, the <a href="https://github.com/metanorma/metanorma-macos-setup" target="_blank" rel="noopener">https://github.com/metanorma/metanorma-macos-setup</a> 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:</p><div class="code-block" data-code-block><pre><code class="language-console">$  bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
$ gem install metanorma-bipm

Data Models

The document model for BIPM is given in metanorma-model-bipm.

Examples

Sample documents are given in mn-samples-bipm