metanorma-unece 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc96f4c10497c4a82ea01cfbf023ca98d296e9a0e7e4f3e82900328a6a96e27
-  data.tar.gz: 1057969d7adf07d6b81db802a3735d92c9d9ed9db922bbfd0fc28d448eb6e84b
+  metadata.gz: 53b8636e2a653b20e080afc8800bb32ddcc6acab949f3bcc94901ec283a97ed4
+  data.tar.gz: 437cad2230a5168a1a167a0dfb22bc959c1e9aeb14f6a71bfe8a137b5e24dc93
 SHA512:
-  metadata.gz: e3d249786ac6967b7fe394e170f7ea66129cdc216577ad07056bfebf3bf7eab04e3316eb2ce20d74c351b358a828021d35b1c64eb5183b02a6f04c438afe699b
-  data.tar.gz: c5a9c7fd022a2193d6fec8ebec13676cc71ae59635cc46122ada39ebbd66a1c023dd88c33aa65f6e43ed9553b29086e9459bfb5f2b68e168215140c0b5f08953
+  metadata.gz: 6a3f3d7db7d6c4ac94d71628e6ab8a2c3392bfa05db861a3fea3edef38a5c04dd64996af017032dfca6300be33d849c7704daf1c2625c263a4dd7e5eb60c3b16
+  data.tar.gz: 45e70bea116288b824581b3cfde56764de696de5cd854359206688b5f837328e6c1fd0c9619e79eb0355464f5afaad3bfd2e295c04acd80f53c60adfd301763c

data/README.adoc

@@ -1,8 +1,8 @@
 = Metanorma processor for UNECE documents
 
 image:https://img.shields.io/gem/v/metanorma-unece.svg["Gem Version", link="https://rubygems.org/gems/metanorma-unece"]
-image:https://img.shields.io/travis/riboseinc/metanorma-unece/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma-unece"]
-image:https://codeclimate.com/github/riboseinc/metanorma-unece/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma-unece"]
+image:https://img.shields.io/travis/metanorma/metanorma-unece/master.svg["Build Status", link="https://travis-ci.org/metanorma/metanorma-unece"]
+image:https://codeclimate.com/github/metanorma/metanorma-unece/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-unece"]
 
 WARNING: This gem is still under development.
 
@@ -12,9 +12,9 @@ WARNING: This gem is still under development.
 This gem processes http://asciidoctor.org/[Asciidoctor] documents following
 a template for generating UNECE International Standards.
 
-The gem currently inherits from the https://github.com/riboseinc/metanorma-standoc[Metanorma-Standoc]
+The gem currently inherits from the https://github.com/metanorma/metanorma-standoc[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 Authoring Guide].
+for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring[the Authoring Guide].
 
 The following outputs are generated.
 
@@ -68,13 +68,13 @@ https://www.metanorma.com/overview/getting-started/
 
 === macOS
 
-If you are using macOS, the https://github.com/riboseinc/metanorma-macos-setup
+If you are using macOS, the https://github.com/metanorma/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)
+$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
 $ gem install metanorma-unece
 $ gem install metanorma-cli
 ----
@@ -85,7 +85,7 @@ Since this software is still in development it is not yet as mature as the other
 
 The easiest way to try out is using a Mac. It takes a little bit more work on a Windows machine through the platform-independent Docker container (see the https://www.metanorma.com/overview/getting-started/#docker-setup[Metanorma Quickstart guide]) , but it is doable.
 
-The current examples of UNECE documents encoded using Metanorma is provided in https://github.com/riboseinc/unece-docs/
+The current examples of UNECE documents encoded using Metanorma is provided in https://github.com/metanorma/unece-docs/
 
 (Please run the 2-line macOS setup script prior to the following)
 
@@ -93,7 +93,7 @@ First, use Git to clone the code and documents:
 
 [source,console]
 --
-git clone https://github.com/riboseinc/unece-docs/
+git clone https://github.com/metanorma/unece-docs/
 --
 
 Then, install all dependencies with this command:
@@ -114,156 +114,19 @@ Then you will see the files generated, including HTML and Word Doc.
  
 The easiest way to start a new document is to copy one of the two samples and modify them.
 
+== Documentation
 
-
-== Approach
-
-=== Document model
-
-The UNECE Standard Document model is an instance of the
-https://github.com/riboseinc/metanorma-model-standoc[StandardDocument model].
-
-The UNECE format ("UNECE XML") intends to introduce rigor into the UNECE
-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 UNECE 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
-authored.
-
-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.
-
-== 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 (see _UNECE deliverables: The different types of
-UNECE publications_) (mandatory). Note that the document types are reflected in the
-document identifier. The permitted types for UNECE are:
-+
---
-recommendation:: UNECE Recommendation
-plenary:: UNECE Plenary document
-addendum:: Addendum
-communication:: Communication
-corrigendum:: Corrigendum
-reissue:: Reissue (of something)
-agenda:: Documents relating to agendas of principal organs
-budgetary:: Documents relating to programme budget implications
-sec-gen-notes:: Notes by the Secretary-General
-expert-report:: Reports of intergovernmental and expert bodies
-resolution:: Resolutions and other formal decisions of United Nations organs
---
-
-`:status:``:: The document status. The permitted types are: `proposal`,
-`working-draft`, `committee-draft`, `draft-standard`, `final-draft`,
-`published`, `withdrawn`.
-
-`:committee:`:: The name of the relevant UNECE committee, for example,
-  `United Nations Centre for Trade Facilitation and Electronic Business (UN/CEFACT)` (mandatory)
-
-`:language:` :: The language(s) of the document. This is the language in which the document
-has been issued, not the language(s) in which it has been submitted. ISO-639-1 codes are used
-for languages, and they are comma-delimited. If not specified, the six official languages of the
-UN are assumed: Arabic, Chinese, English, French, Russian and Spanish (`ar,zh,en,fr,ru,es`).
-`:script:` :: The script of the document
-
-`:toc:` :: Include table of contents in Word output. (Table of contents is always included in
-HTML output.)
-
-NOTE: The attribute `:draft:`, if present, includes review notes in the XML output;
-these are otherwise suppressed.
-
-=== UN document-specific attributes
-
-`:distribution:`:: Extent of distribution allowed. e.g. `General`
-
-=== Recommendation specific attributes
-
-`:docnumber:`:: The document number if the document is a Recommendation. e.g. `42` for Recommendation 42, which happens to be the ultimate answer. (mandatory for Recommendation)
-
-`:submissionlanguage:`:: The language(s) in which the document was originally submitted.
-ISO-639-1 codes are used for languages, and they are comma-delimited. 
-
-=== Plenary document specific attributes
-
-`:session-date:`:: Date of the session where this document will be discussed. e.g. `Geneva, 30 April – 1 May 2018`
-
-`:item-number:`:: Number of the agenda item this document belongs to. e.g. `Item 6 of the provisional agenda`. If the document corresponds to multiple items, they are comma-delimited. If the document belongs to multiple subitems under a single item, following editorial practice of the UN (http://dd.dgacm.org/editorialmanual/ed-guidelines/format/Model_mast21.pdf), give the item and subitems identifiers here.
-
-`:item-name:`:: Name of the agenda item this document belongs to. If the document corresponds to multiple items, they are comma-delimited. 
-`:subitem-name:`:: Name of the agenda subitem this document belongs to. If the document corresponds to multiple subitems, they are comma-delimited. 
-
-`:collaborator:`:: Collaborator of this document, if any. e.g. `World Economic Forum`
-
-`:agenda-id:`:: The unique identifier of this agenda item. e.g. `ECE/TRADE/C/CEFACT/2018/6`. If there are multiple agenda items or subitems, given them comma-delimited.
-
-`:item-footnote:`:: Footnoted reference to item, if item is on the preliminary list or the provisional agenda.
-
-[[model_additions]]
-== Asciidoctor features specific to UNECE
-
-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:
-
-=== Abstract
-
-Abstracts are moved to the front page in plenary documents. In recommendation documents, they appear in the document preface, before the foreword and introduction.
-
-=== Paragraph numbering
-
-Paragraphs are automatically numbered in this gem, and paragraph numbers should not be entered in the Asciidoctor
-source. Paragraphs are numbered by treating each paragraph in the Metanorma XML as a separate clause; all terminal
-clauses in UNECE Metanorma XML are rendered as a numbered paragraph. Non-paragraph blocks (tables, figures, admonitions, 
-lists) are not numbered; nor are paragraphs in prefatory material (introduction, foreword, abstract). 
-
-=== Admonitions
-
-The admonition container "IMPORTANT" is used to render UNECE document boxes. Unlike normal Metanorma admonitions,
-UNECE admonitions can have titles:
-
-[source,asciidoctor]
---
-[IMPORTANT]
-.Business Process Analysis Plus (BPA+)   (<==== This is the box title)
-====
-Business Process Analysis was initially designed to document and evaluate an import/export process at a given point time and its relative simplicity. It also specifically includes a measurement of the time and cost of the complete range of procedures as one of the main outputs of the analysis. This combination makes it suitable as the basis/core of a trade facilitation monitoring and improvement system.
-====
---
+See https://www.metanorma.com/author/unece/[The UNECE flavor of Metanorma]
 
 
 == Data Models
 
 The UNECE Standard Document format is an instance of the
-https://github.com/riboseinc/metanorma-model-standoc[StandardDocument model]. Details of
+https://github.com/metanorma/metanorma-model-standoc[StandardDocument model]. Details of
 this general model can be found on its page.
 
 Details of the UNECE modifications to this general model can be found in the
-https://github.com/riboseinc/metanorma-model-unece[UNECE model]
+https://github.com/metanorma/metanorma-model-unece[UNECE model]
 repository.
 
 == Examples

data/lib/asciidoctor/unece/biblio.rng

@@ -156,9 +156,9 @@
       <zeroOrMore>
         <ref name="contact"/>
       </zeroOrMore>
-      <optional>
+      <zeroOrMore>
         <ref name="uri"/>
-      </optional>
+      </zeroOrMore>
     </element>
   </define>
   <define name="fullname">
@@ -246,9 +246,9 @@
       <optional>
         <ref name="abbreviation"/>
       </optional>
-      <optional>
+      <zeroOrMore>
         <ref name="uri"/>
-      </optional>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="org-identifier"/>
       </zeroOrMore>
@@ -469,12 +469,13 @@
       <value>film</value>
       <value>video</value>
       <value>broadcast</value>
-      <value>graphic work</value>
+      <value>graphic_work</value>
       <value>music</value>
       <value>patent</value>
       <value>inbook</value>
       <value>incollection</value>
       <value>inproceedings</value>
+      <value>journal</value>
     </choice>
   </define>
   <define name="BibliographicItem">
@@ -739,39 +740,44 @@
     <element name="series">
       <optional>
         <attribute name="type">
-          <choice>
-            <value>main</value>
-            <value>alt</value>
-          </choice>
+          <ref name="SeriesType"/>
         </attribute>
       </optional>
       <choice>
-        <ref name="btitle"/>
         <ref name="formattedref"/>
+        <group>
+          <ref name="btitle"/>
+          <optional>
+            <ref name="bplace"/>
+          </optional>
+          <optional>
+            <ref name="seriesorganization"/>
+          </optional>
+          <optional>
+            <ref name="abbreviation"/>
+          </optional>
+          <optional>
+            <ref name="seriesfrom"/>
+          </optional>
+          <optional>
+            <ref name="seriesto"/>
+          </optional>
+          <optional>
+            <ref name="seriesnumber"/>
+          </optional>
+          <optional>
+            <ref name="seriespartnumber"/>
+          </optional>
+        </group>
       </choice>
-      <optional>
-        <ref name="bplace"/>
-      </optional>
-      <optional>
-        <ref name="seriesorganization"/>
-      </optional>
-      <optional>
-        <ref name="abbreviation"/>
-      </optional>
-      <optional>
-        <ref name="seriesfrom"/>
-      </optional>
-      <optional>
-        <ref name="seriesto"/>
-      </optional>
-      <optional>
-        <ref name="seriesnumber"/>
-      </optional>
-      <optional>
-        <ref name="seriespartnumber"/>
-      </optional>
     </element>
   </define>
+  <define name="SeriesType">
+    <choice>
+      <value>main</value>
+      <value>alt</value>
+    </choice>
+  </define>
   <define name="seriesorganization">
     <element name="organization">
       <text/>
@@ -849,6 +855,7 @@
           <value>includes</value>
           <value>instance</value>
           <value>partOf</value>
+          <value>hasDraft</value>
         </choice>
       </attribute>
       <element name="bibitem">
@@ -861,9 +868,6 @@
   </define>
   <define name="version">
     <element name="version">
-      <optional>
-        <ref name="vedition"/>
-      </optional>
       <optional>
         <ref name="revision-date"/>
       </optional>

data/lib/asciidoctor/unece/converter.rb

@@ -123,7 +123,7 @@ module Asciidoctor
         result << "</unece-standard>"
         result = textcleanup(result)
         ret1 = cleanup(Nokogiri::XML(result))
-        validate(ret1)
+        validate(ret1) unless @novalid
         ret1.root.add_namespace(nil, Metanorma::Unece::DOCUMENT_NAMESPACE)
         ret1
       end

data/lib/asciidoctor/unece/isodoc.rng

@@ -18,6 +18,7 @@
   of this.
 -->
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <include href="reqt.rng"/>
   <include href="biblio.rng">
     <define name="status">
       <element name="status">

data/lib/asciidoctor/unece/reqt.rng

@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/metanorma/unece/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Unece
-    VERSION = "0.0.12"
+    VERSION = "0.0.13"
   end
 end

data/metanorma-unece.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
     Metanorma for UNECE: United Nations Economic Commission for Europe.
   DESCRIPTION
 
-  spec.homepage      = "https://github.com/riboseinc/metanorma-unece"
+  spec.homepage      = "https://github.com/metanorma/metanorma-unece"
   spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-unece
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -316,6 +316,7 @@ files:
 - lib/asciidoctor/unece/converter.rb
 - lib/asciidoctor/unece/isodoc.rng
 - lib/asciidoctor/unece/isostandard.rng
+- lib/asciidoctor/unece/reqt.rng
 - lib/asciidoctor/unece/unece.rng
 - lib/isodoc/unece.rb
 - lib/isodoc/unece/html/header.html
@@ -340,7 +341,7 @@ files:
 - lib/metanorma/unece/processor.rb
 - lib/metanorma/unece/version.rb
 - metanorma-unece.gemspec
-homepage: https://github.com/riboseinc/metanorma-unece
+homepage: https://github.com/metanorma/metanorma-unece
 licenses:
 - BSD-2-Clause
 metadata: {}