metanorma-itu 1.1.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64bb790ac1dfa65f1a9f04584d0dd0ffd293c372df9b4812bc29501217bd1a4
-  data.tar.gz: efe01eee56939ed68f7dd70d846f6d54f1ec71903fa7509bc2f65764c5bb37d4
+  metadata.gz: ca92fde1a59224dabe1a60e9972946be9f5b4ee3a0ddc0b9d18b26d2ace7b070
+  data.tar.gz: c6ca6f1c6aab657534d9eba98a60ffccf57eff743b3f8d99601aee2706c47996
 SHA512:
-  metadata.gz: 6a43368112b086f151bbd595a1a48d33563d7dba21435d1a16d78e3d21f2cd7c18a7ea1b22c4e3a3bef9cdb518e3e51207179df5e49a862bf9312bda2eaad72f
-  data.tar.gz: 57c8ef4499538f54207e74757834138aa515c2f4100ed546824f2ed44d416d9908a301afcbce1d8636e926d6b5a04d128467128ce3cc68956da58350d0622c34
+  metadata.gz: e465d057bb288694d8ebb48c2e123df2cbea58b9a434fe033d9e41c5077eb00a027ae6a7ecfa653f416403510bed79cc3d4df1d438af0e4aa6eca8501175bf4d
+  data.tar.gz: f9c3be01cb4ade45f54f4aaba89dbdd3d4a03f53fb978c2bf1bb985587f5f4000c5dbea23042bf41a3037ec82ce6da0984b85f434c5e9f0d712017f56230819e

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/asciidoctor/itu/cleanup.rb

@@ -4,6 +4,7 @@ module Asciidoctor
       def sections_cleanup(x)
         super
         insert_missing_sections(x) unless @no_insert_missing_sections
+        insert_empty_clauses(x)
       end
 
       def table_cleanup(xmldoc)
@@ -22,16 +23,20 @@ module Asciidoctor
         insert_conventions(x)
       end
 
+      def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
       def insert_scope(x)
         x.at("./*/sections") or
           x.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
           "<sections><sentinel/></sections>"
         x.at("./*/sections/*") or x.at("./*/sections") << "<sentinel/>"
         ins = x.at("//sections").elements.first
-        unless x.at("//sections/clause/title[text() = 'Scope']")
-          ins.previous = "<clause><title>Scope</title><p>"\
-            "#{@labels['clause_empty']}</p></clause>"
-        end
+        x.at("//sections/clause[@type = 'scope']") or
+          ins.previous =
+            "<clause type='scope' #{add_id}><title>#{@i18n.scope}</title><p>"\
+            "#{@i18n.clause_empty}</p></clause>"
         x&.at("//sentinel")&.remove
       end
 
@@ -40,42 +45,52 @@ module Asciidoctor
           x.at("./*/annex[last()] | ./*/sections").next =
           "<bibliography><sentinel/></bibliography>"
         ins = x.at("//bibliography").elements.first
-        unless x.at("//bibliography/references[@normative = 'true']")
-          #ins.previous = "<references normative='true'><title>References</title><p>"\
-          #  "#{@labels['clause_empty']}</p></references>"
-          ins.previous = "<references normative='true'><title>References</title>"\
-            "</references>"
-        end
+        x.at("//bibliography/references[@normative = 'true']") or
+          ins.previous = "<references #{add_id} normative='true'>"\
+          "<title>#{@i18n.normref}</title></references>"
         x&.at("//sentinel")&.remove
       end
 
       def insert_terms(x)
-        ins =  x.at("//sections/clause/title[text() = 'Scope']/..")
-        unless x.at("//sections//terms")
-          ins.next = "<terms><title>Definitions</title><p>"\
-            "#{@labels['clause_empty']}</p></terms>"
-        end
+        ins =  x.at("//sections/clause[@type = 'scope']")
+        x.at("//sections//terms") or
+          ins.next = "<terms #{add_id}><title>#{@i18n.termsdef}</title></terms>"
       end
 
       def insert_symbols(x)
         ins =  x.at("//sections/terms") ||
           x.at("//sections/clause[descendant::terms]")
         unless x.at("//sections//definitions")
