metanorma-itu 1.1.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7125f1d6d17254c0460f7398d24a43683b2099bc07f0cd7c483ce2725ab847b
-  data.tar.gz: bb3b19af63382c527698bdb6402cc314f6e0fd0dfd3e90e6fae6d64d6afe5918
+  metadata.gz: 5ba47f749671a89645723abe98c885b11763bc82af7f2ae51dd61bf258c6c020
+  data.tar.gz: d7d9ca77cb3378430bb1c9d93c3027609c2f4154e4387178f394536f505742f0
 SHA512:
-  metadata.gz: 8637b27bbb50cc729c8be856154330a9cd6ba7fdd60dcc3eb5f3605609fd62384e266e92370178fc603585330522e38fdde42fed426eeab9c5237f2072945c5b
-  data.tar.gz: 8ae3568058d7a603c2f875eaaea6f507874249b4ed6bfafca084a220a416cf8186f0c48f6f12fe23b4545f3eddd7055fc7e5385892c250f21c5f38e114f2eea9
+  metadata.gz: 1587f02fd05eade3ee88febabfb053f0a295e982bf1285b067d99d81eba1a34c593ee4971ad6e3c909424193a8852ba0f4061ecf4c5c5622416289006f7d1a53
+  data.tar.gz: 85573c130621858588e1f0910a10d99ff874c930acf191b793abaea98c63d17492de7ab95bc402f2dab2ff22844e0763d7d3f69f568e19d173109fde53a71ae2

data/lib/asciidoctor/itu/basicdoc.rng

@@ -402,6 +402,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +439,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -998,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

data/lib/asciidoctor/itu/cleanup.rb

@@ -4,13 +4,14 @@ 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)
         super
         xmldoc.xpath("//thead/tr[1]/th | //thead/tr[1]/td").each do |t|
           text = t.at("./descendant::text()") or next
-          text.replace(text.text.titlecase)
+          text.replace(text.text.capitalize)
         end
       end
 
@@ -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">
@@ -61,6 +64,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +586,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +671,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +717,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +864,13 @@
   </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="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +892,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +959,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1001,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1029,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1051,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1079,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1223,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1493,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1542,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>