metanorma / metanorma-vg

Metanorma for VSD

Metanorma for Vita Green: Metanorma processor for Vita Green Standard Documents

Formerly known as metanorma-vsd.

THIS GEM IS FROZEN AND WILL NO LONGER BE ACTIVELY MAINTAINED

Functionality

This gem processes Asciidoctor documents following a template for generating Vita Green standards.

The gem currently inherits from the https://github.com/riboseinc/asciidoctor-iso 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 vg a.adoc                   # output HTML and DOC
$ metanorma --type vg --extensions html a.adoc # output just HTML
$ metanorma --type vg --extensions doc a.adoc  # output just DOC
$ metanorma --type vg --extensions xml a.adoc  # output Metanorma XML

The gem translates the document into Metanorma XML format, and then validates its output against the Vita Green 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/riboseinc/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/riboseinc/metanorma-macos-setup/master/metanorma-setup)
$ gem install metanorma-vg

Document Attributes

The gem relies on Asciidoctor document attributes to provide necessary metadata about the document. These include:

:edition:

The document edition

:revdate:

The date the document was last updated

:copyright-year:

The year which will be claimed as when the copyright for the document was issued

:title:

The main component of the English title of the document (mandatory). (The first line of the AsciiDoc document, which contains the title introduced with =, is ignored)

:doctype:

The document type (see VSD deliverables: The different types of VSD publications) (mandatory). The permitted types are:

• policy-and-procedures

• best-practices

• supporting-document

• report

• legal

• directives

• proposal

• standard

:status:`

The document status. The permitted types are: proposal, working-draft, committee-draft, draft-standard, final-draft, published, withdrawn.

:committee:

The name of the relevant VSD committee (mandatory)

:committee-type:

The type of the relevant VSD committee (mandatory): technical or provisional.

:language:

The language of the document (only en for now) (mandatory)

:security:

Security level classification, e.g., "confidential", "client confidential"

The attribute :draft:, if present, includes review notes in the XML output; these are otherwise suppressed.

Data Models

The Vita Green Standard Document format is an instance of the StandardDocument model. Details of this general model can be found on its page.

metanorma-vg's Issues

Migrate this gem to something more sustainable

It is unsustainable to proliferate gems like this: we simply cannot continue to maintain them, and this gem in particular has been out of the maintenance loop for months. This gem should, if at all possible, become a skin of the generic metanorma-acme gem, which is being maintained.

Migrate this repository to github.com/metanorma

The repository github.com/metanorma has been set up to host all Metanorma related work. This is one such piece of work. While the migration will be slow (there is a lot to do, and a lot of interdependencies), we need to schedule migration for all related repositories.

Migration to Metanorma:

• Repost the repository to http://github.com/metanorma/X
  • This should be as simple as changing the following field in .git/config: [remote "origin"] url = https://github.com/riboseinc/metanorma-iso.git. Refer https://help.github.com/en/articles/transferring-a-repository
• If this is a Ruby gem, change the address of the repository in the *.gemspec
• Delete all files but the Readme in the riboseinc repository
• Replace the Readme in the riboseinc repository with the message "Repository migrated to http://github.com/metanorma/X
• Update the links to the repository in any documentation you maintain
• Notify @opoudjis and @strogonoff when you have migrated the repository. They will then update the links to the repository in any documentation they maintain.

Archive this repo

Per @opoudjis this repo will not be maintained, so @ronaldtse please archive it for convenience

Fix specs due to `isodoc` gem

One spec now fails caused by the isodoc gem (metanorma/isodoc#94).

Originally posted by @ronaldtse in #2 (comment)

Refactor HTML CSS

metanorma/isodoc#112