metanorma-acme 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b316e4548f6533c1e9e2d2fffec59fd34f3181e67ad665a19538496da0eff92
-  data.tar.gz: f79dd709e75c128addf55e181a421a2062988cc9302c2ac67a4ee690c8531b9c
+  metadata.gz: fbac64a224ed9b71d32900fbbad69d7d4b8b2fd62cecd0415c3f7fdd4390dff5
+  data.tar.gz: 46e0fa032335f5b72b226a852664230ca17ae91bc72901bab36cc1dfb9311d32
 SHA512:
-  metadata.gz: e0d135ed6999d82b33b8ffeffee27adb7e9572015221d439b367cf642a2f77540c5c0310bfa83a299dea471c983726b946798c77769c25ec5c7999ad32e88d36
-  data.tar.gz: 1d5c5027598b7008ccc672383cbd5e4f96d028007747dea85921fb29aa22927207836c16cf0866e03b23bb9b4ed9429b60fd8f5cf87c6d3c1e180eb52e89103f
+  metadata.gz: '039a1899119e0fe18e72c41b74de185299df2650190832f0a093f4aafb2cf32b08c3ccc5d8370bc419d860f1d79fd05d6ea42cd0ead658019b182b40ccfd6eb2'
+  data.tar.gz: a0c67c605103c0d07f02093583781efad988c3213a2b4ca62011b2d0707e627f25125ecc83ea6b61a32b80171941457bbb4b269f0d820a715cb192e31c81d368

data/README.adoc

@@ -1,44 +1,148 @@
-= metanorma-acme: Sample Asciidoctor processor for Metanorma documents
+= metanorma-ogc: Asciidoctor processor for Open Geospatial Consortium  documents
 
-image:https://img.shields.io/gem/v/metanorma-acme.svg["Gem Version", link="https://rubygems.org/gems/metanorma-acme"]
-image:https://img.shields.io/travis/riboseinc/metanorma-acme/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma-acme"]
-image:https://codeclimate.com/github/riboseinc/metanorma-acme/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma-acme"]
+image:https://img.shields.io/gem/v/metanorma-ogc.svg["Gem Version", link="https://rubygems.org/gems/metanorma-ogc"]
+image:https://img.shields.io/travis/riboseinc/metanorma-ogc/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma-ogc"]
+image:https://codeclimate.com/github/riboseinc/metanorma-ogc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma-ogc"]
+
+WARNING: This gem is still under development.
 
 == Functionality
 
-This is an example of a https://github.com/riboseinc/metanorma[Metanorma] gem for processing input formats (Asciidoctor) and generating output formats (Word, HTML, PDF). 
-It has been created as an exemplar for generating new instances of Metanorma gems, as illustrated in https://github.com/riboseinc/metanorma-iso/wiki/Gem-Customisation-Guide
+This gem processes http://asciidoctor.org/[Asciidoctor] documents following
+a template for generating OGC documents.
+
+The gem currently inherits from the https://github.com/riboseinc/metanorma-standoc
+gem, and aligns closely to it. Refer to the ISO gem documentation
+for guidance, including https://github.com/riboseinc/metanorma-iso/wiki/Guidance-for-authoring
+
+The following outputs are generated.
+
+* an XML representation of the document, intended as a document model for OGC documents.
+* The XML representation is processed in turn to generate the following outputs
+as end deliverable OGC documents.
+** HTML
+** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting.
+The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
+which is syntactically stricter than the common MathJax processor;
+if you do not get expected results, try bracketing terms your in AsciiMathML
+expressions.
+
+== Usage
 
-You can customise output of this gem for your own purposes without needing to customise the gem fully. You can use the
-following asciidoctor document variables to set the stylesheets that are passed as arguments to the `isodoc` gem:
+The preferred way to invoke this gem is via the `metanorma` script:
 
-[source,asciidoc]
+[source,console]
 ----
-:body-font: (name of the main font to be used)
-:header-font: (name of the header font to be used)
-:monospace-font: (name of the monospace font to be used)
-:htmlstylesheet: (stylesheet for HTML)
-:htmlcoverpage: (cover page for HTML)
-:htmlintropage: (intro page for HTML)
-:scripts: (scripts for HTML)
-:wordstylesheet: (default stylesheet for Word)
-:standardstylesheet: (standard-specific stylesheet for Word)
-:header: (header/footer HTML for Word)
-:wordcoverpage: (cover page for Word)
-:wordintropage: (intro page for Word)
-:ulstyle: (list style selector for unordered lists for Word)
-:olstyle: (list style selector for ordered lists for Word)
+$ metanorma --type ogc a.adoc                   # output HTML 
+$ metanorma --type ogc --extensions html a.adoc # output just HTML
+$ metanorma --type ogc --extensions xml a.adoc  # output RSD XML
 ----
 
