metanorma-itu 1.2.10 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a5e5576a553c84c8a975e21c6f7187fb3d959486fb82da54caa4bae59bc70e4
-  data.tar.gz: 06e43014128a730fe43d6e602a6a1c83280d09043c458620ecf7c3488e8d29c6
+  metadata.gz: ebf36f8725648a2e24bf148c5b6eca7227892eb9f91a18cc7f274a62981db6e2
+  data.tar.gz: c4e7229799f091ce3cf6ac21e2fbb202d39e7bf57d1f72e0e74c726f7fb0441e
 SHA512:
-  metadata.gz: ec9c3c73670e489535e88bb5abed0956a53dcc692d6fbb95b11507b085f3e8e01342be19fd4ee7ab3d55a11d08fe8566cb643670af29e1ef72979f3653f5b5f0
-  data.tar.gz: b2996860abd9e0354985b288a2c562b19d8456c0b7b6d4afcdb208f4c29d9efbabc559eb266dcc879fd23569a0fa3542335384d9f7d91567d7de830a6f0ad54a
+  metadata.gz: 924c0c3a471675ad01f3b52dd1e28192cff5a5124b1808f867417a96d28ee6357268820ab00301f6710752afec711d256909b5bac24a714d77ff951129b6ca62
+  data.tar.gz: 6da337d4917c9f6d537636540ba5ea8569a3d410100261ca79beb3f1082438db50af7cd33a1065b08fb8a0226b2d4fb814c4fc94bc615721b68c0e2826f7c19c

data/.github/workflows/rake.yml

@@ -36,6 +36,9 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
+
       - uses: actions/cache@v2
         with:
           path: vendor/bundle

data/lib/asciidoctor/itu/boilerplate.xml

@@ -3,10 +3,11 @@
   {% else %}
   <copyright-statement>
     <clause>
-      <p>&copy; ITU {{ docyear }}</p>
+      <p>&#xa9; ITU {{ docyear }}</p>
 <p>All rights reserved. No part of this publication may be reproduced, by any means whatsoever, without the prior written permission of ITU.</p>
     </clause>
   </copyright-statement>
+  {% if doctype == "Recommendation" %}
   <license-statement>
     <clause>
       <title>INTELLECTUAL PROPERTY RIGHTS</title>
@@ -15,6 +16,7 @@
 </p>
 </clause>
 </license-statement>
+{% endif %}
   <legal-statement>
     <clause>
       <title>FOREWORD</title>
@@ -23,12 +25,13 @@
 <p>The approval of ITU-T Recommendations is covered by the procedure laid down in WTSA Resolution 1 .</p>
 <p>In some areas of information technology which fall within ITU-T's purview, the necessary standards are prepared on a collaborative basis with ISO and IEC.</p>
 
-
+{% if doctype == "Recommendation" %}
 <clause>
 <title>NOTE</title>
 <p>In this Recommendation, the expression "Administration" is used for conciseness to indicate both a telecommunication administration and a recognized operating agency .</p>
 <p>Compliance with this Recommendation is voluntary. However, the Recommendation may contain certain mandatory provisions (to ensure, e.g., interoperability or applicability) and compliance with the Recommendation is achieved when all of these mandatory provisions are met. The words "shall" or some other obligatory language such as "must" and the negative equivalents are used to express requirements. The use of such words does not suggest that compliance with the Recommendation is required of any party .</p>
 </clause>
+{% endif %}
     </clause>
 
     {% if unpublished %}

data/lib/asciidoctor/itu/cleanup.rb

@@ -5,6 +5,15 @@ module Asciidoctor
         super
         insert_missing_sections(x) unless @no_insert_missing_sections
         insert_empty_clauses(x)
+        resolution_inline_header(x)
+      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?
+          c["inline-header"] = true
+        end
       end
 
       def table_cleanup(xmldoc)

data/lib/asciidoctor/itu/converter.rb

@@ -116,6 +116,7 @@ module Asciidoctor
       end
 
       def clause_parse(attrs, xml, node)
+        node.option?("unnumbered") and attrs[:unnumbered] = true
         case clausetype = sectiontype1(node)
         when "conventions" then attrs = attrs.merge(type: "conventions")
         when "history" 

data/lib/asciidoctor/itu/front.rb

@@ -8,8 +8,7 @@ module Asciidoctor
       def metadata_status(node, xml)
         xml.status do |s|
           s.stage (node.attributes.has_key?("draft") ? "draft" :
-                   (node.attr("status") || node.attr("docstage") ||
-                    "published" ))
+                   (node.attr("status") || node.attr("docstage") || "published" ))
         end
       end
 
@@ -32,8 +31,7 @@ module Asciidoctor
           next unless /^(annex)?title-(?<lang>.+)$/ =~ k
           next if lang == "en"
           type = /^annex/.match(k) ? "annex" : "main"
