The project is in a healthy, maintained state
metanorma-ribose lets you write Ribose standards in AsciiDoc syntax. This gem is in active development. Formerly known as asciidoctor-rsd, metanorma-rsd.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

metanorma-ribose: Asciidoctor processor for Ribose Standard Documents

Gem Version Build Status Code Climate Pull Requests Commits since latest

Functionality

This gem processes Metanorma documents following the Metanorma model for generating Ribose standards.

The gem currently inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it. Refer to https://metanorma.com for guidance.

Usage

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

$ metanorma --type ribose a.adoc                   # output HTML and DOC
$ metanorma --type ribose --extensions html a.adoc # output just HTML
$ metanorma --type ribose --extensions doc a.adoc  # output just DOC
$ metanorma --type ribose --extensions xml a.adoc  # output Metanorma XML

The gem translates the document into Metanorma XML format, and then validates its output against the Ribopse 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.

The gem then converts the XML into output formats such as HTML and PDF.

Installation

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

Documentation

Data Models

The Ribose Standard Document format is an instance of the StandardDocument model. Details of this general model can be found on its page. Details of the Ribose modifications to this general model can be found on the RSD model repository.

Examples

Example documents may be found in the mn-samples-ribose repository.

Notes

Metanorma-Ribose was formerly published as asciidoctor-rsd, metanorma-rsd.