metanorma-itu 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 786ad4b858755dc7228fb7aa516093c03557f26e341a8daa99f3718e5fcdcd4c
-  data.tar.gz: 5242d55de66da6c90f09e8b638d7e0942fd0e52f4c0eac9751da8069cfa36b4c
+  metadata.gz: 8bad5e2f659ff457f36fdeeed03ac7bdde40f40e8dfda17655cd269113c25792
+  data.tar.gz: d79af9838308ff14fc77be92eb359d37360f60915e0fb21a575fa8dffbd52046
 SHA512:
-  metadata.gz: 71bf062f4d6eae3040dff1d4e7b06a236658eabda739d91fbb547926944f3506abcce39918692dd5525202d28bb2fe8662ee19702b5da1cd316c58c55083b15b
-  data.tar.gz: 1739a7c6b47dec20c6b011f4f9b8dc47613b9b1670abbe6386497ac76748f4af2a54a27cff58014b1dd268cd8ef9a7bd69d354152fbb2fa71265dd1e04e204b3
+  metadata.gz: e86d60228d21d906ad1411cc54b14e7aeba763c7dc189dd87880394eeb62e24f6989b31b3e828be026540a44bb4d06bf452b52d441478c235b6a9039901bb73c
+  data.tar.gz: 7b97735f1e241bc98dcbfd388bad1d60427e43ed3a1aeb8b969ddd32bfdc79ce58149144175a2fc728f2ae22c5afed2c122009b0465fe3f109f4096a5854ed0a

data/lib/asciidoctor/itu/basicdoc.rng

@@ -336,7 +336,9 @@
   </define>
   <define name="tname">
     <element name="name">
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="tclass">
@@ -812,6 +814,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
       <optional>
         <attribute name="longdesc">
           <data type="anyURI"/>
@@ -850,6 +855,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
       <optional>
         <attribute name="longdesc">
           <data type="anyURI"/>
@@ -875,6 +883,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
       <optional>
         <attribute name="longdesc">
           <data type="anyURI"/>

data/lib/asciidoctor/itu/biblio.rng

@@ -919,6 +919,7 @@
     <choice>
       <value>main</value>
       <value>alt</value>
+      <text/>
     </choice>
   </define>
   <define name="seriesorganization">

data/lib/asciidoctor/itu/converter.rb

@@ -3,6 +3,7 @@ require "asciidoctor/standoc/converter"
 require "fileutils"
 require_relative "./front.rb"
 require_relative "./validate.rb"
+require_relative "./macros.rb"
 
 module Asciidoctor
   module ITU
@@ -11,6 +12,9 @@ module Asciidoctor
     # schema encapsulation of the document for validation
     #
     class Converter < Standoc::Converter
+      Asciidoctor::Extensions.register do
+        block PseudocodeBlockMacro
+      end
 
       register_for "itu"
 
@@ -35,6 +39,28 @@ module Asciidoctor
         node.attr("doctype") || "recommendation"
       end
 
+       def example(node)
+        role = node.role || node.attr("style")
+        return pseudocode_example(node) if role == "pseudocode"
+        super
+      end
+
+      def pseudocode_example(node)
+        noko do |xml|
+          xml.figure **{id: Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+                        type: "pseudocode"} do |ex|
+            figure_title(node, ex)
+            wrap_in_para(node, ex)
+          end
+        end.join("\n")
+      end
+
+      def init_indent(s)
+        /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
+        prefix = prefix.gsub(/\t/, "&#xa0;&#xa0;&#xa0;&#xa0;").gsub(/ /, "&#xa0;")
+        prefix + suffix
+      end
+
       def clause_parse(attrs, xml, node)
         attrs[:preface] = true if node.attr("style") == "preface"
         super
@@ -82,6 +108,11 @@ module Asciidoctor
         end
       end
 
+      def cleanup(xmldoc)
+        symbols_cleanup(xmldoc)
+        super
+      end
+
       def style(n, t)
         return
       end
@@ -104,7 +135,7 @@ module Asciidoctor
           when "symbols and abbreviated terms",
             "symbols",
             "abbreviated terms",
