Metanorma Tools
Purpose
Metanorma Tools is a command-line interface that supports the standards development lifecycle for various SDOs (Standards Development Organizations) to facilitate the production, packaging and delivery of Metanorma documents.
The post-compilation steps work on Metanorma Presentation XML output
(*.presentation.xml
).
Features
The gem provides workflow tools for:
- ISO (International Organization for Standardization)
-
-
ISO figure package: export images with ISO DRG compliant filenames into a package from Metanorma PXML
NoteThe ISO DRG publishes the DRG Directives that defines guidelines for the production of drawing files. -
Comment management for ISO comment sheets (planned - integrating
commenter
gem functionality) -
GitHub comment management integration for collaborative review processes (planned)
-
Pre-production fetch of ISO documents from the OBP into Metanorma documents (planned)
-
[other SDOs when needed…]
-
-
Installation
Add this line to your application’s Gemfile:
gem 'metanorma-tools'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install metanorma-tools
Usage
See the documentation for individual tools:
-
Figure extraction - Extract embedded figures from Metanorma presentation XML files
ISO workflows:
Development notes
The spec/fixtures/document-en.dis.presentation.xml
file contains sample
Metanorma XML for testing purposes from the
mn-samples-iso repository.
Dependencies
-
lutaml-model
: For structured data modeling -
nokogiri
: For XML parsing -
rubyzip
: For ZIP archive creation -
thor
: For command-line interface
Copyright
This gem is developed, maintained and funded by Ribose Inc.
License
The gem is available as open source under the terms of the 2-Clause BSD License.