metanorma-itu 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7125f1d6d17254c0460f7398d24a43683b2099bc07f0cd7c483ce2725ab847b
-  data.tar.gz: bb3b19af63382c527698bdb6402cc314f6e0fd0dfd3e90e6fae6d64d6afe5918
+  metadata.gz: c4a8298c94b775bf0894357ab7885d198d4aad3da9893b45f610ff27cde287bc
+  data.tar.gz: 10411a7522e3bf6a4b4a523125b037fc75470d2bfa7918215742c81cae2d6a6b
 SHA512:
-  metadata.gz: 8637b27bbb50cc729c8be856154330a9cd6ba7fdd60dcc3eb5f3605609fd62384e266e92370178fc603585330522e38fdde42fed426eeab9c5237f2072945c5b
-  data.tar.gz: 8ae3568058d7a603c2f875eaaea6f507874249b4ed6bfafca084a220a416cf8186f0c48f6f12fe23b4545f3eddd7055fc7e5385892c250f21c5f38e114f2eea9
+  metadata.gz: 6c497e515e567f5b92710c254570562db5d9c99d5f1b7299e818f1d27d66e51dd676e9b37deb0cb82376db08a8a249dd711418addc17b5052d78c3bba69cd479
+  data.tar.gz: 0d691088240f6ff1fa63ecb92a8137e35d10d32d5e4d823695e3937c8caedc4e1837523ec4015de48088a439131391e69bddb4db18ffef7f0865765483f715bf

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,15 +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>"
+        unless x.at("//sections/clause[@type = 'scope']")
+          ins.previous =
+            "<clause type='scope' #{add_id}><title>#{@i18n.scope}</title><p>"\
+            "#{@i18n.clause_empty}</p></clause>"
         end
         x&.at("//sentinel")&.remove
       end
@@ -41,19 +47,16 @@ module Asciidoctor
           "<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>"
+          ins.previous = "<references #{add_id} normative='true'>"\
+            "<title>#{@i18n.normref}</title></references>"
         end
         x&.at("//sentinel")&.remove
       end
 
       def insert_terms(x)
-        ins =  x.at("//sections/clause/title[text() = 'Scope']/..")
+        ins =  x.at("//sections/clause[@type = 'scope']")
         unless x.at("//sections//terms")
-          ins.next = "<terms><title>Definitions</title><p>"\
-            "#{@labels['clause_empty']}</p></terms>"
+          ins.next = "<terms #{add_id}><title>#{@i18n.termsdef}</title></terms>"
         end
       end
 
@@ -61,19 +64,34 @@ module Asciidoctor
         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)
@@ -94,24 +112,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 +200,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

@@ -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,22 @@ 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"
-      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 +104,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/isodoc.rng

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,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
 

data/lib/isodoc/itu/base_convert.rb

@@ -1,5 +1,4 @@
 require "isodoc"
-require_relative "metadata"
 require "fileutils"
 require_relative "./ref.rb"
 require_relative "./xref.rb"
@@ -8,32 +7,13 @@ require_relative "./terms.rb"
 module IsoDoc
   module ITU
     module BaseConvert
-      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
-        super.merge(y)
-      end
-
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      end
-
-      def xref_init(lang, script, klass, labels, options)
-        @xrefs = Xref.new(lang, script, klass, labels,
-                          options.merge(hierarchical_assets: @hierarchical_assets))
-      end
-
       FRONT_CLAUSE = "//*[parent::preface]"\
         "[not(local-name() = 'abstract')]".freeze
 
       def preface(isoxml, out)
         isoxml.xpath(ns(FRONT_CLAUSE)).each do |c|
           title = c&.at(ns("./title"))
-          out.div **attr_code(id: c["id"]) do |s|
+          out.div **attr_code(clause_attrs(c)) do |s|
             clause_name(nil, title, s, class: "IntroTitle")
             c.elements.reject { |c1| c1.name == "title" }.each do |c1|
               parse(c1, s)
@@ -52,15 +32,8 @@ module IsoDoc
         ""
       end
 
-      def note_label(node)
-        n = @xrefs.get[node["id"]]
-        (n.nil? || n[:label].nil? || n[:label].empty?) and
-          return "#{@note_lbl} – "
-        l10n("#{@note_lbl} #{n[:label]} – ")
-      end
-
-      def prefix_container(container, linkend, _target)
-        l10n("#{linkend} #{@labels["in"]} #{@xrefs.anchor(container, :xref)}")
+      def note_delim
+        " – "
       end
 
       def ol_depth(node)
@@ -78,12 +51,7 @@ module IsoDoc
       def annex_name(annex, name, div)
         r_a = @meta.get[:doctype_original] == "recommendation-annex"
         div.h1 **{ class: r_a ? "RecommendationAnnex" : "Annex" } do |t|