-          xml.title **attr_code(language: lang, format: "text/plain",
-                                type: type) do |t|
+          xml.title **attr_code(language: lang, format: "text/plain", type: type) do |t|
             t << Asciidoctor::Standoc::Utils::asciidoc_sub(v)
           end
         end
@@ -126,18 +124,13 @@ module Asciidoctor
         end
       end
 
-      ITULANG = {
-        "en" => "E", "fr" => "F", "ar" => "A",
-        "es" => "S", "zh" => "C", "ru" => "R"
-      }.freeze
+      ITULANG = { "en" => "E", "fr" => "F", "ar" => "A", "es" => "S", "zh" => "C", "ru" => "R" }.freeze
 
       def itu_id1(node, lang)
         bureau = node.attr("bureau") || "T"
-        id = if doctype(node) == "service-publication"
-               @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber"))
-             else
-               "ITU-#{bureau} #{node.attr("docnumber")}"
-             end
+        id = doctype(node) == "service-publication" ?
+          @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber")) :
+          "ITU-#{bureau} #{node.attr("docnumber")}"
         id + (lang ? "-#{ITULANG[@lang]}" : "")
       end
 
@@ -204,14 +197,20 @@ module Asciidoctor
         end
       end
 
-      # also used in tech paper
       def metadata_techreport(node, xml)
-        a = node.attr("meeting") and xml.meeting a
+        a = node.attr("meeting") and metadata_meeting(a, node.attr("meeting-acronym"), xml)
+        a = node.attr("meeting-place") and xml.meeting_place a
         a = node.attr("meeting-date") and metadata_meeting_date(a, xml)
         a = node.attr("intended-type") and xml.intended_type a
         a = node.attr("source") and xml.source a
       end
 
+      def metadata_meeting(mtg, acronym, xml)
+        xml.meeting **attr_code(acronym: acronym) do |m|
+          m << mtg
+        end
+      end
+
       def metadata_meeting_date(a, xml)
         xml.meeting_date do |m|
           d = a.split("/")

data/lib/asciidoctor/itu/isodoc.rng

@@ -253,6 +253,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
         <optional>
           <ref name="colgroup"/>
         </optional>
@@ -836,6 +839,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -891,9 +897,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1063,6 +1071,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1116,6 +1127,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1218,6 +1232,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1546,6 +1563,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1576,6 +1594,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

data/lib/asciidoctor/itu/itu.rng

@@ -42,6 +42,8 @@
         <value>joint-itu-iso-iec</value>
         <value>resolution</value>
         <value>service-publication</value>
+        <value>handbook</value>
+        <value>question</value>
       </choice>
     </define>
     <define name="editorialgroup">
@@ -98,6 +100,9 @@
       <optional>
         <ref name="meeting"/>
       </optional>
+      <optional>
+        <ref name="meeting-place"/>
+      </optional>
       <optional>
         <ref name="meeting-date"/>
       </optional>
@@ -125,9 +130,74 @@
         </oneOrMore>
       </element>
     </define>
+    <define name="Clause-Section">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <ref name="section-title"/>
+      </optional>
+      <group>
+        <choice>
+          <group>
+            <zeroOrMore>
+              <ref name="BasicBlock"/>
+            </zeroOrMore>
+            <zeroOrMore>
+              <ref name="note"/>
+            </zeroOrMore>
+          </group>
+          <ref name="amend"/>
+        </choice>
+        <zeroOrMore>
+          <choice>
+            <ref name="clause-subsection"/>
+            <ref name="terms"/>
+            <ref name="definitions"/>
+          </choice>
+        </zeroOrMore>
+      </group>
+    </define>
   </include>
   <define name="meeting">
     <element name="meeting">
+      <optional>
+        <attribute name="acronym"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
+  <define name="meeting-place">
+    <element name="meeting-place">
       <text/>
     </element>
   </define>

data/lib/asciidoctor/itu/validate.rb

@@ -12,8 +12,7 @@ module Asciidoctor
         recommendation-corrigendum recommendation-errata recommendation-annex 
         focus-group implementers-guide technical-paper technical-report 
         joint-itu-iso-iec service-publication).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)
@@ -41,8 +40,7 @@ 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
 
@@ -108,6 +106,16 @@ module Asciidoctor
       def section_validate(doc)
         super
         section_check(doc.root)
+        unnumbered_check(doc.root)
+      end
+
+      def unnumbered_check(xmldoc)
+        doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
+        xmldoc.xpath("//clause[@unnumbered = 'true']").each do |c|
+          next if doctype == "resolution" and c.parent.name == "sections" and
+            !c.at("./preceding-sibling::clause")
+          @log.add("Style", c, "Unnumbered clause out of place")
+        end
       end
 
       # Editing Guidelines 7.2, 7.3

data/lib/isodoc/itu/base_convert.rb

@@ -3,6 +3,7 @@ require "fileutils"
 require_relative "./ref.rb"
 require_relative "./xref.rb"
 require_relative "./terms.rb"
