metanorma-ogc 2.3.7 → 2.3.9

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -5,12 +5,25 @@ require_relative "../../relaton/render/general"
 module IsoDoc
   module Ogc
     class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
       def convert1(docxml, filename, dir)
         info docxml, nil
-        insert_preface_sections(docxml)
         super
       end
 
+      def rouge_css_location
+        File.read(File.join(@libdir, "html", "rouge.css"))
+      end
+
+      def preface_rearrange(doc)
+        super
+        insert_preface_sections(doc)
+      end
+
       def insert_preface_sections(doc)
         preface_insert(doc.at(ns("//preface/clause" \
                                  "[@type = 'executivesummary']")),
@@ -30,8 +43,7 @@ module IsoDoc
       end
 
       def preface_insert(clause, after, docxml)
-        return unless clause
-
+        clause or return
         clause.remove
         if after then after.next = clause
         else
@@ -117,9 +129,9 @@ module IsoDoc
       end
 
       def clause1(elem)
-        return if elem.name == "terms" && elem.parent.name == "annex" &&
-          elem.parent.xpath(ns("./terms")).size == 1
-
+        elem.name == "terms" && elem.parent.name == "annex" &&
+          elem.parent.xpath(ns("./terms")).size == 1 and return
+        elem.name == "clause" && elem["type"] == "toc" and return
         super
       end
 
@@ -215,6 +227,14 @@ module IsoDoc
         prefix_bracketed_ref("#{ret}#{datefn}")
       end
 
+      def deprecates(elem)
+        elem << "&#xa0;<span class='AdmittedLabel'>#{@i18n.deprecated}</span>"
+      end
+
+      def admits(elem)
+        elem << "&#xa0;<span class='AdmittedLabel'>#{@i18n.admitted}</span>"
+      end
+
       include Init
     end
   end

data/lib/isodoc/ogc/sections.rb

@@ -1,70 +1,70 @@
 module IsoDoc
   module Ogc
     module BaseConvert
-      def intro_clause(elem, out)
-        out.div **{ class: "Section3", id: elem["id"] } do |div|
-          clause_name(elem, elem&.at(ns("./title")), div, class: "IntroTitle")
-          elem.elements.each { |e| parse(e, div) unless e.name == "title" }
+      def front(isoxml, out)
+        p = isoxml.at(ns("//preface")) or return
+        p.elements.each do |e|
+          if is_clause?(e.name)
+            case e.name
+            when "abstract" then abstract e, out
+            when "foreword" then foreword e, out
+            when "introduction" then introduction e, out
+            when "submitters" then intro_clause e, out
+            when "clause" then preface e, out
+            when "acknowledgements" then acknowledgements e, out
+            end
+          else
+            preface_block(e, out)
+          end
         end
       end
 
-      def keywords(docxml, out)
-        f = docxml.at(ns("//preface/clause[@type = 'keywords']")) || return
-        intro_clause(f, out)
-      end
-
-      def submittingorgs(docxml, out)
-        f = docxml.at(ns("//preface/clause[@type = 'submitting_orgs']")) or
-          return
-        intro_clause(f, out)
-      end
-
-      def security(docxml, out)
-        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
-
-      def submitters(docxml, out)
-        f = docxml.at(ns("//submitters")) || return
-        intro_clause(f, out)
+      def preface(clause, out)
+        case clause["type"]
+        when "toc"
+          table_of_contents(clause, out)
+        when "executivesummary", "security", "submitting_orgs",
+          "keywords"
+          intro_clause(clause, out)
+        else
+          intro_clause(clause, out)
+        end
       end
 
-      def preface(isoxml, out)
-        isoxml.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
-                        "@type = 'submitting_orgs' or @type = 'security' or "\
-                        "@type = 'executivesummary')]"))
-          .each do |f|
-          intro_clause(f, out)
+      def intro_clause(elem, out)
+        out.div class: "Section3", id: elem["id"] do |div|
+          clause_name(elem, elem&.at(ns("./title")), div,
+                      class: "IntroTitle")
+          elem.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
         end
       end
 
-      def abstract(isoxml, out)
-        f = isoxml.at(ns("//preface/abstract")) || return
+      def abstract(clause, out)
         page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          clause_name(f, f&.at(ns("./title")), s, class: "AbstractTitle")
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        out.div **attr_code(id: clause["id"]) do |s|
+          clause_name(clause, clause.at(ns("./title")), s,
+                      class: "AbstractTitle")
+          clause.elements.each do |e|
+            parse(e, s) unless e.name == "title"
+          end
         end
       end
 
-      def foreword(isoxml, out)
-        f = isoxml.at(ns("//foreword")) || return
+      def foreword(clause, out)
         page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          clause_name(f, f&.at(ns("./title")), s, class: "ForewordTitle")
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        out.div **attr_code(id: clause["id"]) do |s|
+          clause_name(clause, clause&.at(ns("./title")), s,
+                      class: "ForewordTitle")
+          clause.elements.each do |e|
+            parse(e, s) unless e.name == "title"
+          end
         end
       end
 