-          t << "#{@xrefs.anchor(annex['id'], :label)} "
-          t.br
-          t.br
-          t.b do |b|
-            name&.children&.each { |c2| parse(c2, b) }
-          end
+          name&.children&.each { |c2| parse(c2, t) }
         end
         annex_obligation_subtitle(annex, div)
       end
@@ -91,34 +59,26 @@ module IsoDoc
       def annex_obligation_subtitle(annex, div)
         info = annex["obligation"] == "informative"
         div.p **{class: "annex_obligation" } do |p|
-          p << (info ? @inform_annex_lbl : @norm_annex_lbl).
+          p << (info ? @i18n.inform_annex : @i18n.norm_annex).
             sub(/%/, @meta.get[:doctype] || "")
         end
       end
 
       def annex(isoxml, out)
-      isoxml.xpath(ns("//annex")).each do |c|
-        @meta.get[:doctype_original] == "recommendation-annex" or
-          page_break(out)
-        out.div **attr_code(id: c["id"], class: "Section3") do |s|
-          annex_name(c, nil, s) unless c.at(ns("./title"))
-          c.elements.each do |c1|
-            if c1.name == "title" then annex_name(c, c1, s)
-            else
-              parse(c1, s)
+        isoxml.xpath(ns("//annex")).each do |c|
+          @meta.get[:doctype_original] == "recommendation-annex" or
+            page_break(out)
+          out.div **attr_code(id: c["id"], class: "Section3") do |s|
+            annex_name(c, nil, s) unless c.at(ns("./title"))
+            c.elements.each do |c1|
+              if c1.name == "title" then annex_name(c, c1, s)
+              else
+                parse(c1, s)
+              end
             end
           end
         end
       end
-    end
-
-      def i18n_init(lang, script)
-        super
-      end
-
-      def fileloc(loc)
-        File.join(File.dirname(__FILE__), loc)
-      end
 
       def cleanup(docxml)
         super
@@ -136,18 +96,26 @@ module IsoDoc
       end
 
       def term_cleanup(docxml)
+        term_cleanup1(docxml)
+        term_cleanup2(docxml)
+        docxml
+      end
+
+      def term_cleanup1(docxml)
         docxml.xpath("//p[@class = 'Terms']").each do |d|
           h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
           d.children.first.previous = "<b>#{h2.children.to_xml}</b>&nbsp;"
           d["id"] = h2["id"]
           h2.remove
         end
+      end
+
+      def term_cleanup2(docxml)
         docxml.xpath("//p[@class = 'TermNum']").each do |d|
           d1 = d.next_element and d1.name == "p" or next
           d1.children.each { |e| e.parent = d }
           d1.remove
         end
-        docxml
       end
 
       def refs_cleanup(docxml)
@@ -167,29 +135,6 @@ module IsoDoc
         super
       end
 
-      def get_eref_linkend(node)
-        l = anchor_linkend(node, docid_l10n(node["target"] || node["citeas"]))
-        l && !/^\[.*\]$/.match(l) and l = "[#{l}]"
-        l += eref_localities(node.xpath(ns("./locality | ./localityStack")), l)
-        contents = node.children.select do |c|
-          !%w{locality localityStack}.include? c.name
-        end
-        return l if contents.nil? || contents.empty?
-        Nokogiri::XML::NodeSet.new(node.document, contents).to_xml
-      end
-
-      def eref_parse(node, out)
-        linkend = get_eref_linkend(node)
-        href = eref_target(node)
-        if node["type"] == "footnote"
-          out.sup do |s|
-            s.a(**{ "href": href }) { |l| l << linkend }
-          end
-        else
-          out.a(**{ "href": href }) { |l| l << linkend }
-        end
-      end
-
       def middle_title(out)
         out.p(**{ class: "zzSTDTitle1" }) do |p|
           id = @meta.get[:docnumber] and p << "#{@meta.get[:doctype]} #{id}" 
@@ -221,9 +166,11 @@ module IsoDoc
       end
 
       def note_p_parse(node, div)
+        name = node&.at(ns("./name"))&.remove
         div.p do |p|
-          p.span **{ class: "note_label" } do |s|
-            s << note_label(node)
+          name and p.span **{ class: "note_label" } do |s|
+            name.children.each { |n| parse(n, s) }
+            s << note_delim
           end
           node.first_element_child.children.each { |n| parse(n, p) }
         end
@@ -231,9 +178,11 @@ module IsoDoc
       end
 
       def note_parse1(node, div)
+        name = node&.at(ns("./name"))&.remove
         div.p do |p|
-          p.span **{ class: "note_label" } do |s|
-            s << note_label(node)
+          name and p.span **{ class: "note_label" } do |s|
+            name.children.each { |n| parse(n, s) }
+            #s << note_delim
           end
         end
         node.children.each { |n| parse(n, div) }