-          ins.next = "<definitions><title>Abbreviations and acronyms</title><p>"\
-            "#{@labels['clause_empty']}</p></definitions>"
+          ins.next = "<definitions #{add_id}>"\
+            "<title>#{@i18n.symbolsabbrev}</title></definitions>"
         end
       end
 
       def insert_conventions(x)
         ins =  x.at("//sections//definitions") ||
           x.at("//sections/clause[descendant::definitions]")
-        unless x.at("//sections/clause/title[text() = 'Conventions']")
-          ins.next = "<clause id='_#{UUIDTools::UUID.random_create}'>"\
-            "<title>Conventions</title><p>"\
-            "#{@labels['clause_empty']}</p></clause>"
+        unless x.at("//sections/clause[@type = 'conventions']")
+          ins.next = "<clause #{add_id} type='conventions'>"\
+            "<title>#{@i18n.conventions}</title><p>"\
+            "#{@i18n.clause_empty}</p></clause>"
+        end
+      end
+
+      def insert_empty_clauses(x)
+        x.xpath("//terms[not(./term)][not(.//terms)]").each do |c|
+          insert_empty_clauses1(c, @i18n.clause_empty)
+        end
+        x.xpath("//definitions[not(./dl)]").each do |c|
+          insert_empty_clauses1(c, @i18n.clause_empty)
         end
       end
 
+      def insert_empty_clauses1(c, text)
+        c.at("./p") and return
+        ins = c.at("./title") or return
+        ins.next = "<p>#{text}</p>"
+      end
+
       def cleanup(xmldoc)
         symbols_cleanup(xmldoc)
         super
@@ -94,24 +109,46 @@ module Asciidoctor
         xmldoc
       end
 
-      def termdef_cleanup(xmldoc)
-        xmldoc.xpath("//term/preferred").each do |p|
-          if ["terms defined elsewhere",
-              "terms defined in this recommendation"].include? p.text.downcase
-            p.name = "title"
-            p.parent.name = "terms"
-          end
-        end
-        super
+      def termdef_boilerplate_cleanup(xmldoc)
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
+      def terms_extract(div)
+        internal = div.at("./terms[@type = 'internal']/title")
+        external = div.at("./terms[@type = 'external']/title")
+        [internal, external]
+      end
+
+      def term_defs_boilerplate(div, source, term, preface, isodoc)
+        internal, external = terms_extract(div.parent)
+        internal&.next_element&.name == "term" and
+          internal.next = "<p>#{@i18n.internal_terms_boilerplate}</p>"
+        internal and internal&.next_element == nil and
+          internal.next = "<p>#{@i18n.no_terms_boilerplate}</p>"
+        external&.next_element&.name == "term" and
+          external.next = "<p>#{@i18n.external_terms_boilerplate}</p>"
+        external and external&.next_element == nil and
+          external.next = "<p>#{@i18n.no_terms_boilerplate}</p>"
+        !internal and !external and
+          %w(term terms).include? div&.next_element&.name and
+          div.next = "<p>#{@i18n.term_def_boilerplate}</p>"
+      end
+
+      def section_names_terms_cleanup(x)
+        super
+        replace_title(
+          x, "//terms[@type = 'internal'] | "\
+          "//clause[./terms[@type = 'internal']][not(./terms[@type = 'external'])]", 
+          @i18n&.internal_termsdef)
+        replace_title(
+          x, "//terms[@type = 'external'] | "\
+          "//clause[./terms[@type = 'external']][not(./terms[@type = 'internal'])]", 
+          @i18n&.external_termsdef)
       end
 
       def symbols_cleanup(xmldoc)
         sym = xmldoc.at("//definitions/title")
         sym and sym&.next_element&.name == "dl" and
-          sym.next = "<p>#{@symbols_boilerplate}</p>"
+          sym.next = "<p>#{@i18n.symbols_boilerplate}</p>"
       end
 
       PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
@@ -160,13 +197,6 @@ module Asciidoctor
           biblio_reorder1(r)
         end
       end
-
-      def normref_cleanup(xmldoc)
-        super
-        r = xmldoc.at(NORM_REF) || return
-        title = r.at("./title") and
-          title.content = "References"
-      end
     end
   end
 end