-      def acknowledgements(isoxml, out)
-        f = isoxml.at(ns("//acknowledgements")) || return
-        intro_clause(f, out)
+      def acknowledgements(clause, out)
+        intro_clause(clause, out)
       end
 
       def conformance(isoxml, out, num)

data/lib/isodoc/ogc/word_convert.rb

@@ -91,6 +91,8 @@ module IsoDoc
           @prefacenum = 0
           info docxml, div2
           boilerplate docxml, div2
+          front docxml, div2
+=begin
           preface_block docxml, div2
           abstract docxml, div2
           executivesummary docxml, div2
@@ -102,6 +104,7 @@ module IsoDoc
           submitters docxml, div2
           preface docxml, div2
           acknowledgements docxml, div2
+=end
           div2.p { |p| p << "&#xA0;" } # placeholder
         end
         section_break(body)

data/lib/isodoc/ogc/xref.rb

@@ -31,7 +31,7 @@ module IsoDoc
         end
         doc.xpath(ns("//preface/clause[not(@type = 'keywords' or " \
                      "@type = 'submitting_orgs' or @type = 'security' or " \
-                     "@type = 'executivesummary')]"))
+                     "@type = 'executivesummary' or @type = 'toc')]"))
           .each { |c| preface_names_numbered(c) }
         preface_names_numbered(doc.at(ns("//acknowledgements")))
         sequential_asset_names(
@@ -93,6 +93,17 @@ module IsoDoc
 
         @anchors[ref["id"]] = { xref: "#{@anchors[ref['id']][:xref]} (draft)" }
       end
+
+      def sequential_permission_body(id, block, label, klass, model)
+        @anchors[block["id"]] = model.postprocess_anchor_struct(
+          block, anchor_struct(id, nil,
+                               label, klass, block["unnumbered"])
+        )
+        model.permission_parts(block, id, label, klass).each do |n|
+          @anchors[n[:id]] = anchor_struct(n[:number], nil, n[:label],
+                                           n[:klass], false)
+        end
+      end
     end
   end
 end

data/lib/metanorma/ogc/isodoc.rng

@@ -17,6 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
+<!-- VERSION v1.2.1 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -382,6 +383,9 @@
         <optional>
           <ref name="dl"/>
         </optional>
+        <optional>
+          <ref name="source"/>
+        </optional>
       </element>
     </define>
     <define name="figure">
@@ -404,9 +408,6 @@
           <attribute name="class"/>
         </optional>
         <ref name="BlockAttributes"/>
-        <optional>
-          <ref name="source"/>
-        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -431,6 +432,20 @@
         <zeroOrMore>
           <ref name="note"/>
         </zeroOrMore>
+        <optional>
+          <ref name="source"/>
+        </optional>
+      </element>
+    </define>
+    <define name="source">
+      <element name="source">
+        <attribute name="status">
+          <ref name="SourceStatusType"/>
+        </attribute>
+        <ref name="origin"/>
+        <optional>
+          <ref name="modification"/>
+        </optional>
       </element>
     </define>
     <define name="sourcecode">
@@ -1335,15 +1350,19 @@
       </choice>
     </element>
   </define>
+  <define name="Root-Attributes">
+    <attribute name="version"/>
+    <attribute name="schema-version"/>
+    <attribute name="type">
+      <choice>
+        <value>semantic</value>
+        <value>presentation</value>
+      </choice>
+    </attribute>
+  </define>
   <define name="standard-document">
     <element name="standard-document">
-      <attribute name="version"/>
-      <attribute name="type">
-        <choice>
-          <value>semantic</value>
-          <value>presentation</value>
-        </choice>
-      </attribute>
+      <ref name="Root-Attributes"/>
       <ref name="bibdata"/>
       <optional>
         <ref name="misccontainer"/>
@@ -2099,10 +2118,7 @@
   <define name="termsource">
     <element name="termsource">
       <attribute name="status">
-        <choice>
-          <value>identical</value>
-          <value>modified</value>
-        </choice>
+        <ref name="SourceStatusType"/>
       </attribute>
       <attribute name="type">
         <choice>
@@ -2116,6 +2132,17 @@
       </optional>
     </element>
   </define>
+  <define name="SourceStatusType">
+    <choice>
+      <value>identical</value>
+      <value>modified</value>
+      <value>restyled</value>
+      <value>context-added</value>
+      <value>generalisation</value>
+      <value>specialisation</value>
+      <value>unspecified</value>
+    </choice>
+  </define>
   <define name="origin">
     <element name="origin">
       <choice>

data/lib/metanorma/ogc/ogc.rng

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns="https://www.metanorma.org/ns/ogc" xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns='https://www.metanorma.org/ns/ogc' xmlns="http://relaxng.org/ns/structure/1.0">
   <!--
+    VERSION v1.2.1
     Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
     we cannot have a new default namespace: we will end up with a grammar with two different
     namespaces, one for isostandard and one for csand additions. And we do not want that.
@@ -45,13 +46,7 @@
   </define>
   <define name="ogc-standard">
     <element name="ogc-standard">
-      <attribute name="version"/>
-      <attribute name="type">
-        <choice>
-          <value>semantic</value>
-          <value>presentation</value>
-        </choice>
-      </attribute>
+      <ref name="Root-Attributes"/>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/metanorma/ogc/validate.rb

@@ -2,6 +2,7 @@ module Metanorma
   module Ogc
     class Converter < Standoc::Converter
       def validate(doc)
+        @doctype = doc.at("//bibdata/ext/doctype")&.text
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup),
                         File.join(File.dirname(__FILE__), "ogc.rng"))