-            "abbreviations"
+            "abbreviations",
             "abbreviations and acronyms"
             symbols_parse(a, xml, node)
           when "bibliography" then bibliography_parse(a, xml, node)
@@ -141,7 +172,8 @@ module Asciidoctor
 
       def termdef_cleanup(xmldoc)
         xmldoc.xpath("//term/preferred").each do |p|
-          if ["terms defined elsewhere", "terms defined in this recommendation"].include? p.text.downcase
+          if ["terms defined elsewhere",
+              "terms defined in this recommendation"].include? p.text.downcase
             p.name = "title"
             p.parent.name = "terms"
           end
@@ -149,11 +181,42 @@ module Asciidoctor
         super
       end
 
+      def termdef_boilerplate_cleanup(xmldoc)
+      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
+        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
+
       NORM_REF = "//bibliography/references[title = 'References']".freeze
 
-      def boilerplate_cleanup(xmldoc)
-        f = xmldoc.at(self.class::NORM_REF) and
-        norm_ref_preface(f)
+      def symbols_cleanup(xmldoc)
+        sym = xmldoc.at("//definitions/title")
+        sym and sym&.next_element&.name == "dl" and
+          sym.next = "<p>#{@symbols_boilerplate}</p>"
       end
 
       def load_yaml(lang, script)
@@ -163,9 +226,14 @@ module Asciidoctor
             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 html_converter(node)
         IsoDoc::ITU::HtmlConvert.new(html_extract_attributes(node))
       end

data/lib/asciidoctor/itu/front.rb

@@ -63,8 +63,10 @@ module Asciidoctor
       def metadata_committee1(node, xml, suffix)
         xml.editorialgroup do |a|
           a.bureau ( node.attr("bureau#{suffix}") || "T" )
-          a.group **attr_code(type: node.attr("grouptype#{suffix}")) do |g|
-            metadata_committee2(node, g, suffix, "")
+          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|

data/lib/asciidoctor/itu/i18n-en.yaml

@@ -1,2 +1,12 @@
 norm_with_refs_pref:
   The following ITU-T Recommendations and other references contain provisions which, through reference in this text, constitute provisions of this Recommendation. At the time of publication, the editions indicated were valid. All Recommendations and other references are subject to revision; users of this Recommendation are therefore encouraged to investigate the possibility of applying the most recent edition of the Recommendations and other references listed below. A list of the currently valid ITU-T Recommendations is regularly published. The reference to a document within this Recommendation does not give it, as a stand-alone document, the status of a Recommendation.
+term_def_boilerplate: 
+  "This Recommendation defines the following terms:"
+internal_terms_boilerplate:
+  "This Recommendation defines the following terms:"
+external_terms_boilerplate:
+   "This Recommendation uses the following terms defined elsewhere:"
+no_terms_boilerplate:
+  None.
+symbols_boilerplate:
+  "This Recommendation uses the following abbreviations:"

data/lib/asciidoctor/itu/isodoc.rng

@@ -252,7 +252,11 @@
         </zeroOrMore>
       </group>
       <oneOrMore>
-        <ref name="clause-subsection"/>
+        <choice>
+          <ref name="clause-subsection"/>
+          <ref name="terms"/>
+          <ref name="definitions"/>
+        </choice>
       </oneOrMore>
     </choice>
   </define>

data/lib/asciidoctor/itu/isostandard.rng

@@ -215,8 +215,14 @@
         <optional>
           <ref name="section-title"/>
         </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
         <zeroOrMore>
           <ref name="bibitem"/>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
         </zeroOrMore>
         <zeroOrMore>
           <ref name="references"/>
@@ -244,6 +250,9 @@
             </choice>
           </attribute>
         </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
         <ref name="dl"/>
       </element>
     </define>
@@ -271,6 +280,9 @@
         <optional>
           <ref name="section-title"/>
         </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
         <choice>
           <oneOrMore>
             <ref name="term"/>

data/lib/asciidoctor/itu/itu.rng

@@ -67,7 +67,9 @@
     <define name="editorialgroup">
       <element name="editorialgroup">
         <ref name="bureau"/>
-        <ref name="group"/>
+        <optional>
+          <ref name="group"/>
+        </optional>
         <optional>
           <ref name="subgroup"/>
         </optional>
