metanorma 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf41abc2df53366a05f9a166d8d685d3e9b8eb082fa55a6995ff2ea4df69670b
-  data.tar.gz: 195e31799d6066458db3bfb81bbe27df5fef9e83b449b04be252af37e254e1d8
+  metadata.gz: ae92d14760f740cf2e0cfcb5502a9fca6cf5db3cc9409c0cd3a37a20fbe1e7ec
+  data.tar.gz: bd369ff18dcec200ceb9c6aedb983396a972361cf7829882d129b2b7582d3e27
 SHA512:
-  metadata.gz: 5fbb69eaa4d372b1f628625473b56743993a3014a16b2ce2eb6fa59325abe27ea6a29d1b8b21328951a037ba9e294ebc737521369ebd5c18c06ddc6eb226565a
-  data.tar.gz: 2f4cadd3d130b5237ef3b28ee79da29713637530f0b8e0eedcf0b577102a4ee0f43f85e2ba0ad00fc45a9a9bdb75232ba28a726acfe883e80ad2248fc77a84e4
+  metadata.gz: 31412b19dfb8c8d1d5e5372f79a4c109943e4f13ba9a615633b951e9f02017fe95cf6a878ed04f72e053d193593ddbe8aa65a37d09ddb79f5e768279371b6628
+  data.tar.gz: 5cc24d14bcc024167b05313996da2e9a22cc9a7ebfc266223b2d9cf2fad976132a53f9554a56d01226bc05f59614b25657a1119e8f75997c4e6f19833c86953b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metanorma (0.2.7)
+    metanorma (0.2.9)
 
 GEM
   remote: https://rubygems.org/
@@ -11,30 +11,30 @@ GEM
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
     mini_portile2 (2.3.0)
-    mixlib-shellout (2.3.2)
+    mixlib-shellout (2.4.0)
     nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
     rspec-command (1.0.3)
       mixlib-shellout (~> 2.0)
       rspec (~> 3.2)
       rspec-its (~> 1.2)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
+      rspec-support (~> 3.8.0)
     rspec-its (1.2.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.7.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
 
 PLATFORMS
   ruby

data/LICENSE.txt

@@ -1,21 +1,25 @@
-The MIT License (MIT)
+BSD 2-Clause License
 
-Copyright (c) 2017 Ribose Inc.
+Copyright (c) 2018, Ribose
+All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -136,23 +136,43 @@ Basically it is used like this:
 
 [source,sh]
 ----
-metanorma --type <chosen-type> [--format input-format] [--extensions EXT1,EXT2...] 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`, `m3d`, `rsd`
+`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`).
 
-`format`:: (specified via `--format` or `-f`) only accepts `asciidoc` for now
+`extension`:: (optional) specifies the output formats to be generated. If not specified,
+all possible output formats are generated. The output formats generated are constrained by
+what has been defined for each standard type. All standards can generate Metanorma XML (`xml`),
+and at least one of HTML (`html`), DOC (`doc`), PDF (`pdf`). Some standards generate alternative
+HTML renderings (e.g. `html_alt` for ISO).
 
+`format`:: (optional, specified via `--format` or `-f`) only accepts `asciidoc` for now,
+defaults to `asciidoc`
 
 As the `--format` argument is (currently) optional, so:
 
 [source,sh]
 ----
-metanorma --type iso -x html iso-my-standard-document.adoc
+$ metanorma --type iso -x html iso-my-standard-document.adoc
+----
+
+`require`:: If you wish to use metanorma with a document class which has not been included in the types recognised
+by the metanorma script, you will need to name the corresponding Metnorma gem explicitly with the `-r`
+option; e.g.
+
+[source,sh]
+----
+$ metanorma -t mpfd mpfd-bpn.adoc
+
+[metanorma] Error: mpfd is not a supported standard type.
+
+$ metanorma -t mpfd -r metanorma-mpfd mpfd-bpn.adoc
 ----
 
 

data/lib/metanorma/input/asciidoc.rb

@@ -28,6 +28,7 @@ module Metanorma
         /\n:htmlcoverpage: (?<htmlcoverpage>[^\n]+)\n/ =~ header
         /\n:htmlintropage: (?<htmlintropage>[^\n]+)\n/ =~ header
         /\n:scripts: (?<scripts>[^\n]+)\n/ =~ header
+        /\n:scripts-pdf: (?<scripts_pdf>[^\n]+)\n/ =~ header
         /\n:wordstylesheet: (?<wordstylesheet>[^\n]+)\n/ =~ header
         /\n:standardstylesheet: (?<standardstylesheet>[^\n]+)\n/ =~ header
         /\n:header: (?<header>[^\n]+)\n/ =~ header
@@ -46,6 +47,7 @@ module Metanorma
           htmlcoverpage: defined?(htmlcoverpage) ? htmlcoverpage : nil,
           htmlintropage: defined?(htmlintropage) ? htmlintropage : nil,
           scripts: defined?(scripts) ? scripts : nil,
+          scripts_pdf: defined?(scripts_pdf) ? scripts_pdf : nil,
           wordstylesheet: defined?(wordstylesheet) ? wordstylesheet : nil,
           standardstylesheet: defined?(standardstylesheet) ? standardstylesheet : nil,
           header: defined?(header) ? header : nil,

data/lib/metanorma/version.rb

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

metadata

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