@@ -22,12 +23,13 @@ module Metanorma
       end
 
       def stage_validate(xmldoc)
+        @doctype == "engineering-report" and return
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(draft swg-draft oab-review public-rfc tc-vote work-item-draft
            approved deprecated retired rescinded).include? stage or
           @log.add("Document Attributes", nil,
                    "#{stage} is not a recognised status")
-        stage_type_validate(stage, xmldoc&.at("//bibdata/ext/doctype")&.text)
+        stage_type_validate(stage, @doctype)
       end
 
       def stage_type_validate(stage, doctype)
@@ -47,23 +49,21 @@ module Metanorma
 
       def version_validate(xmldoc)
         version = xmldoc.at("//bibdata/edition")&.text
-        doctype = xmldoc.at("//bibdata/ext/doctype")&.text
-        if %w(engineering-report discussion-paper).include? doctype
+        if %w(engineering-report discussion-paper).include? @doctype
           version.nil? or @log.add("Document Attributes", nil,
-                                   "Version not permitted for #{doctype}")
+                                   "Version not permitted for #{@doctype}")
         else
           version.nil? and @log.add("Document Attributes", nil,
-                                    "Version required for #{doctype}")
+                                    "Version required for #{@doctype}")
         end
       end
 
       def execsummary_validate(xmldoc)
-        doctype = xmldoc.at("//bibdata/ext/doctype")&.text
         sect = xmldoc.at("//clause[@type = 'executivesummary']")
-        doctype == "engineering-report" && sect.nil? and
+        @doctype == "engineering-report" && sect.nil? and
           @log.add("Style", nil,
                    "Executive Summary required for Engineering Reports!")
-        doctype != "engineering-report" && !sect.nil? and
+        @doctype != "engineering-report" && !sect.nil? and
           @log.add("Style", nil,
                    "Executive Summary only allowed for Engineering Reports!")
       end
@@ -109,9 +109,7 @@ module Metanorma
       end
 
       def sections_sequence_validate(root)
-        return unless STANDARDTYPE.include?(
-          root.at("//bibdata/ext/doctype")&.text,
-        )
+        return unless STANDARDTYPE.include?(@doctype)
 
         names = root.xpath("//sections/* | //bibliography/*")
         names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
@@ -132,6 +130,7 @@ module Metanorma
       end
 
       def preface_sequence_validate(root)
+        @doctype == "engineering-report" and return
         root.at("//preface/abstract") or @log.add("Style", nil,
                                                   "Abstract is missing!")
         root.at("//bibdata/keyword | //bibdata/ext/keyword") or
@@ -144,6 +143,14 @@ module Metanorma
         root.at("//submitters") or @log.add("Style", nil,
                                             "Submitters is missing!")
       end
+
+      def norm_ref_validate(doc)
+        @doctype == "engineering-report" or return super
+        doc.xpath("//references[@normative = 'true']").each do |b|
+          @log.add("Bibliography", b,
+                   "Engineering report should not contain normative references")
+        end
+      end
     end
   end
 end

data/lib/metanorma/ogc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ogc
-    VERSION = "2.3.7".freeze
+    VERSION = "2.3.9".freeze
   end
 end

data/metanorma-ogc.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "iso-639"
-  spec.add_dependency "metanorma-standoc", "~> 2.4.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.4.2"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ogc
 version: !ruby/object:Gem::Version
-  version: 2.3.7
+  version: 2.3.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso-639
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +238,8 @@ files:
 - lib/isodoc/ogc/html/ogc.scss
 - lib/isodoc/ogc/html/ogc_wp.css
 - lib/isodoc/ogc/html/ogc_wp.scss
+- lib/isodoc/ogc/html/preprocess.xslt
+- lib/isodoc/ogc/html/rouge.css
 - lib/isodoc/ogc/html/scripts.html
 - lib/isodoc/ogc/html/word_ogc_intro.html
 - lib/isodoc/ogc/html/word_ogc_intro_wp.html