data/lib/asciidoctor/itu/converter.rb

@@ -39,7 +39,7 @@ module Asciidoctor
       end
 
       def doctype(node)
-        ret = node.attr("doctype") || "recommendation"
+        ret = super || "recommendation"
         ret = "recommendation" if ret == "article"
         ret
       end
@@ -56,9 +56,12 @@ module Asciidoctor
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+        html_converter(node).convert(@filename + ".presentation.xml", 
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert(@filename + ".presentation.xml", 
+                                    nil, false, "#{@filename}.doc")
+        pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                     nil, false, "#{@filename}.pdf")
       end
 
       def validate(doc)
@@ -76,56 +79,32 @@ module Asciidoctor
         when "definitions" then "terms and definitions"
         when "abbreviations and acronyms" then "symbols and abbreviated terms"
         when "references" then "normative references"
+        when "terms defined elsewhere" then "terms and definitions"
+        when "terms defined in this recommendation" then "terms and definitions"
         else
           super
         end
       end
 
-      def term_def_title(toplevel, node)
-        return node.title unless toplevel
-        "Definitions"
+      def sectiontype(node, level = true)
+        ret = super
+        hdr = sectiontype_streamline(node&.attr("heading")&.downcase)
+        return nil if ret == "terms and definitions" && 
+          hdr != "terms and definitions" && node.level > 1
+        return nil if ret == "symbols and abbreviated terms" && 
+          hdr != "symbols and abbreviated terms" && node.level > 1
+        ret
       end
 
-      def terms_extract(div)
-        internal = nil
-        external = nil
-        div.parent.xpath("./terms/title").each do |t|
-          case t&.text&.downcase
-          when "terms defined elsewhere" then external = t
-          when "terms defined in this recommendation" then internal = t
-          end
+      def term_def_subclause_parse(attrs, xml, node)
+        case clausetype = sectiontype1(node)
+        when "terms defined in this recommendation"
+          term_def_parse(attrs.merge(type: "internal"), xml, node, false)
+        when "terms defined elsewhere"
+          term_def_parse(attrs.merge(type: "external"), xml, node, false)
+        else
+          super
         end
-        [internal, external]
-      end
-
-      def term_defs_boilerplate(div, source, term, preface, isodoc)
-        internal, external = terms_extract(div)
-        internal&.next_element&.name == "term" and
-          internal.next = "<p>#{@internal_terms_boilerplate}</p>"
-        internal and internal&.next_element == nil and
-          internal.next = "<p>#{@no_terms_boilerplate}</p>"
-        external&.next_element&.name == "term" and
-          external.next = "<p>#{@external_terms_boilerplate}</p>"
-        external and external&.next_element == nil and
-          external.next = "<p>#{@no_terms_boilerplate}</p>"
-        !internal and !external and
-          %w(term terms).include? div&.next_element&.name and
-          div.next = "<p>#{@term_def_boilerplate}</p>"
-      end
-
-      def load_yaml(lang, script)
-        y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            elsif lang == "en"
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            else
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            end
-        @symbols_boilerplate = y["symbols_boilerplate"] || ""
-        super.merge(y)
-      end
-
-      def i18n_init(lang, script)
-        super
       end
 
       def metadata_keywords(node, xml)
@@ -135,6 +114,17 @@ module Asciidoctor
         end
       end
 
+      def clause_parse(attrs, xml, node)
+        case clausetype = sectiontype1(node)
+        when "conventions" then attrs = attrs.merge(type: "conventions")
+        when "history" 
+          attrs[:preface] and attrs = attrs.merge(type: "history")
+        when "source" 
+          attrs[:preface] and attrs = attrs.merge(type: "source")
+        end
+        super
+      end
+
       def html_extract_attributes(node)
         super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
       end

data/lib/asciidoctor/itu/front.rb

@@ -64,24 +64,8 @@ module Asciidoctor
         end
       end
 
-      def metadata_author(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "author" }
-          c.organization do |a|
-            a.name "International Telecommunication Union"
-            a.abbreviation "ITU"
-          end
-        end
-      end
-
-      def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "International Telecommunication Union"
-            a.abbreviation "ITU"
-          end
-        end
+      def default_publisher
+        "International Telecommunication Union"
       end
 
       def metadata_committee(node, xml)
