Project

metanorma-iec

0.01
A long-lived project that still receives updates
metanorma-iecmetanorma/metanorma-iecHomepageDocumentationSource CodeBug TrackerWiki
metanorma-iec lets you write IEC 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
257,900
Stars
1
Forks
2
Watchers
10
 Releases
Current version
2.5.7
Total releases
137
First release
2019-07-24
Latest release
2024-11-11
 Issues
Open Issues
3
Closed Issues
68
Total Issues
71
Issue Closure Rate
95%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
9
Merged Pull Requests
274
Pull Request Acceptance Rate
96%
 Development
Primary Language
XSLT
Licenses
BSD-2-Clause
Average date of last 50 commits
2024-10-22
Reverse Dependencies
1

 Dependencies

Development

xml-c14n
>= 0
equivalent-xml
~> 0.6
guard
~> 2.14
guard-rspec
~> 4.7
iev
~> 0.3.0
rake
~> 13.0
rspec
~> 3.6
rubocop
~> 1.5.2
sassc
= 2.4.0
simplecov
~> 0.15
timecop
~> 0.9
debug
>= 0

Runtime

pubid
>= 0
metanorma-iso
~> 2.9.0
 Project Readme

metanorma-iec: Metanorma processor for the International Electrotechnical Commission

Gem Version Build Status Code Climate Pull Requests Commits since latest

Functionality

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

The gem is basically the https://github.com/metanorma/metanorma-iso gem, with some tweaking of rendering to meet the particular requirements of the IEC.

It provides the following functions:

  1. Compiles Metanorma input into the Metanorma-IEC XML format (which is identical to Metanorma-ISO, since the two standards share the same document model)

  2. Validates XML output against the Metanorma-IEC 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.

  3. Metanorma-IEC XML is then converted into desired output formats.

The following outputs are supported:

  • Primary: the canonical Metanorma-IEC XML representation (.xml).

  • Secondary: the Metanorma-IEC XML representation is processed to generate the following outputs as end deliverable IEC documents.

    • HTML (.html)

    • Word (.doc)

Structure

This gem inherits from the https://github.com/metanorma/metanorma-iso gem, and aligns closely to it.

Quickstart

Please see https://www.metanorma.com for instructions to get started.

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

Usage

Using the metanorma CLI:

$ metanorma --type iec a.adoc                   # output HTML
$ metanorma --type iec --extensions html a.adoc # output just HTML
$ metanorma --type iec --extensions xml a.adoc  # output Metanorma XML

Authoring

Please refer to the Metanorma-ISO documentation for general documentation.

Examples