metanorma-itu 1.3.7 → 1.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ca33e71c52b4abfd8da601d6a7138fee1b2f9f8635fd6c2f59873dbdce25874
-  data.tar.gz: 8300592013092cffc941fa2c391cab8d26186c54ca76534a50009c88a469a9d1
+  metadata.gz: ad435d6188b9f2e881c84f0d43a6c35fd2bb4d6c993d1d796b830f755a2d3e33
+  data.tar.gz: 95409047e659d65a1c4b0102ebf910d69fe062ab4731511060625ed78ddb362c
 SHA512:
-  metadata.gz: ae3b8e20958c4af55882f7042f7501d89a78435262beff085b445879eccc4fcff6124bb56c70761b68d355147ae016d4e2f1d99218e9db54efb5c161ebcc2f19
-  data.tar.gz: 8beff7d2981d2403465f2304520dea41883ed868947e5ed42b5cc86a844c8be77845dd0ef16bb9ee073f963770db742b6a8d47d67339650dcac60f039d5cea6c
+  metadata.gz: 8a3db12e7809503cd242cb1c1f3b6d1b1a579ebbed62fb7ba91c357bdc264b601aefa5e64dee6c0aa2d3cf0a2afd2a01c5e6f43c98343dbc5d0b742aa3472c96
+  data.tar.gz: bd64d897084265a9be463d56dcf31dde685b7e36ab56f75016d89d2ad7dc486816e393557c8c84a013e4fd06567c4b8ce4ffcd695d15597ada66b12295f5c006

data/lib/asciidoctor/itu/cleanup.rb

@@ -1,17 +1,19 @@
 module Asciidoctor
   module ITU
     class Converter < Standoc::Converter
-      def sections_cleanup(x)
+      def sections_cleanup(xml)
         super
-        insert_missing_sections(x) unless @no_insert_missing_sections
-        insert_empty_clauses(x)
-        resolution_inline_header(x)
+        insert_missing_sections(xml) unless @no_insert_missing_sections
+        insert_empty_clauses(xml)
+        resolution_inline_header(xml)
       end
 
-      def resolution_inline_header(x)
-        return unless x&.at("//bibdata/ext/doctype")&.text == "resolution"
-        x.xpath("//clause//clause").each do |c|
-          next if title = c.at("./title") and !title&.text&.empty?
+      def resolution_inline_header(xml)
+        return unless xml&.at("//bibdata/ext/doctype")&.text == "resolution"
+
+        xml.xpath("//clause//clause").each do |c|
+          next if (title = c.at("./title")) && !title&.text&.empty?
+
           c["inline-header"] = true
         end
       end
@@ -36,67 +38,67 @@ module Asciidoctor
         %(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
-        x.at("//sections/clause[@type = 'scope']") or
+      def insert_scope(xml)
+        xml.at("./*/sections") or
+          xml.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
+            "<sections><sentinel/></sections>"
+        xml.at("./*/sections/*") or xml.at("./*/sections") << "<sentinel/>"
+        ins = xml.at("//sections").elements.first
+        xml.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
+        xml&.at("//sentinel")&.remove
       end
 
-      def insert_norm_ref(x)
-        x.at("//bibliography") or
-          x.at("./*/annex[last()] | ./*/sections").next =
-          "<bibliography><sentinel/></bibliography>"
-        ins = x.at("//bibliography").elements.first
-        x.at("//bibliography/references[@normative = 'true']") or
+      def insert_norm_ref(xml)
+        xml.at("//bibliography") or
+          xml.at("./*/annex[last()] | ./*/sections").next =
+            "<bibliography><sentinel/></bibliography>"
+        ins = xml.at("//bibliography").elements.first
+        xml.at("//bibliography/references[@normative = 'true']") or
           ins.previous = "<references #{add_id} normative='true'>"\
-          "<title>#{@i18n.normref}</title></references>"
-        x&.at("//sentinel")&.remove
+                         "<title>#{@i18n.normref}</title></references>"
+        xml&.at("//sentinel")&.remove
       end
 
-      def insert_terms(x)
-        ins =  x.at("//sections/clause[@type = 'scope']")
-        x.at("//sections//terms") or
+      def insert_terms(xml)
+        ins = xml.at("//sections/clause[@type = 'scope']")
+        xml.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")
+      def insert_symbols(xml)
+        ins =  xml.at("//sections/terms") ||
+          xml.at("//sections/clause[descendant::terms]")
+        unless xml.at("//sections//definitions")
           ins.next = "<definitions #{add_id}>"\
-            "<title>#{@i18n.symbolsabbrev}</title></definitions>"
+                     "<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[@type = 'conventions']")
+      def insert_conventions(xml)
+        ins =  xml.at("//sections//definitions") ||
+          xml.at("//sections/clause[descendant::definitions]")
+        unless xml.at("//sections/clause[@type = 'conventions']")
           ins.next = "<clause #{add_id} type='conventions'>"\
