README.adoc in metanorma-0.2.0 vs README.adoc in metanorma-0.2.1
- old
+ new
@@ -19,10 +19,11 @@
* 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]
* ISO Standards: the AsciiISO syntax, the https://github.com/riboseinc/isodoc-models/[IsoDoc Models], the https://github.com/riboseinc/asciidoctor-iso/[asciidoctor-iso IsoDoc implementation]
* CalConnect Standard Documents (CSD): the AsciiCSD syntax, https://github.com/riboseinc/csd[CSD Models], the https://github.com/riboseinc/asciidoctor-csd/[asciidoctor-csd implementation]
* Chinese GuoBiao (GB) Standards: the AsciiGB syntax, https://github.com/riboseinc/gbdoc[GbDoc Models], the https://github.com/riboseinc/asciidoctor-gb/[asciidoctor-gb implementation]
* Cloud Security Alliance Normal Documents (CSAND): the AsciiCSAND syntax, https://github.com/riboseinc/csand[CSAND Models], the https://github.com/riboseinc/asciidoctor-csand/[asciidoctor-csand implementation]
+* M3AAWG Documents (M3D): the AsciiM3D syntax, https://github.com/riboseinc/m3d[M3D Models], the https://github.com/riboseinc/asciidoctor-m3d/[asciidoctor-m3d implementation]
//* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/asciidoctor-rsd[asciidoctor-rsd implementation]
== Installation
@@ -48,35 +49,46 @@
[source,sh]
----
$ metanorma -h
Usage: metanorma [options] <file>
-t, --type TYPE Type of standard to generate: rfc2, rfc3, iso, gb, csd, csand, m3d
+ -x, --extensions EXT1,EXT2,... Type of extension to generate per type:
+ {
+ :rfc2=>{:xmlrfc=>"v2.xml"},
+ :rfc3=>{:xmlrfc=>"v3.xml"},
+ :iso=>{:html=>"html", :html_alt=>"alt.html", :doc=>"doc"},
+ :gb=>{:html=>"html", :doc=>"doc"},
+ :csd=>{:html=>"html", :pdf=>"pdf"},
+ :csand=>{:html=>"html"},
+ :m3d=>{:html=>"html", :doc=>"doc"},
+ :rsd=>{:html=>"html"}
+ }
-f, --format FORMAT Format of source file: asciidoc (current default, only format supported)
-r, --require LIBRARY Require LIBRARY prior to execution
-h, --help Show this message
----
Basically it is used like this:
[source,sh]
----
-metanorma --type <chosen-type> [--format input-format] iso-my-standard-document.adoc
+metanorma --type <chosen-type> [--format input-format] [--extensions EXT1,EXT2...] iso-my-standard-document.adoc
----
Options:
//, `rsd`
`type`:: (mandatory, specified via `--type` or `-t`) takes one of the following types:
-`rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`
+`rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`, `m3d`, `rsd`
`format`:: (specified via `--format` or `-f`) only accepts `asciidoc` for now
As the `--format` argument is (currently) optional, so:
[source,sh]
----
-metanorma --type iso iso-my-standard-document.adoc
+metanorma --type iso -x html iso-my-standard-document.adoc
----
== Origin of name