Project

metanorma-ogc

0.01
A long-lived project that still receives updates
metanorma-ogcmetanorma/metanorma-ogcHomepageDocumentationSource CodeBug TrackerWiki
Metanorma for the Open Geospatial Consortium.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
290,839
Stars
2
Forks
3
Watchers
10
 Releases
Current version
2.6.6
Total releases
150
First release
2018-12-19
Latest release
2024-11-11
 Issues
Open Issues
7
Closed Issues
379
Total Issues
386
Issue Closure Rate
98%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
10
Merged Pull Requests
335
Pull Request Acceptance Rate
97%
 Development
Primary Language
XSLT
Licenses
BSD-2-Clause
Average date of last 50 commits
2024-10-20
Reverse Dependencies
1

 Dependencies

Development

equivalent-xml
~> 0.6
guard
~> 2.14
guard-rspec
~> 4.7
rake
~> 13.0
rspec
~> 3.6
rubocop
~> 1.5.2
sassc
= 2.4.0
simplecov
~> 0.15
timecop
~> 0.9
xml-c14n
>= 0
debug
>= 0
vcr
~> 6.1.0
webmock
>= 0

Runtime

iso-639
>= 0
metanorma-standoc
~> 2.10.0
 Project Readme

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

Gem Version Build Status Code Climate Pull Requests Commits since latest

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
$ 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