-            "<title>#{@i18n.conventions}</title><p>"\
-            "#{@i18n.clause_empty}</p></clause>"
+                     "<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|
+      def insert_empty_clauses(xml)
+        xml.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|
+        xml.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
+      def insert_empty_clauses1(clause, text)
+        clause.at("./p") and return
+        ins = clause.at("./title") or return
         ins.next = "<p>#{text}</p>"
       end
 
@@ -114,14 +116,14 @@ module Asciidoctor
           next unless n.text?
 
           n.replace(HTMLEntities.new.encode(
-            n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
-            gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
+                      n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'")
+                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic
+                    ))
         end
         xmldoc
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-      end
+      def termdef_boilerplate_cleanup(xmldoc); end
 
       def terms_extract(div)
         internal = div.at("./terms[@type = 'internal']/title")
@@ -129,7 +131,7 @@ module Asciidoctor
         [internal, external]
       end
 
-      def term_defs_boilerplate(div, source, term, preface, isodoc)
+      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>"
@@ -144,16 +146,20 @@ module Asciidoctor
           div.next = "<p>#{@i18n.term_def_boilerplate}</p>"
       end
 
-      def section_names_terms_cleanup(x)
+      def section_names_terms_cleanup(xml)
         super
         replace_title(
-          x, "//terms[@type = 'internal'] | "\
-          "//clause[./terms[@type = 'internal']][not(./terms[@type = 'external'])]", 
-          @i18n&.internal_termsdef)
+          xml, "//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)
+          xml, "//terms[@type = 'external'] | "\
+               "//clause[./terms[@type = 'external']]"\
+               "[not(./terms[@type = 'internal'])]",
+          @i18n&.external_termsdef
+        )
       end
 
       def symbols_cleanup(xmldoc)
@@ -193,12 +199,11 @@ module Asciidoctor
       # then title
       def sort_biblio_key(bib)
         pubclass = pub_class(bib)
-        num = bib&.at("./docnumber")&.text
         id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
                      "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
         metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match(metaid)
-        type = id['type'] if id
+        abbrid = metaid unless /^\[\d+\]$/.match?(metaid)
+        type = id["type"] if id
         title = bib&.at("./title[@type = 'main']")&.text ||
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text
         "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"

data/lib/asciidoctor/itu/converter.rb

@@ -1,6 +1,7 @@
 require "asciidoctor"
 require "asciidoctor/standoc/converter"
 require "fileutils"
+require "metanorma-utils"
 require_relative "./front"
 require_relative "./validate"
 require_relative "./cleanup"
@@ -107,16 +108,11 @@ module Asciidoctor
         return unless node.attr("keywords")
 
         node.attr("keywords").split(/, */).sort.each_with_index do |kw, i|
-          xml.keyword (i.zero? ? strict_capitalize(kw) : kw)
+          kw_out = i.zero? ? Metanorma::Utils.strict_capitalize_first(kw) : kw
+          xml.keyword kw_out
         end
       end
 
-      def strict_capitalize(str)
-        letters = str.split("")
-        letters.first.upcase!
-        letters.join
-      end
-
       def clause_parse(attrs, xml, node)
         node.option?("unnumbered") and attrs[:unnumbered] = true
         case sectiontype1(node)

data/lib/asciidoctor/itu/front.rb

@@ -17,13 +17,13 @@ module Asciidoctor
         { language: lang, format: "text/plain", type: type }
       end
 
