README.adoc in metanorma-0.3.9 vs README.adoc in metanorma-0.3.10

- old
+ new

@@ -1,11 +1,11 @@ = Metanorma: the standard for standards image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"] -image:https://img.shields.io/travis/riboseinc/metanorma/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma"] -image:https://codeclimate.com/github/riboseinc/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma"] -image:https://ci.appveyor.com/api/projects/status/t8irmy9iq4xf1ouy?svg=true["AppVeyor Build Status", link="https://ci.appveyor.com/project/ribose/metanorma"] +image:https://img.shields.io/travis/metanorma/metanorma/master.svg["Build Status", link="https://travis-ci.org/metanorma/metanorma"] +image:https://codeclimate.com/github/metanorma/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma"] +image:https://ci.appveyor.com/api/projects/status/t8irmy9iq4xf1ouy?svg=true["AppVeyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma"] Metanorma is dedicated to harmonizing standard documents produced by different standard-setting bodies in a manner that maintains correct semantics while allowing each standard publisher to define appropriate semantic extensions. @@ -18,64 +18,64 @@ implementations. The Metanorma document model is based on the SecureDoc document model. Metanorma includes the following sub-projects: -* The https://github.com/riboseinc/metanorma-model-standoc[Metanorma Standard Document model] +* The https://github.com/metanorma/metanorma-model-standoc[Metanorma Standard Document model] * IETF Internet-Drafts and RFCs: the https://datatracker.ietf.org/doc/draft-ribose-asciirfc/[AsciiRFC syntax], -the https://github.com/riboseinc/asciidoctor-rfc/[asciidoctor-rfc RFC XML v2 and v3 implementations] +the https://github.com/metanorma/asciidoctor-rfc/[asciidoctor-rfc RFC XML v2 and v3 implementations] * ISO Standards: the AsciiISO syntax, -the https://github.com/riboseinc/metanorma-model-iso/[Metanorma ISO model], -the https://github.com/riboseinc/metanorma-iso/[metanorma-iso IsoDoc implementation] +the https://github.com/metanorma/metanorma-model-iso/[Metanorma ISO model], +the https://github.com/metanorma/metanorma-iso/[metanorma-iso IsoDoc implementation] * CalConnect Standard Documents (CSD): the AsciiCSD syntax, -https://github.com/riboseinc/metanorma-model-csd[Metanorma CSD model], -the https://github.com/riboseinc/metanorma-csd/[metanorma-csd implementation] +https://github.com/metanorma/metanorma-model-csd[Metanorma CSD model], +the https://github.com/metanorma/metanorma-csd/[metanorma-csd implementation] * Chinese GuoBiao (GB) Standards: the AsciiGB syntax, -https://github.com/riboseinc/metanorma-model-gb[Metanorma GB models, for Chinese standards], -the https://github.com/riboseinc/metanorma-gb/[metanorma-gb implementation] +https://github.com/metanorma/metanorma-model-gb[Metanorma GB models, for Chinese standards], +the https://github.com/metanorma/metanorma-gb/[metanorma-gb implementation] * Cloud Security Alliance Normal Documents (CSAND): the AsciiCSAND syntax, -https://github.com/riboseinc/metanorma-model-csand[Metanorma CSAND model], -the https://github.com/riboseinc/metanorma-csand/[metanorma-csand implementation] +https://github.com/metanorma/metanorma-model-csand[Metanorma CSAND model], +the https://github.com/metanorma/metanorma-csand/[metanorma-csand implementation] * M3AAWG Documents (M3D): the AsciiM3D syntax, -https://github.com/riboseinc/metanorma-model-m3d[Metanorma M3D model], -the https://github.com/riboseinc/metanorma-m3d/[metanorma-m3d implementation] +https://github.com/metanorma/metanorma-model-m3d[Metanorma M3D model], +the https://github.com/metanorma/metanorma-m3d/[metanorma-m3d implementation] -* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/metanorma-rsd[metanorma-rsd implementation] +* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/metanorma/metanorma-rsd[metanorma-rsd implementation] -* Mandatory Provident Fund Schemes Authority of Hong Kong Documents (MPFD): https://github.com/riboseinc/metanorma-mpfd[metanorma-mpfd implementation] (still at proof-of-concept stage) +* Mandatory Provident Fund Schemes Authority of Hong Kong Documents (MPFD): https://github.com/metanorma/metanorma-mpfd[metanorma-mpfd implementation] (still at proof-of-concept stage) -* United Nations Economic Commision for Europe Documents (UNECE): https://github.com/riboseinc/metanorma-unece[metanorma-unece implementation] +* United Nations Economic Commision for Europe Documents (UNECE): https://github.com/metanorma/metanorma-unece[metanorma-unece implementation] == Installation on supported platforms === MacOS We recommend macOS users to directly run the Metanorma setup script located here: -https://github.com/riboseinc/metanorma-macos-setup +https://github.com/metanorma/metanorma-macos-setup This is a one-stop installation script that setups Ruby, Node and all necessary parts for running Metanorma. Alternatively, you can also use the Metanorma Docker container (see below). === Linux -Please see: https://github.com/riboseinc/metanorma-linux-setup +Please see: https://github.com/metanorma/metanorma-linux-setup Alternatively, you can also use the Metanorma Docker container (see below). === Docker: Windows and other platforms -Please use the Metanorma Docker container: https://github.com/riboseinc/metanorma-docker +Please use the Metanorma Docker container: https://github.com/metanorma/metanorma-docker //// If you want to run Ubuntu on MacOS, you should do the following beforehand: @@ -135,19 +135,19 @@ :mpdf=>{:html=>"html", :doc=>"doc", :pdf => "pdf"} :unece=>{:html=>"html", :doc=>"doc"} } In addition, xml (outside of rfc2, rfc3) generates IsoDoc XML. If the argument is "all" or the option is missing, all available extensions are generated. - -f, --format FORMAT Format of source file: asciidoc (current default, only format supported) - -r, --require LIBRARY Require LIBRARY prior to execution - -w, --wrapper Create wrapper folder for HTML output - -d, --data-uri-image Encode HTML output images as data URIs - -a, --asciimath Preserve AsciiMath in Metanorma XML, instead of transforming it into MathML - -R, --relaton FILENAME Export Relaton XML (bibdata) for this document to FILENAME + -f, --format FORMAT Format of source file: asciidoc (current default, only format supported) + -r, --require LIBRARY Require LIBRARY prior to execution + -w, --wrapper Create wrapper folder for HTML output + -d, --data-uri-image Encode HTML output images as data URIs + -a, --asciimath Preserve AsciiMath in Metanorma XML, instead of transforming it into MathML + -R, --relaton FILENAME Export Relaton XML (bibdata) for this document to FILENAME (Also triggered through -x rxl) - -S, --sourcecode DIR Export sourcecode fragments from this document to directory DIR - -h, --help Show this message + -e, --extract DIR(,ASSET1,ASSET2...) Extract assets from this document to directory DIR. If ASSET1,ASSET2 are named, only those types of asset are extracted. + -h, --help Show this message ---- Basically it is used like this: [source,sh] @@ -174,9 +174,18 @@ `datauriimage`:: Encode all images as data URIs. `relaton`:: exports the bibdata Relaton XML description of the document (which is part of its Metanorma XML) to the nominated directory. The filename is the document identifier, if present, else the document filename. + +`asciimath`:: Preserve AsciiMath in Metanorma XML, instead of transforming it into MathML (which is the default). + +`extract`:: export assets found in the document to the nominated directory. If no other arguments are given, +then all asset classes are exported, each to its own subdirectory. If trailing arguments are given, they +are taken as naming which asset classes to extract from the document. Three asset classes are recognised: +`sourcecode`, `image`, and `requirement` (which includes `recommendation` and `permission` elements). +The assets are given autonumbered names, unless they were given a `filename` attribute in the source +Metanorma XML, which is used instead. `format`:: (optional, specified via `--format` or `-f`) only accepts `asciidoc` for now, defaults to `asciidoc` As the `--format` argument is (currently) optional, so: