0.0
No release in over a year
metanorma-csand lets you write CSA Normal Documents (CSAND) in AsciiDoc syntax. This gem is in active development. Formerly known as asciidoctor-csand.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 9.1
~> 2.14
~> 0.3.12
~> 12.0
~> 3.6
= 0.54.0
~> 0.15
~> 0.9

Runtime

 Project Readme

Metanorma processor for CSA documents

Gem Version Build Status Code Climate Pull Requests Commits since latest

Functionality

This gem processes Metanorma documents following a template for generating CSA documents.

The gem currently inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it. Refer to the ISO gem documentation for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring

The following outputs are generated.

  • Metanorma XML

  • HTML output (from Metanorma XML)

  • PDF output (from Metanorma XML)

Usage

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

$ metanorma --type csa a.adoc                   # output just HTML
$ metanorma --type csa a.adoc --extensions html # output just HTML
$ metanorma --type csa a.adoc --extensions xml  # output CSAND XML

The gem translates the document into CSAND XML format, and then validates its output against the CSAND 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 to HTML, and outputs that files with the appropriate .html suffix.

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

Examples

Notes

Metanorma-CSA was formerly published as asciidoctor-csand.