-      def title_english(node, xml)
-        a = node.attr("title") || node.attr("title-en")
-        xml.title **attr_code(title_attr("main")) do |t|
+      def title_defaultlang(node, xml)
+        a = node.attr("title") || node.attr("title-#{@lang}")
+        xml.title **attr_code(title_attr("main", @lang)) do |t|
           t << (Metanorma::Utils::asciidoc_sub(a) || node.title)
         end
-        if a = node.attr("annextitle") || node.attr("annextitle-en")
-          xml.title **attr_code(title_attr("annex")) do |t|
+        if a = node.attr("annextitle") || node.attr("annextitle-#{@lang}")
+          xml.title **attr_code(title_attr("annex", @lang)) do |t|
             t << Metanorma::Utils::asciidoc_sub(a)
           end
         end
@@ -32,7 +32,7 @@ module Asciidoctor
       def title_otherlangs(node, xml)
         node.attributes.each do |k, v|
           next unless /^(annex)?title-(?<lang>.+)$/ =~ k
-          next if lang == "en"
+          next if lang == @lang
 
           type = /^annex/.match?(k) ? "annex" : "main"
           xml.title **attr_code(title_attr(type, lang)) do |t|
@@ -42,16 +42,17 @@ module Asciidoctor
       end
 
       def title(node, xml)
-        super
+        title_defaultlang(node, xml)
+        title_otherlangs(node, xml)
         %w(subtitle amendment-title corrigendum-title).each do |t|
-          other_title_english(node, xml, t)
+          other_title_defaultlang(node, xml, t)
           other_title_otherlangs(node, xml, t)
         end
       end
 
-      def other_title_english(node, xml, type)
-        a = node.attr(type) || node.attr("#{type}-en")
-        xml.title **attr_code(title_attr(type.sub(/-title/, ""))) do |t|
+      def other_title_defaultlang(node, xml, type)
+        a = node.attr(type) || node.attr("#{type}-#{@lang}")
+        xml.title **attr_code(title_attr(type.sub(/-title/, ""), @lang)) do |t|
           t << Metanorma::Utils::asciidoc_sub(a)
         end
       end
@@ -59,7 +60,7 @@ module Asciidoctor
       def other_title_otherlangs(node, xml, type)
         node.attributes.each do |k, v|
           next unless m = /^#{type}-(?<lang>.+)$/.match(k)
-          next if m[:lang] == "en"
+          next if m[:lang] == @lang
 
           xml.title **attr_code(title_attr(type.sub(/-title/, ""),
                                            m[:lang])) do |t|
@@ -84,30 +85,23 @@ module Asciidoctor
       def metadata_committee1(node, xml, suffix)
         xml.editorialgroup do |a|
           a.bureau ( node.attr("bureau#{suffix}") || "T")
-          if node.attr("group#{suffix}")
-            a.group **attr_code(type: node.attr("grouptype#{suffix}")) do |g|
-              metadata_committee2(node, g, suffix, "")
-            end
-          end
-          if node.attr("subgroup#{suffix}")
-            a.subgroup **attr_code(type: node.attr("subgrouptype#{suffix}")) do |g|
-              metadata_committee2(node, g, suffix, "sub")
-            end
-          end
-          if node.attr("workgroup#{suffix}")
-            a.workgroup **attr_code(type: node.attr("workgrouptype#{suffix}")) do |g|
-              metadata_committee2(node, g, suffix, "work")
+          ["", "sub", "work"].each do |p|
+            next unless node.attr("#{p}group#{suffix}")
+
+            type = node.attr("#{p}grouptype#{suffix}")
+            a.send "#{p}group", **attr_code(type: type) do |g|
+              metadata_committee2(node, g, suffix, p)
             end
           end
         end
       end
 
-      def metadata_committee2(node, g, suffix, prefix)
-        g.name node.attr("#{prefix}group#{suffix}")
+      def metadata_committee2(node, group, suffix, prefix)
+        group.name node.attr("#{prefix}group#{suffix}")
         node.attr("#{prefix}groupacronym#{suffix}") and
-          g.acronym node.attr("#{prefix}groupacronym#{suffix}")
+          group.acronym node.attr("#{prefix}groupacronym#{suffix}")
         if node.attr("#{prefix}groupyearstart#{suffix}")