+require_relative "./cleanup.rb"
 
 module IsoDoc
   module ITU
@@ -48,21 +49,19 @@ module IsoDoc
         div.h1 **{ class: r_a ? "RecommendationAnnex" : "Annex" } do |t|
           name&.children&.each { |c2| parse(c2, t) }
         end
-        annex_obligation_subtitle(annex, div)
+        annex_obligation_subtitle(annex, div) unless @meta.get[:doctype_original] == "resolution"
       end
 
       def annex_obligation_subtitle(annex, div)
         info = annex["obligation"] == "informative"
         div.p **{class: "annex_obligation" } do |p|
-          p << (info ? @i18n.inform_annex : @i18n.norm_annex).
-            sub(/%/, @meta.get[:doctype] || "")
+          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)
+          @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|
@@ -75,67 +74,52 @@ module IsoDoc
         end
       end
 
-      def cleanup(docxml)
+      def info(isoxml, out)
+        @meta.ip_notice_received isoxml, out
+        @meta.techreport isoxml, out
         super
-        term_cleanup(docxml)
-        refs_cleanup(docxml)
-        title_cleanup(docxml)
       end
 
-      def title_cleanup(docxml)
-        docxml.xpath("//h1[@class = 'RecommendationAnnex']").each do |h|
-          h.name = "p"
-          h["class"] = "h1Annex"
-        end
-        docxml
-      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
+      def middle_title(isoxml, out)
+        if @meta.get[:doctype] == "Resolution"
+          middle_title_resolution(isoxml, out)
+        else
+          middle_title_recommendation(isoxml, out)
         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
+      def middle_title_resolution(isoxml, out)
+        res = isoxml.at(ns("//bibdata/title[@type = 'resolution']"))
+        out.p(**{ align: "center", style: "text-align:center;" }) do |p|
+          res.children.each { |n| parse(n, p) }
         end
+        out.p(**{ class: "zzSTDTitle2" }) { |p| p << @meta.get[:doctitle] }
+        middle_title_resolution_subtitle(isoxml, out)
       end
 
-      def refs_cleanup(docxml)
-        docxml.xpath("//tx[following-sibling::tx]").each do |tx|
-          tx << tx.next_element.remove.children
-        end
-        docxml.xpath("//tx").each do |tx|
-          tx.name = "td"
-          tx["colspan"] = "2"
-          tx.wrap("<tr></tr>")
+      def middle_title_resolution_subtitle(isoxml, out)
+        out.p(**{ align: "center", style: "text-align:center;" }) do |p|
+          p.i do |i|
+            i << "("
+            isoxml.at(ns("//bibdata/title[@type = 'resolution-placedate']")).children.each { |n| parse(n, i) }
+            i << ")"
+          end
+          isoxml.xpath(ns("//note[@type = 'title-footnote']")).each do |f|
+            footnote_parse(f, p)
+          end
         end
-        docxml
-      end
-
-      def info(isoxml, out)
-        @meta.ip_notice_received isoxml, out
-        @meta.techreport isoxml, out
-        super
       end
 
-      def middle_title(out)
+      def middle_title_recommendation(isoxml, out)
         out.p(**{ class: "zzSTDTitle1" }) do |p|
           id = @meta.get[:docnumber] and p << "#{@meta.get[:doctype]} #{id}" 
         end
-        out.p(**{ class: "zzSTDTitle2" }) { |p| p << @meta.get[:doctitle] }
+        out.p(**{ class: "zzSTDTitle2" }) do |p|
+          p << @meta.get[:doctitle]
+          isoxml.xpath(ns("//note[@type = 'title-footnote']")).each do |f|
+            footnote_parse(f, p)
+          end
+        end
         s = @meta.get[:docsubtitle] and
           out.p(**{ class: "zzSTDTitle3" }) { |p| p << s }
       end
@@ -178,7 +162,6 @@ module IsoDoc
         div.p do |p|
           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) }
@@ -187,6 +170,36 @@ module IsoDoc
       def table_footnote_reference_format(a)
         a.content = a.content + ")"
       end
+
+      def note_parse(node, out)
+        return if node["type"] == "title-footnote"
+        super
+      end
+
+      # can have supertitle in resolution
+      def clause(isoxml, out)
+        isoxml.xpath(ns(middle_clause(isoxml))).each do |c|
+          clause_core(c, out)
+        end
+      end
+
+      def clause_core(c, out)
+        out.div **attr_code(clause_attrs(c)) do |s|
+          c.elements.each do |c1|
+            if c1.name == "title" then clause_name(nil, c1, s, nil)
+            else
+              parse(c1, s)
+            end
+          end
+        end
+      end
+
+      def scope(isoxml, out, num)
+        return super unless @meta.get[:doctype_original] == "resolution"
+        f = isoxml.at(ns("//clause[@type = 'scope']")) or return num
+        clause_core(f, out)
+        num + 1
+      end
     end
   end
 end