Gem Version Build Status (macOS) Build Status (ubuntu) Build Status (Windows) Code Climate Pull Requests Commits since latest


This gem processes Asciidoctor documents following a template for generating RSD documents.

The gem currently inherits from the gem, and aligns closely to it. Refer to the ISO gem documentation for guidance, including

The following outputs are generated.

  • (Optional) An HTML preview generated directly from the Asciidoctor document, using native Asciidoctor formatting.

    • AsciiMathML is to be used for mathematical formatting. The gem uses the Ruby AsciiMath parser, which is syntactically stricter than the common MathJax processor; if you do not get expected results, try bracketing terms your in AsciiMathML expressions.

  • an XML representation of the document, intended as a document model for RSD International Standards.

  • The XML representation is processed in turn to generate the following outputs as end deliverable RSD standard drafts.

    • DOC

    • HTML

This AsciiDoc syntax for writing RSD standards is hereby named "AsciiRSD".


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

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

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

The gem can also be invoked directly within asciidoctor, though this is deprecated:

$ asciidoctor -b rsd -r 'metanorma-rsd' a.adoc


If you are using a Mac, the 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
$ gem install metanorma-rsd
$ gem install metanorma-cli


Data Models

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