Skip to content
Metanorma processor for OGC documents
Ruby CSS HTML Shell
Branch: master
Clone or download
Latest commit 2540804 Oct 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Move to GH Actions Oct 1, 2019
bin Customize for OGC Nov 21, 2018
lib version bump Oct 10, 2019
spec fix example titles; metanorma/metanorma-standoc#122 Sep 30, 2019
.gitignore Initial commit. May 3, 2018
.hound.yml Config Oct 12, 2018
.rubocop.yml version bump Nov 12, 2018
CODE_OF_CONDUCT.md Initial commit. May 3, 2018
Gemfile
LICENSE Initial commit. May 3, 2018
README.adoc Version bump Mar 23, 2019
README.adoc.old readme Mar 9, 2019
Rakefile Initial commit. May 3, 2018
metanorma-ogc.gemspec version bump Aug 20, 2019

README.adoc

metanorma-ogc: Metanorma processor for the Open Geospatial Consortium document class

Gem Version Build Status Appveyor Build Status Code Climate

Warning
This gem is still under development.

Functionality

This gem processes Metanorma documents into the OGC document class.

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
$ gem install metanorma-ogc

Usage

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

Authoring

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

Examples

You can’t perform that action at this time.