@@ -105,11 +107,33 @@
       <optional>
         <ref name="recommendationstatus"/>
       </optional>
+      <optional>
+        <ref name="ipnoticereceived"/>
+      </optional>
       <optional>
         <ref name="structuredidentifier"/>
       </optional>
     </define>
+    <define name="preface">
+      <element name="preface">
+        <oneOrMore>
+          <choice>
+            <ref name="content"/>
+            <ref name="abstract"/>
+            <ref name="foreword"/>
+            <ref name="introduction"/>
+            <ref name="acknowledgements"/>
+            <ref name="clause"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
   </include>
+  <define name="ipnoticereceived">
+    <element name="ip-notice-received">
+      <data type="boolean"/>
+    </element>
+  </define>
   <define name="recommendationstatus">
     <element name="recommendationstatus">
       <element name="from">

data/lib/asciidoctor/itu/macros.rb

@@ -0,0 +1,19 @@
+require "asciidoctor/extensions"
+
+class PseudocodeBlockMacro < Asciidoctor::Extensions::BlockProcessor
+  use_dsl
+  named :pseudocode
+  on_context :example, :sourcecode
+
+  def init_indent(s)
+    /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
+    prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0").gsub(/ /, "\u00a0")
+    prefix + suffix
+  end
+
+  def process parent, reader, attrs
+    attrs['role'] = 'pseudocode'
+    create_block parent, :example, reader.lines.map { |m| init_indent(m) }, attrs,
+      content_model: :compound
+  end
+end

data/lib/isodoc/itu/base_convert.rb

@@ -34,6 +34,27 @@ module IsoDoc
         end
       end
 
+      def clausedelim
+        ""
+      end
+
+      def figure_parse(node, out)
+        return pseudocode_parse(node, out) if node["type"] == "pseudocode"
+        super
+      end
+
+      def pseudocode_parse(node, out)
+        @in_figure = true
+        name = node.at(ns("./name"))
+        out.div **attr_code(id: node["id"], class: "pseudocode") do |div|
+          node.children.each do |n|
+            parse(n, div) unless n.name == "name"
+          end
+          figure_name_parse(node, div, name)
+        end
+        @in_figure = false
+      end
+
       def annex_name(annex, name, div)
         div.h1 **{ class: "Annex" } do |t|
           t << "#{anchor(annex['id'], :label)} "
@@ -79,12 +100,12 @@ module IsoDoc
       end
 
       def annex_names1(clause, num, level)