@@ -149,19 +133,6 @@ module Asciidoctor
         xml.docnumber { |i| i << node.attr("docnumber") }
       end
 
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "International Telecommunication Union"
-              o.abbreviation "ITU"
-            end
-          end
-        end
-      end
-
       def metadata_series(node, xml)
         node.attr("series") and
           xml.series **{ type: "main" } do |s|

data/lib/asciidoctor/itu/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -922,6 +925,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +967,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +995,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1017,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1045,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1186,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/itu/validate.rb

@@ -12,13 +12,16 @@ module Asciidoctor
         recommendation-corrigendum recommendation-errata recommendation-annex 
         focus-group implementers-guide technical-paper technical-report 
         joint-itu-iso-iec).include? doctype or
-        @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
+        @log.add("Document Attributes", nil, 
+                 "#{doctype} is not a recognised document type")
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
-        %w(in-force superseded in-force-prepublished withdrawn draft).include? stage or
-          @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
+        %w(in-force superseded in-force-prepublished withdrawn 
+        draft).include? stage or
+          @log.add("Document Attributes", nil, 
+                   "#{stage} is not a recognised status")
       end
 
       def content_validate(doc)
@@ -38,7 +41,8 @@ module Asciidoctor
         xmldoc.xpath("//bibdata/series/title").each do |s|
           series = s.text.sub(/^[A-Z]: /, "")
           t.downcase.include?(series.downcase) and
-            @log.add("Document Attributes", nil, "Title includes series name #{series}")
+            @log.add("Document Attributes", nil, 
+                     "Title includes series name #{series}")
         end
       end
 
@@ -56,7 +60,8 @@ module Asciidoctor
         xmldoc.xpath("//preface/*").each do |c|
           extract_text(c).split(/\.\s+/).each do |t|
             /\b(shall|must)\b/i.match(t) and
-              @log.add("Style", c, "Requirement possibly in preface: #{t.strip}")
+              @log.add("Style", c, 
+                       "Requirement possibly in preface: #{t.strip}")
           end
         end
       end
@@ -86,20 +91,24 @@ module Asciidoctor
       end
 
       def approval_validate(xmldoc)
-        s = xmldoc.at("//bibdata/ext/recommendationstatus/approvalstage") || return
+        s = xmldoc.at("//bibdata/ext/recommendationstatus/approvalstage") or
+          return
         process = s["process"]
         if process == "aap" and %w(determined in-force).include? s.text
-          @log.add("Document Attributes", nil, "Recommendation Status #{s.text} inconsistent with AAP")
+          @log.add("Document Attributes", nil, 
+                   "Recommendation Status #{s.text} inconsistent with AAP")
         end
         if process == "tap" and !%w(determined in-force).include? s.text
-          @log.add("Document Attributes", nil, "Recommendation Status #{s.text} inconsistent with TAP")
+          @log.add("Document Attributes", nil, 
+                   "Recommendation Status #{s.text} inconsistent with TAP")
         end
       end
 
       def itu_identifier_validate(xmldoc)
         s = xmldoc.xpath("//bibdata/docidentifier[@type = 'ITU']").each do |x|
           /^ITU-[RTF] [AD-VX-Z]\.[0-9]+$/.match(x.text) or
-            @log.add("Style", nil, "#{x.text} does not match ITU document identifier conventions")
+            @log.add("Style", nil, "#{x.text} does not match ITU document "\
+                     "identifier conventions")
         end
       end
 
@@ -121,8 +130,10 @@ module Asciidoctor
           para = t.at("./definition") || return
           term = t.at("./preferred").text
           termdef_warn(term, /^[A-Z][a-z]+/, t, term, "term is not lowercase")
-          termdef_warn(para.text, /^[a-z]/, t, term, "term definition does not start with capital")
-          termdef_warn(para.text, /[^.]$/, t, term, "term definition does not end with period")
+          termdef_warn(para.text, /^[a-z]/, t, term, 
+                       "term definition does not start with capital")
+          termdef_warn(para.text, /[^.]$/, t, term, 
+                       "term definition does not end with period")
         end
       end