-You should run the gem through the https://github.com/riboseinc/metanorma-cli[Metanorma CLI]: 
+The gem translates the document into Metanorma XML format, and then
+validates its output against the 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.
 
-[source, console]
+The gem then converts the XML into HTML.
+
+The gem can also be invoked directly within asciidoctor, though this is deprecated:
+
+[source,console]
 ----
-metanorma -r metanorma-acme -t acme test.adoc
+$ asciidoctor -b ogc -r 'metanorma-ogc' a.adoc  
 ----
 
-The CSS stylesheets are normally expected to be https://sass-lang.com/guide[SCSS], with the font names `$body-font, $header-font, $monospace-font` used as variables; but if you supply the stylesheets, you can bypass that customisation, and give the font names in the stylesheets.
+=== 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:
+
+[source,console]
+----
+$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ gem install metanorma-ogc
+$ gem install metanorma-cli
+----
+
+== Approach
+
+=== Document model
+
+The OGC Document model used by this gem is an instance of the
+https://github.com/riboseinc/isodoc-models[StandardDocument model].
+
+The Metanorma XML format intends to introduce rigor into the OGC
+standards authoring process, and is prescribed in a separate document.
+
+=== Asciidoctor
+
+Asciidoctor has been selected as the authoring tool to generate the document
+model representation of OGC standards. It is a document formatting tool like
+Markdown and DocBook, which combines the relative ease of use of the former
+(using relatively lightweight markup), and the rigor and expressively of the
+latter (it has a well-defined syntax, and was in fact initially developed as a
+DocBook document authoring tool). Asciidoctor has built-in capability to output
+Text, DocBook and HTML; so it can be used to preview the file as it is being
+autA
+
+Generating documents via a document model substantially automated formatting
+associated with the document, including automating numbering of headings, figures,
+tables etc, and automatically generating references and citations.
+hored.
+
+== Document Attributes
+
+=== Common attributes
+
+The gem relies on Asciidoctor document attributes to provide necessary
+metadata about the document. The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
+gem documents the Asciidoctor document attributes common to all metanorma gems. 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 (mandatory). The permitted types are:
++
+--
+code:: Code Artifact
+presentation:: Presentation
+proposal:: Proposal; includes IETF DRAFT
+standard:: Recommendation; includes IETF RFC
+report:: report
+--
+
+`:status:``:: The document status. The permitted types are: `proposal`,
+`working-draft`, `committee-draft`, `draft-standard`, `final-draft`,
+`published`, `withdrawn`.
+
+`:technical-committee:`:: The name of the relevant M3D technical committee
+(mandatory)
+
+`:language:` :: The language of the document (only `en` for now)  (mandatory)
+
+The attribute `:draft:`, if present, includes review notes in the XML output;
+these are otherwise suppressed.
+
+== Asciidoctor features specific to OGC
+
+The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
+gem documents the customisations of Asciidoctor markup common to all metanorma gems.
+The following markup is specific to this gem:
+
+
+== Examples
 
-The cover page and intro page are still expected to be http://liquidmarkup.org[Liquid Template] files, giving metadata fields from `isodoc/metadata.rb` in curly brackets. See https://github.com/riboseinc/isodoc/blob/master/lib/isodoc/metadata.rb for the default metadata field settings.
+* link:spec/examples/rfc6350.adoc[] is an Metanorma Asciidoctor version of https://tools.ietf.org/html/rfc6350[RFC 6350].
+* link:spec/examples/rfc6350.html[] is an HTML file generated from the Asciidoctor.
+* link:spec/examples/rfc6350.doc[] is a Word document generated from the Asciidoctor.
 
-The use of HTML and CSS for Word is idiosyncratic, and involves some trial and error; consult the documentation above for more information.

data/lib/asciidoctor/acme/converter.rb

@@ -104,13 +104,6 @@ module Asciidoctor
         d
       end
 
-      def pdf_convert(filename)
-        url = "#{Dir.pwd}/#{filename}.html"
-        pdfjs = File.join(File.dirname(__FILE__), 'pdf.js')
-        system "export NODE_PATH=$(npm root --quiet -g);
-                node #{pdfjs} file://#{url} #{filename}.pdf"
-      end
-
       def document(node)
         init(node)
         ret1 = makexml(node)
@@ -121,7 +114,7 @@ module Asciidoctor
           File.open(filename, "w") { |f| f.write(ret) }
           html_converter(node).convert filename unless node.attr("nodoc")
           word_converter(node).convert filename unless node.attr("nodoc")
-          pdf_convert(filename.sub(/\.xml$/, "")) unless node.attr("nodoc")
+          pdf_converter(node).convert filename unless node.attr("nodoc")
         end
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
@@ -161,6 +154,10 @@ module Asciidoctor
         IsoDoc::Acme::HtmlConvert.new(html_extract_attributes(node))
       end
 
+      def pdf_converter(node)
+        IsoDoc::Acme::PdfConvert.new(html_extract_attributes(node))
+      end
+
       def word_converter(node)
         IsoDoc::Acme::WordConvert.new(doc_extract_attributes(node))
       end

data/lib/asciidoctor/acme/isostandard.rng

@@ -744,6 +744,9 @@
     </define>
     <define name="preface">
       <element name="preface">
+        <optional>
+          <ref name="preface_abstract"/>
+        </optional>
         <ref name="foreword"/>
         <optional>
           <ref name="introduction"/>
@@ -811,6 +814,11 @@
       </optional>
     </element>
   </define>
+  <define name="preface_abstract">
+    <element name="abstract">
+      <ref name="Basic-Section"/>
+    </element>
+  </define>
   <define name="foreword">
     <element name="foreword">
       <ref name="Basic-Section"/>

data/lib/isodoc/acme/html/html_acme_titlepage.html

@@ -56,7 +56,7 @@
 <div  class="coverpage-stage-block" >{{ revdate }}</div>
 {% endif %}
 
-{% if status != "Published" and status != "Withdrawn" %}
+{% if unpublished %}
   <div class="coverpage-warning">
     <span class="title">Warning for Drafts</span>
 

data/lib/isodoc/acme/html/word_acme_titlepage.html

@@ -18,7 +18,7 @@ margin-left:4.25pt;margin-right:4.25pt'>
 
 <p class="MsoNormal" align="center" style='text-align:center;border:none;
 mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0pt 4.0pt'><span
-                     lang="EN-GB" style='font-size:16.0pt'>{{ status }} {{ doctype }}</span></p>
+                     lang="EN-GB" style='font-size:16.0pt'>{% if unpublished %}{{ status }} {% endif %}{{ doctype }}</span></p>
 
 {% if security %}
 <p class="MsoNormal" align="center" style='text-align:center;border:none;
@@ -39,7 +39,7 @@ mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:1.0pt 4.0pt 1.0
 mso-border-alt:solid windowtext .5pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
 margin-left:4.25pt;margin-right:4.25pt'>
 
-{% if status != "Published" and status != "Withdrawn" %}
+{% if unpublished %}
 <p class="MsoNormal" align="center" style='margin-bottom:6.0pt;text-align:center;
 border:none;mso-border-alt:solid windowtext .5pt;padding:0cm;mso-padding-alt:
 1.0pt 4.0pt 1.0pt 4.0pt'><b style='mso-bidi-font-weight:normal'><span

data/lib/isodoc/acme/metadata.rb

@@ -49,6 +49,10 @@ module IsoDoc
         end
       end
 
+      def unpublished(status)
+        %w(published withdrawn).include? status.downcase
+      end
+
       def version(isoxml, _out)
         super
         revdate = get[:revdate]

data/lib/metanorma/acme/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Acme
-    VERSION = "1.0.5"
+    VERSION = "1.0.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-acme
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -278,7 +278,6 @@ files:
 - lib/asciidoctor/acme/converter.rb
 - lib/asciidoctor/acme/isodoc.rng
 - lib/asciidoctor/acme/isostandard.rng
-- lib/asciidoctor/acme/pdf.js
 - lib/isodoc/acme.rb
 - lib/isodoc/acme/html/acme.scss
 - lib/isodoc/acme/html/header.html

data/lib/asciidoctor/acme/pdf.js

@@ -1,31 +0,0 @@
-'use strict';
-
-try {
-    require.resolve("puppeteer");
-} catch(e) {
-    console.error("puppeteer Node library is not installed; will not generate PDF");
-    process.exit(e.code);
-}
-
-const puppeteer = require('puppeteer');
-
-const createPdf = async() => {
-  let browser;
-  try {
-    browser = await puppeteer.launch({args: ['--no-sandbox', '--disable-setuid-sandbox']});
-    const page = await browser.newPage();
-    await page.goto(process.argv[2], {waitUntil: 'networkidle2'});
-    await page.pdf({
-      path: process.argv[3],
-      format: 'A4'
-    });
-  } catch (err) {
-      console.log(err.message);
-  } finally {
-    if (browser) {
-      browser.close();
-    }
-    process.exit();
-  }
-};
-createPdf();