-      @anchors[clause["id"]] = { label: num, xref: "#{@labels["annex_subclause"]} #{num}",
-                                 level: level, type: "clause" }
-      clause.xpath(ns("./clause")).each_with_index do |c, i|
-        annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        @anchors[clause["id"]] = { label: num, xref: "#{@labels["annex_subclause"]} #{num}",
+                                   level: level, type: "clause" }
+        clause.xpath(ns("./clause")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
       end
-    end
 
       def i18n_init(lang, script)
         super
@@ -105,6 +126,11 @@ module IsoDoc
           h2.add_child("&nbsp;")
           h2.add_child(d.remove)
         end
+        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
 
@@ -137,6 +163,9 @@ module IsoDoc
         out.div do |div|
           num = num + 1
           clause_name(num, @normref_lbl, div, nil)
+          f.elements.reject do |e|
+            %w(reference title bibitem note).include? e.name
+          end.each { |e| parse(e, div) }
           biblio_list(f, div, false)
         end
         num
@@ -155,6 +184,33 @@ module IsoDoc
         nonstd_bibitem(list, b, ordinal, biblio)
       end
 
+      def reference_format(b, r)
+        reference_format_start(b, r)
+        reference_format_title(b, r)
+      end
+
+      def reference_format_start(b, r)
+        id = bibitem_ref_code(b)
+        r << "Recommendation " if id["type"] == "ITU"
+        r << render_identifier(id)
+        if date = b.at(ns("./date[@type = 'published']"))
+          r << " (#{date.text.sub(/-.*$/, '')})"
+        end
+        r << ", "
+      end
+
+      def reference_format_title(b, r)
+        if ftitle = b.at(ns("./formattedref"))
+          ftitle&.children&.each { |n| parse(n, r) }
+          /\.$/.match(ftitle&.text) or r << "."
+        elsif title = iso_title(b)
+          r.i do |i|
+            title&.children&.each { |n| parse(n, i) }
+          end
+          /\.$/.match(title&.text) or r << "."
+        end
+      end
+
       def terms_defs_title(node)
         t = node.at(ns("./title")) and return t.text
         super
@@ -199,8 +255,8 @@ module IsoDoc
           end
           source and p << " [#{source.value}]"
           p << ": "
-          defn and defn.children.each { |n| parse(n, p) }
         end
+        defn and defn.children.each { |n| parse(n, div) }
       end
 
       def termdef_parse(node, out)

data/lib/isodoc/itu/html/header.html

@@ -102,7 +102,7 @@ mso-line-height-rule:exactly'><span lang=EN-GB></span></p>
 
 <div style='mso-element:footer' id=ef2>
 
-<p class=MsoFooter style='line-height:12.0pt;mso-line-height-rule:exactly'><!--[if supportFields]><span lang=EN-GB style='font-weight:
+<p class=FooterQP style='line-height:12.0pt;mso-line-height-rule:exactly'><!--[if supportFields]><span lang=EN-GB style='font-weight:
 normal'><span style='mso-element:field-begin'></span></span><span lang=FR-CH
 style='mso-ansi-language:FR-CH;font-weight:normal'><span
 style='mso-spacerun:yes'> </span>PAGE<span style='mso-spacerun:yes'>  </span>\*
@@ -117,7 +117,7 @@ ITU‑{{ bureau }} {{ docnumber }} ({{ pubdate_monthyear }})<o:p></o:p></span></
 
 <div style='mso-element:footer' id=f2>
 
-<p class=MsoFooter style='line-height:12.0pt'><span lang=EN-GB><span style='mso-tab-count:2'>                                                                                                       </span>Rec.
+<p class=FooterQP style='line-height:12.0pt'><span lang=EN-GB><span style='mso-tab-count:2'>                                                                                                       </span>Rec.
   ITU‑{{ bureau }} {{docnumber}} ({{ pubdate_monthyear }})<span style='mso-tab-count:1'>             </span></span><!--[if supportFields]><span
 lang=EN-GB style='font-weight:normal'><span style='mso-element:field-begin'></span>
 PAGE<span style='mso-spacerun:yes'>  </span>\* MERGEFORMAT <span
@@ -130,7 +130,7 @@ lang=EN-GB style='font-weight:normal'><o:p></o:p></span></p>
 
 <div style='mso-element:footer' id=ef3>
 
-<p class=MsoFooter style='line-height:12.0pt;mso-line-height-rule:exactly'><!--[if supportFields]><span lang=EN-GB style='font-weight:
+<p class=FooterQP style='line-height:12.0pt;mso-line-height-rule:exactly'><!--[if supportFields]><span lang=EN-GB style='font-weight:
 normal'><span style='mso-element:field-begin'></span></span><span lang=FR-CH
 style='mso-ansi-language:FR-CH;font-weight:normal'><span
 style='mso-spacerun:yes'> </span>PAGE<span style='mso-spacerun:yes'>  </span>\*
@@ -145,7 +145,7 @@ ITU‑{{ bureau }} {{ docnumber }} ({{ pubdate_monthyear }})<o:p></o:p></span></
 
 <div style='mso-element:footer' id=f3>
 
-<p class=MsoFooter style='line-height:12.0pt'><span lang=EN-GB><span style='mso-tab-count:2'>                                                                                                       </span>Rec.
+<p class=FooterQP style='line-height:12.0pt'><span lang=EN-GB><span style='mso-tab-count:2'>                                                                                                       </span>Rec.
   ITU‑{{ bureau }} {{docnumber}} ({{ pubdate_monthyear }})<span style='mso-tab-count:1'>             </span></span><!--[if supportFields]><span
 lang=EN-GB style='font-weight:normal'><span style='mso-element:field-begin'></span>
 PAGE<span style='mso-spacerun:yes'>  </span>\* MERGEFORMAT <span