-          g.period do |p|
+          group.period do |p|
             p.start node.attr("#{prefix}groupyearstart#{suffix}")
             node.attr("#{prefix}groupacronym#{suffix}") and
               p.end node.attr("#{prefix}groupyearend#{suffix}")
@@ -134,9 +128,11 @@ module Asciidoctor
 
       def itu_id1(node, lang)
         bureau = node.attr("bureau") || "T"
-        id = doctype(node) == "service-publication" ?
-          @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber")) :
-          "ITU-#{bureau} #{node.attr('docnumber')}"
+        id = if doctype(node) == "service-publication"
+               @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber"))
+             else
+               "ITU-#{bureau} #{node.attr('docnumber')}"
+             end
         id + (lang ? "-#{ITULANG[@lang]}" : "")
       end
 
@@ -165,16 +161,16 @@ module Asciidoctor
       def metadata_series(node, xml)
         node.attr("series") and
           xml.series **{ type: "main" } do |s|
-          s.title node.attr("series")
-        end
+            s.title node.attr("series")
+          end
         node.attr("series1") and
           xml.series **{ type: "secondary" } do |s|
-          s.title node.attr("series1")
-        end
+            s.title node.attr("series1")
+          end
         node.attr("series2") and
           xml.series **{ type: "tertiary" } do |s|
-          s.title node.attr("series2")
-        end
+            s.title node.attr("series2")
+          end
       end
 
       def metadata_recommendationstatus(node, xml)
@@ -222,9 +218,9 @@ module Asciidoctor
         end
       end
 
-      def metadata_meeting_date(a, xml)
+      def metadata_meeting_date(val, xml)
         xml.meeting_date do |m|
-          d = a.split("/")
+          d = val.split("/")
           if d.size > 1
             m.from d[0]
             m.to d[1]
@@ -234,9 +230,9 @@ module Asciidoctor
         end
       end
 
-      def personal_role(node, c, suffix)
+      def personal_role(node, contrib, suffix)
         if node.attr("role#{suffix}")&.downcase == "rapporteur"
-          c.role "raporteur", **{ type: "editor" }
+          contrib.role "raporteur", **{ type: "editor" }
         else
           super
         end

data/lib/asciidoctor/itu/isodoc.rng

@@ -32,6 +32,18 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="section-title">
+      <element name="title">
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+      <zeroOrMore>
+        <element name="variant-title">
+          <ref name="TypedTitleString"/>
+        </element>
+      </zeroOrMore>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -158,15 +170,17 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <attribute name="type">
-          <choice>
-            <value>roman</value>
-            <value>alphabet</value>
-            <value>arabic</value>
-            <value>roman_upper</value>
-            <value>alphabet_upper</value>
-          </choice>
-        </attribute>
+        <optional>
+          <attribute name="type">
+            <choice>
+              <value>roman</value>
+              <value>alphabet</value>
+              <value>arabic</value>
+              <value>roman_upper</value>
+              <value>alphabet_upper</value>
+            </choice>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -976,6 +990,16 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="linkmention">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="linkref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="refterm">
           <zeroOrMore>
@@ -1011,8 +1035,14 @@
       <ref name="imagemap"/>
       <ref name="svgmap"/>
       <ref name="inputform"/>
+      <ref name="toc"/>
     </choice>
   </define>
+  <define name="toc">
+    <element name="toc">
+      <ref name="ul"/>
+    </element>
+  </define>
   <define name="inputform">
     <element name="form">
       <attribute name="id">
@@ -1254,6 +1284,12 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="identifier"/>
+    </optional>
+    <optional>
+      <attribute name="prefix"/>
+    </optional>
     <text/>
   </define>
   <define name="ics">
@@ -1674,7 +1710,9 @@
       <zeroOrMore>
         <ref name="termgrammar"/>
       </zeroOrMore>
-      <ref name="definition"/>
+      <oneOrMore>
+        <ref name="termdefinition"/>
+      </oneOrMore>
       <zeroOrMore>
         <ref name="termnote"/>
       </zeroOrMore>
@@ -1737,7 +1775,7 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="definition">
+  <define name="termdefinition">
     <element name="definition">
       <oneOrMore>
         <choice>
@@ -1746,6 +1784,9 @@
           <ref name="formula"/>
         </choice>
       </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="termnote">