Project

asciidoctor-iso

0.01
No release in over 3 years
asciidoctor-isoriboseinc/asciidoctor-isoHomepageDocumentationSource CodeBug TrackerWiki
asciidoctor-iso lets you write ISO standards in AsciiDoc syntax. This gem is in active development.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
50,074
Stars
13
Forks
4
Watchers
17
 Releases
Current version
0.10.4
Total releases
27
First release
2017-12-24
Latest release
2018-08-14
 Issues
Open Issues
34
Closed Issues
728
Total Issues
762
Issue Closure Rate
95%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
12
Merged Pull Requests
378
Pull Request Acceptance Rate
96%
 Development
Primary Language
XSLT
Licenses
BSD-2-Clause
Average date of last 50 commits
2024-03-24
Reverse Dependencies
7

 Dependencies

Development

bundler
~> 1.15
byebug
>= 0
equivalent-xml
~> 0.6
guard
~> 2.14
guard-rspec
~> 4.7
isobib
~> 0.2.0
metanorma
~> 0.2.6
rake
~> 12.0
rspec
~> 3.6
rubocop
~> 0.50
simplecov
~> 0.15
timecop
~> 0.9

Runtime

asciidoctor
~> 1.5.7
iev
~> 0.2.0
isodoc
~> 0.8.8
metanorma-standoc
~> 0.0.1
relaton
~> 0.1.3
ruby-jing
>= 0
 Project Readme

Metanorma-ISO: Metanorma processor for ISO standards

Gem Version Build Status Code Climate Pull Requests Commits since latest

Functionality and Approach

For the conceptual underpinnings of this gem, and the other gems in the Metanorma suite, see the metanorma-standoc README.

Outputs

This gem processes Metanorma documents following a template for generating ISO International Standards. The following outputs are generated.

  • The XML representation of the document, intended as a document model for ISO International Standards.

  • Microsoft Word output (.doc), following the style conventions of the ISO Standard Microsoft Word template.

  • HTML. For ISO, two HTML files are generated: the .html file follows ISO conventions in rendering, which looks very similar to the Word output, while the -alt.html file has richer styling.

  • PDF. Not supported for the ISO gem, but available for other specifications, generated from the HTML file.

The following input formats are supported:

  • Asciidoctor (This AsciiDoc syntax for writing ISO standards is hereby named "AsciiISO".)

Usage

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

$ metanorma --type iso a.adoc                   # output HTML and DOC
$ metanorma --type csd --extensions html a.adoc # output just HTML
$ metanorma --type csd --extensions doc a.adoc  # output just DOC
$ metanorma --type csd --extensions xml a.adoc  # output CSD XML

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

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

The metanorma-cli gem is the command-line interface for the Metanorma tool suite (incorporating the metanorma executable seen above).

Documentation

Examples

Notes

Metanorma-ISO was formerly published as asciidoctor-iso.