metanorma 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae92d14760f740cf2e0cfcb5502a9fca6cf5db3cc9409c0cd3a37a20fbe1e7ec
-  data.tar.gz: bd369ff18dcec200ceb9c6aedb983396a972361cf7829882d129b2b7582d3e27
+  metadata.gz: 89e2b288554021ed0d80a8425d488ac456f0610e3d8f2536f87d3b024fcc0c45
+  data.tar.gz: c2613fc25742f38cdcb69aff49317da995f0e16da6e2c0f9ce744cff62a137e2
 SHA512:
-  metadata.gz: 31412b19dfb8c8d1d5e5372f79a4c109943e4f13ba9a615633b951e9f02017fe95cf6a878ed04f72e053d193593ddbe8aa65a37d09ddb79f5e768279371b6628
-  data.tar.gz: 5cc24d14bcc024167b05313996da2e9a22cc9a7ebfc266223b2d9cf2fad976132a53f9554a56d01226bc05f59614b25657a1119e8f75997c4e6f19833c86953b
+  metadata.gz: 804bdc4101f46715e3445017094995a8a6e431e4c8ec07e70a7cf112c797d8c28884bcf7a2821eae13509393197fd75ee13cd13fb266870d8de9281e1217ef3d
+  data.tar.gz: 4b1f5384aeea20b08490524a7b788a53337311b4142e79858d3c05b070253d0f9624f71a3dd1947f05cec3d4efe6018667ca6c9ff51cefbe7d5f9d5660a0513c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metanorma (0.2.9)
+    metanorma (0.2.10)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ GEM
       nokogiri (>= 1.4.3)
     mini_portile2 (2.3.0)
     mixlib-shellout (2.4.0)
-    nokogiri (1.8.4)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     rake (10.5.0)
     rspec (3.8.0)

data/README.adoc

@@ -19,58 +19,59 @@ document model.
 
 Metanorma includes the following sub-projects:
 
-* The https://github.com/riboseinc/standoc-models[Metanorma document model (previously called StanDoc)]
+* The https://github.com/riboseinc/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]
 
 * 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]
+the https://github.com/riboseinc/metanorma-model-iso/[Metanorma ISO model],
+the https://github.com/riboseinc/metanorma-iso/[metanorma-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]
+https://github.com/riboseinc/metanorma-model-csd[Metanorma CSD model],
+the https://github.com/riboseinc/metanorma-csd/[metanorma-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]
+https://github.com/riboseinc/metanorma-model-gb[Metanorma GB models, for Chinese standards],
+the https://github.com/riboseinc/metanorma-gb/[metanorma-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]
+https://github.com/riboseinc/metanorma-model-csand[Metanorma CSAND model],
+the https://github.com/riboseinc/metanorma-csand/[metanorma-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]
+https://github.com/riboseinc/metanorma-model-m3d[Metanorma M3D model],
+the https://github.com/riboseinc/metanorma-m3d/[metanorma-m3d implementation]
 
-//* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/asciidoctor-rsd[asciidoctor-rsd implementation]
+//* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/metanorma-rsd[metanorma-rsd implementation]
 
 
-== Installation
+== Installation on supported platforms
 
-=== All-in-one install, MacOS
+=== MacOS
 
-macOS users can directly run the Metanorma setup script located here:
+We recommend macOS users to directly run the Metanorma setup script
+located here:
 https://github.com/riboseinc/metanorma-macos-setup
 
 This is a one-stop installation script that setups Ruby, Node
 and all necessary parts for running Metanorma.
 
-=== Installation, https://www.ubuntu.com[Ubuntu]
+Alternatively, you can also use the Metanorma Docker container (see below).
 
-[source,sh]
-----
-# Set up prerequisites
-apt-get update
-apt install -y git make ruby-bundler ruby-dev libxml2-dev libxslt-dev default-jre
-gem install bundler
-gem install nokogiri -v '1.8.4'
-gem install metanorma-cli
-----
+=== Linux
+
+Please see: https://github.com/riboseinc/metanorma-linux-setup
 
-(You may need to run these as `sudo`)
+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
+
+
+////
 If you want to run Ubuntu on MacOS, you should do the following beforehand:
 
 [source,sh]
@@ -86,6 +87,7 @@ dinghy up
 eval $(dinghy env)
 docker run -it ubuntu:18.10 bash
 ----
+////
 
 === Installing individual components
 
@@ -100,7 +102,7 @@ If you are going to generate PDFs from HTML (which applies to CSD), you will als
 the node library https://github.com/GoogleChrome/puppeteer:
 
 * Install Node, with at least version 7.6.0: https://nodejs.org/en/download/,
-https://nodejs.org/en/download/package-manager/ . (For Mac, `brew install node`)
+https://nodejs.org/en/download/package-manager/ . (For macOS, `brew install node`)
 * Install npm: https://docs.npmjs.com/getting-started/installing-node
 * Install puppeteer: `npm install -g --save --save-exact puppeteer`
 
@@ -129,6 +131,9 @@ Usage: metanorma [options] <file>
   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
+  -R, --relaton FILENAME           Export Relaton XML (bibdata) for this document to FILENAME
   -h, --help                       Show this message
 ----
 
@@ -142,7 +147,7 @@ $ metanorma --type <chosen-type> [--format input-format] [--extensions EXT1,EXT2
 Options:
 
 `type`:: (mandatory, specified via `--type` or `-t`) takes one of the following types:
-`rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`, `m3d`, `rsd`. Each of these corresponds to a 
+`rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`, `m3d`, `rsd`. Each of these corresponds to a
 standards class and a Metanorma gem; the list of standards classes supported by the script
 by default will grow (see also `require`).
 
@@ -152,6 +157,13 @@ what has been defined for each standard type. All standards can generate Metanor
 and at least one of HTML (`html`), DOC (`doc`), PDF (`pdf`). Some standards generate alternative
 HTML renderings (e.g. `html_alt` for ISO).
 
+`wrapper`:: create a separate folder for each instance of HTML output generated; the folder is named
+the same as the output file, without the `.html` suffix. Used to make distribution of HTML outputs
+more straightforward.
+
+`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.
+
 `format`:: (optional, specified via `--format` or `-f`) only accepts `asciidoc` for now,
 defaults to `asciidoc`
 

data/lib/metanorma/input/asciidoc.rb

@@ -36,6 +36,7 @@ module Metanorma
         /\n:wordintropage: (?<wordintropage>[^\n]+)\n/ =~ header
         /\n:ulstyle: (?<ulstyle>[^\n]+)\n/ =~ header
         /\n:olstyle: (?<olstyle>[^\n]+)\n/ =~ header
+        /\n(?<datauriimage>:data-uri-image:[^\n]*)\n/ =~ header
         {
           script: defined?(script) ? script : nil,
           bodyfont: defined?(bodyfont) ? bodyfont : nil,
@@ -55,6 +56,7 @@ module Metanorma
           wordintropage: defined?(wordintropage) ? wordintropage : nil,
           ulstyle: defined?(ulstyle) ? ulstyle : nil,
           olstyle: defined?(olstyle) ? olstyle : nil,
+          data_uri_image: defined?(datauriimage) ? true : nil,
         }.reject { |_, val| val.nil? }
       end
 

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "0.2.9"
+  VERSION = "0.2.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler