metanorma-ogc 1.5.1 → 1.5.4.1

data/lib/isodoc/ogc/reqt.rb

@@ -114,7 +114,7 @@ module IsoDoc
 
       def preserve_in_nested_table?(node)
         return true if %w(recommendation requirement permission
-                          table).include?(node.name)
+                          table ol dl ul).include?(node.name)
 
         false
       end

data/lib/isodoc/ogc/sections.rb

@@ -20,7 +20,13 @@ module IsoDoc
       end
 
       def security(docxml, out)
-        f = docxml.at(ns("//preface/clause[@type = 'security']")) || return
+        f = docxml.at(ns("//preface/clause[@type = 'security']")) or return
+        intro_clause(f, out)
+      end
+
+      def executivesummary(docxml, out)
+        f = docxml.at(ns("//preface/clause[@type = 'executivesummary']")) or
+          return
         intro_clause(f, out)
       end
 
@@ -31,7 +37,8 @@ module IsoDoc
 
       def preface(isoxml, out)
         isoxml.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
-                        "@type = 'submitting_orgs' or @type = 'security')]"))
+                        "@type = 'submitting_orgs' or @type = 'security' or "\
+                        "@type = 'executivesummary')]"))
           .each do |f|
           intro_clause(f, out)
         end

data/lib/isodoc/ogc/word_convert.rb

@@ -86,7 +86,7 @@ module IsoDoc
                           <span lang="EN-GB"><span
         style='mso-element:field-begin'></span><span
         style='mso-spacerun:yes'>&#xA0;</span>TOC
-        \\h \\z \\t &quot;RecommendationTitle,recommendationtitle&quot;#{' '}
+        \\h \\z \\t &quot;RecommendationTitle,RecommendationTestTitle,recommendationtitle,recommendationtesttitle&quot;#{' '}
         <span style='mso-element:field-separator'></span></span>
       TOC
 
@@ -131,13 +131,37 @@ module IsoDoc
 
       def make_RecommendationWordToC(docxml)
         toc = ""
-        docxml.xpath("//p[@class = 'RecommendationTitle']").each do |h|
+        docxml.xpath("//p[@class = 'RecommendationTitle' or @class = 'RecommendationTestTitle']").sort_by do |h|
+          recommmendation_sort_key(h.text)
+        end.each do |h|
           toc += word_toc_entry(1, header_strip(h))
         end
         toc.sub(/(<p class="MsoToc1">)/,
                 %{\\1#{WORD_TOC_RECOMMENDATION_PREFACE1}}) + WORD_TOC_SUFFIX1
       end
 
+      def recommmendation_sort_key(header)
+        m = /^([^0-9]+) (\d+)/.match(header) || /^([^:]+)/.match(header)
+        "#{recommmendation_sort_key1(m[1])}::#{'%04d' % m[2].to_i}"
+      end
+
+      def recommmendation_sort_key1(type)
+        case type.downcase
+        when "requirements class" then "01"
+        when "recommendations class" then "02"
+        when "permissions class" then "03"
+        when "requirement" then "04"
+        when "recommendation" then "05"
+        when "permission" then "06"
+        when "conformance class" then "07"
+        when "abstract test" then "08"
+        when "requirements test" then "09"
+        when "recommendations test" then "10"
+        when "permissions test" then "11"
+        else "z"
+        end
+      end
+
       def make_body2(body, docxml)
         body.div **{ class: "WordSection2" } do |div2|
           @prefacenum = 0
@@ -145,6 +169,7 @@ module IsoDoc
           boilerplate docxml, div2
           preface_block docxml, div2
           abstract docxml, div2
+          executivesummary docxml, div2
           keywords docxml, div2
           foreword docxml, div2
           introduction docxml, div2
@@ -211,8 +236,7 @@ module IsoDoc
         @wordstylesheet = wordstylesheet_update
         Html2Doc.process(
           result,
-          filename: filename,
-          imagedir: @localdir,
+          filename: filename, imagedir: @localdir,
           stylesheet: @wordstylesheet&.path,
           header_file: header&.path, dir: dir,
           asciimathdelims: [@openmathdelim, @closemathdelim],

data/lib/isodoc/ogc/xref.rb

@@ -141,14 +141,16 @@ module IsoDoc
 
       def preface_anchor_names(doc)
         @prefacenum = 0
-        ["//preface/abstract", "//preface/clause[@type = 'keywords']",
+        ["//preface/abstract", "//preface/clause[@type = 'executivesummary']",
+         "//preface/clause[@type = 'keywords']",
          "//foreword", "//introduction", "//preface/clause[@type = 'security']",
          "//preface/clause[@type = 'submitting_orgs']",
          "//submitters"].each do |path|
           preface_names_numbered(doc.at(ns(path)))
         end
         doc.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
-                     "@type = 'submitting_orgs' or @type = 'security')]"))
+                     "@type = 'submitting_orgs' or @type = 'security' or "\
+                     "@type = 'executivesummary')]"))
           .each { |c| preface_names_numbered(c) }
         preface_names_numbered(doc.at(ns("//acknowledgements")))
         sequential_asset_names(

data/lib/metanorma/ogc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ogc
-    VERSION = "1.5.1".freeze
+    VERSION = "1.5.4.1".freeze
   end
 end

data/metanorma-ogc.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "iso-639"
   spec.add_dependency "metanorma-standoc", "~> 1.11.0"
 
-  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.4.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.11.0
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +195,6 @@ files:
 - Gemfile
 - LICENSE
 - README.adoc
-- README.adoc.old
 - Rakefile
 - bin/console
 - bin/rspec
@@ -287,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Metanorma for the Open Geospatial Consortium.

data/README.adoc.old

@@ -1,187 +0,0 @@
-= metanorma-ogc: Asciidoctor processor for Open Geospatial Consortium  documents
-
-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.com/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 gem processes documents following a template for generating OGC documents. 
-For http://asciidoctor.org/[Asciidoctor] input, the Metanorma toolchain uses the Asciidoctor gem as its parser.
-
-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
-
-The preferred way to invoke this gem is via the `metanorma` script:
-
-[source,console]
-----
-$ 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
-----
-
-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.
-
-The gem then converts the XML into HTML.
-
-The gem can also be invoked directly within asciidoctor, though this is deprecated:
-
-[source,console]
-----
-$ asciidoctor -b ogc -r 'metanorma-ogc' a.adoc  
-----
-
-=== 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. 
-Where these preexisting metanorma attributes correspond to attributes already used
-by OGC in their Asciidoctor template, they are treated as synonyms of the Metanorma
-attributes.  These include:
-
-`:edition:`:: The document version; e.g. `2.0`.
-
-`: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:
-+
---
-* Standards
-implementation-standard::: Implementation Standard (with or without Compliance Suite)
-abstract-specification::: Abstract Specification (with or without Compliance Suite)
-community-standard::: Community Standard (with or without Compliance Suite)
-profile::: Profile (with or without Compliance Suite)
-best-practices::: Best Practices Document
-* Other
-engineering-report::: Engineering Report
-discussion-paper::: Discussion Paper
-white-paper::: White Paper
-user-guide::: User Guide
-policy-directive::: Technical Committee Policy Directive
-informative::: Informative
---
-
-`:status:``:: The document status. The permitted types are: 
-
-* SWG Work
-* OAB Review
-* OGC-NA Review
-* Public Review
-* Prepare for Approval
-* TC Approval to Vote
-* TC Vote
-* PC Vote
-* Published
-
-`:committee:` (OGC: `:workingGroup:`):: The name of the relevant committee (mandatory)
-
-`:language:` :: The language of the document (only `en` for now)  (mandatory)
-
-`:published-date` (OGC: `:publicationDate:`):: The publication date for the document.
-`:issued-date` (OGC: `:approvalDate:`):: The approval date for the document.
-`:created-date`:: The creation date for the document.
-`:submitted-date` (OGC: `:submissionDate:`):: The date at which the document was submitted to the standards body.
-
-`:uri:`:: The URI to which this standard is published.
-`:docnumber:` (OGC: `docReference`):: The internal identifier referring to this document.
-
-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:
-
-`:external-id:`:: The external identifier referring to this document.
-`:referenceURLID:`:: The identifier embedded into a document type-specific
-external URL.
-
-`:fullname{_i}`:: The full name of a person who is a contributor to the document.
-A second person is indicated by using a numeric suffix: `:fullname`, `:fullname_2`, `fullname_3`, &c.
-
-`:surname{_i}`:: The surname of a person who is a contributor to the document.
-`:givenname{_i}`:: The given name(s) of a person who is a contributor to the document.
-`:role{_i}`:: The role of a a person who is a contributor to the document. By default,
-they are coded as an `editor`; they can also be represented as an `author`.
-
-OGC `:editor:`:: corresponds to `:fullname:` with `role` = "editor"
-
-== Examples
-
-* 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.
-