metanorma-itu 2.6.1 → 2.6.2

data/lib/isodoc/itu/presentation_ref.rb

@@ -15,12 +15,16 @@ module IsoDoc
       end
 
       def bibrender_relaton(xml, renderings)
-        f = renderings[xml["id"]][:formattedref]
+        f = renderings[xml["id"]][:formattedref] or return
         ids = reference_format_start(xml)
         f &&= "<formattedref>#{ids}#{f}</formattedref>"
-        # retain date in order to generate reference tag
-        keep = "./docidentifier | ./uri | ./note | ./date | ./biblio-tag"
-        xml.children = "#{f}#{xml.xpath(ns(keep)).to_xml}"
+        if x = xml.at(ns("./formattedref"))
+          x.replace(f)
+        elsif xml.children.empty?
+          xml << f
+        else
+          xml.children.first.previous = f
+        end
       end
 
       def multi_bibitem_ref_code(bib)

data/lib/isodoc/itu/presentation_section.rb

@@ -0,0 +1,118 @@
+module IsoDoc
+  module Itu
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+            def clause1(elem)
+        clause1_super?(elem) and return super
+        lbl = @xrefs.anchor(elem["id"], :label, false)
+        oldsuppressheadingnumbers = @suppressheadingnumbers
+        @suppressheadingnumbers = true
+        super
+        @suppressheadingnumbers = oldsuppressheadingnumbers
+        lbl.blank? || elem["unnumbered"] and return
+        elem.previous =
+          "<p keep-with-next='true' class='supertitle'>" \
+          "#{labelled_autonum(@i18n.get['section'].upcase, elem["id"], lbl)}</p>"
+          #"<span element='fmt-element-name'>#{@i18n.get['section'].upcase}</span> #{autonum(elem['id'], lbl)}</p>"
+      end
+
+      def clause1_super?(elem)
+        @doctype != "resolution" ||
+          !%w(sections bibliography).include?(elem.parent.name)
+      end
+
+      def annex1(elem)
+        if @doctype == "resolution"
+          annex1_resolution(elem)
+        else
+          super
+          annex1_non_resolution(elem)
+        end
+      end
+
+      def annex1_resolution(elem)
+        elem.elements.first.previous = annex1_supertitle(elem)
+         # TODO: do not alter title, alter semx/@element = title
+        t = elem.at(ns("./title")) and
+          t.children = "<strong>#{to_xml(t.children)}</strong>"
+        prefix_name(elem, {}, nil, "title")
+      end
+
+      def annex1_non_resolution(elem)
+        info = elem["obligation"] == "informative"
+        ins = elem.at(ns("./fmt-xref-label")) || elem.at(ns("./fmt-title"))
+        p = (info ? @i18n.inform_annex : @i18n.norm_annex)
+          .gsub("%", @i18n.doctype_dict[@meta.get[:doctype_original]] || "")
+        ins.next = %(<p class="annex_obligation"><span class='fmt-obligation'>#{p}</span></p>)
+      end
+
+      def annex1_supertitle(elem)
+        lbl = @xrefs.anchor(elem["id"], :label)
+        res = elem.at(ns("//bibdata/title[@type = 'resolution']"))
+        subhead = @i18n.l10n("(#{@i18n.get['to']} #{to_xml(res.children)})")
+        "<p class='supertitle'>#{autonum(elem['id'], lbl)}<br/>#{subhead}</p>"
+      end
+
+      def middle_title(isoxml)
+        s = isoxml.at(ns("//sections")) or return
+        titfn = isoxml.at(ns("//note[@type = 'title-footnote']"))
+        case @doctype
+        when "resolution"
+          middle_title_resolution(isoxml, s.children.first)
+        when "contribution"
+        else
+          middle_title_recommendation(isoxml, s.children.first)
+        end
+        #titfn and renumber_footnotes(isoxml)
+      end
+
+      # KILL
+      def renumber_footnotesx(isoxml)
+        (isoxml.xpath(ns("//fn")) -
+         isoxml.xpath(ns("//table//fn | //figure//fn")))
+          .each_with_index do |fn, i|
+            fn["reference"] = (i + 1).to_s
+          end
+      end
+
+      def middle_title_resolution(isoxml, out)
+        res = isoxml.at(ns("//bibdata/title[@type = 'resolution']"))
+        out.previous =
+          "<p class='zzSTDTitle1' align='center'>#{res.children.to_xml}</p>"
+        t = @meta.get[:doctitle] and
+          out.previous = "<p class='zzSTDTitle2'>#{t}</p>"
+        middle_title_resolution_subtitle(isoxml, out)
+      end
+
+      def middle_title_resolution_subtitle(isoxml, out)
+        ret = "<p align='center' class='zzSTDTitle2'><em>("
+        d = isoxml.at(ns("//bibdata/title[@type = 'resolution-placedate']"))
+        ret += "#{d.children.to_xml.strip}</em>)"
+        ret += "#{title_footnotes(isoxml)}</p>"
+        out.previous = ret
+      end
+
+      def middle_title_recommendation(isoxml, out)
+        ret = ""
+        type = @meta.get[:doctype]
+        @meta.get[:unpublished] && @meta.get[:draft_new_doctype] and
+          type = @meta.get[:draft_new_doctype]
+        id = @meta.get[:docnumber] and
+          ret += "<<p class='zzSTDTitle1'>#{type} #{id}</p>"
+        t = @meta.get[:doctitle] and
+          ret += "<p class='zzSTDTitle2'>#{t}"
+        ret += "#{title_footnotes(isoxml)}</p>"
+        s = @meta.get[:docsubtitle] and ret += "<p class='zzSTDTitle3'>#{s}</p>"
+        out.previous = ret
+      end
+
+      def title_footnotes(isoxml)
+        ret = ""
+        isoxml.xpath(ns("//note[@type = 'title-footnote']"))
+          .each_with_index do |f, i|
+            ret += "<fn reference='H#{i}'>#{f.remove.children.to_xml}</fn>"
+          end
+        ret
+      end
+    end
+  end
+end

data/lib/isodoc/itu/presentation_xml_convert.rb

@@ -6,6 +6,7 @@ require_relative "presentation_bibdata"
 require_relative "presentation_preface"
 require_relative "presentation_ref"
 require_relative "presentation_contribution"
+require_relative "presentation_section"
 require_relative "../../nokogiri/xml"
 
 module IsoDoc
@@ -27,11 +28,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      def quotesourcex(docxml)
-        docxml.xpath(ns("//quote//source")).each { |f| eref1(f) }
-      end
-
       def bracket_opt(text)
         text.nil? and return
         /^\[.+\]$/.match?(text) and return text
@@ -43,7 +39,7 @@ module IsoDoc
         desgn.name == "preferred" or return
         out = desgn.parent
           .at(ns("./fmt-preferred//semx[@element = 'preferred'][last()]"))
-       out or return
+        out or return
         out.text.strip.empty? and return
         out.children = l10n "#{to_xml out.children}:"
       end
@@ -97,8 +93,24 @@ module IsoDoc
         end
       end
 
-      def table_fn1(_table, fnote, _idx)
-        fnote["reference"] += ")"
+      def fn_ref_label(fnote)
+        if fnote.ancestors("table, figure").empty? ||
+            !fnote.ancestors("name, fmt-name").empty?
+          super
+        else
+          "<sup>#{fn_label(fnote)}" \
+            "<span class='fmt-label-delim'>)</span></sup>"
+        end
+      end
+
+      def fn_body_label(fnote)
+        if fnote.ancestors("table, figure").empty? ||
+            !fnote.ancestors("name, fmt-name").empty?
+          super
+        else
+          "<sup>#{fn_label(fnote)}" \
+            "<span class='fmt-label-delim'>)</span></sup>"
+        end
       end
 
       def get_eref_linkend(node)
@@ -122,69 +134,6 @@ module IsoDoc
         { group: "'" }
       end
 
-      # KILL
-      def clause1x(elem)
-        clause1_super?(elem) and return super
-        @suppressheadingnumbers || elem["unnumbered"] and return
-        t = elem.at(ns("./title")) and t["depth"] = "1"
-        lbl = @xrefs.anchor(elem["id"], :label, false)
-        lbl.blank? and return
-        elem.previous =
-          "<p keep-with-next='true' class='supertitle'>" \
-          "#{@i18n.get['section'].upcase} #{lbl}</p>"
-      end
-
-            def clause1(elem)
-        clause1_super?(elem) and return super
-        lbl = @xrefs.anchor(elem["id"], :label, false)
-        oldsuppressheadingnumbers = @suppressheadingnumbers
-        @suppressheadingnumbers = true
-        super
-        @suppressheadingnumbers = oldsuppressheadingnumbers
-        lbl.blank? || elem["unnumbered"] and return
-        elem.previous =
-          "<p keep-with-next='true' class='supertitle'>" \
-          "#{labelled_autonum(@i18n.get['section'].upcase, elem["id"], lbl)}</p>"
-          #"<span element='fmt-element-name'>#{@i18n.get['section'].upcase}</span> #{autonum(elem['id'], lbl)}</p>"
-      end
-
-      def clause1_super?(elem)
-        @doctype != "resolution" ||
-          !%w(sections bibliography).include?(elem.parent.name)
-      end
-
-      def annex1(elem)
-        if @doctype == "resolution"
-          annex1_resolution(elem)
-        else
-          super
-          annex1_non_resolution(elem)
-        end
-      end
-
-      def annex1_resolution(elem)
-        elem.elements.first.previous = annex1_supertitle(elem)
-         # TODO: do not alter title, alter semx/@element = title
-        t = elem.at(ns("./title")) and
-          t.children = "<strong>#{to_xml(t.children)}</strong>"
-        prefix_name(elem, {}, nil, "title")
-      end
-
-      def annex1_non_resolution(elem)
-        info = elem["obligation"] == "informative"
-        ins = elem.at(ns("./fmt-xref-label")) || elem.at(ns("./fmt-title"))
-        p = (info ? @i18n.inform_annex : @i18n.norm_annex)
-          .sub("%", @i18n.doctype_dict[@meta.get[:doctype_original]] || "")
-        ins.next = %(<p class="annex_obligation"><span class='fmt-obligation'>#{p}</span></p>)
-      end
-
-      def annex1_supertitle(elem)
-        lbl = @xrefs.anchor(elem["id"], :label)
-        res = elem.at(ns("//bibdata/title[@type = 'resolution']"))
-        subhead = @i18n.l10n("(#{@i18n.get['to']} #{to_xml(res.children)})")
-        "<p class='supertitle'>#{autonum(elem['id'], lbl)}<br/>#{subhead}</p>"
-      end
-
       def ol_depth(node)
         node["class"] == "steps" ||
           node.at(".//ancestor::xmlns:ol[@class = 'steps']") or return super
@@ -197,67 +146,6 @@ module IsoDoc
         type
       end
 
-      def middle_title(isoxml)
-        s = isoxml.at(ns("//sections")) or return
-        titfn = isoxml.at(ns("//note[@type = 'title-footnote']"))
-        case @doctype
-        when "resolution"
-          middle_title_resolution(isoxml, s.children.first)
-        when "contribution"
-        else
-          middle_title_recommendation(isoxml, s.children.first)
-        end
-        titfn and renumber_footnotes(isoxml)
-      end
-
-      def renumber_footnotes(isoxml)
-        (isoxml.xpath(ns("//fn")) -
-         isoxml.xpath(ns("//table//fn | //figure//fn")))
-          .each_with_index do |fn, i|
-            fn["reference"] = (i + 1).to_s
-          end
-      end
-
-      def middle_title_resolution(isoxml, out)
-        res = isoxml.at(ns("//bibdata/title[@type = 'resolution']"))
-        out.previous =
-          "<p class='zzSTDTitle1' align='center'>#{res.children.to_xml}</p>"
-        t = @meta.get[:doctitle] and
-          out.previous = "<p class='zzSTDTitle2'>#{t}</p>"
-        middle_title_resolution_subtitle(isoxml, out)
-      end
-
-      def middle_title_resolution_subtitle(isoxml, out)
-        ret = "<p align='center' class='zzSTDTitle2'><em>("
-        d = isoxml.at(ns("//bibdata/title[@type = 'resolution-placedate']"))
-        ret += "#{d.children.to_xml.strip}</em>)"
-        ret += "#{title_footnotes(isoxml)}</p>"
-        out.previous = ret
-      end
-
-      def middle_title_recommendation(isoxml, out)
-        ret = ""
-        type = @meta.get[:doctype]
-        @meta.get[:unpublished] && @meta.get[:draft_new_doctype] and
-          type = @meta.get[:draft_new_doctype]
-        id = @meta.get[:docnumber] and
-          ret += "<<p class='zzSTDTitle1'>#{type} #{id}</p>"
-        t = @meta.get[:doctitle] and
-          ret += "<p class='zzSTDTitle2'>#{t}"
-        ret += "#{title_footnotes(isoxml)}</p>"
-        s = @meta.get[:docsubtitle] and ret += "<p class='zzSTDTitle3'>#{s}</p>"
-        out.previous = ret
-      end
-
-      def title_footnotes(isoxml)
-        ret = ""
-        isoxml.xpath(ns("//note[@type = 'title-footnote']"))
-          .each_with_index do |f, i|
-            ret += "<fn reference='H#{i}'>#{f.remove.children.to_xml}</fn>"
-          end
-        ret
-      end
-
       def dl(xml)
         super
         (xml.xpath(ns("//dl")) -

data/lib/isodoc/itu/xref.rb

@@ -56,16 +56,6 @@ module IsoDoc
         ")"
       end
 
-      # KILL
-      def sequential_figure_bodyx(subfig, counter, elem, klass, container: false)
-        label = counter.print
-        label &&= label + subfigure_label(subfig)
-        @anchors[elem["id"]] = anchor_struct(
-          label, container ? elem : nil, @labels[klass] || klass.capitalize,
-          klass, elem["unnumbered"]
-        )
-      end
-
       def figure_anchor(elem, sublabel, label, klass, container: false)
         if sublabel
           subfigure_anchor(elem, sublabel, label, klass, container: false)
@@ -96,15 +86,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      def hierarchical_figure_bodyx(num, subfignum, counter, block, klass)
-        label = "#{num}#{hier_separator}#{counter.print}" + subfigure_label(subfignum)
-        @anchors[block["id"]] = anchor_struct(
-          label, nil, @labels[klass] || klass.capitalize,
-          klass, block["unnumbered"]
-        )
-      end
-
       def sequential_formula_names(clause, container: false)
         clause.first&.xpath(ns(middle_sections))&.each do |c|
           if c["id"] && @anchors[c["id"]]

data/lib/metanorma/itu/basicdoc.rng

@@ -599,17 +599,9 @@ It is included for convenience, in case processing the citation to extract the a
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -628,17 +620,9 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -651,6 +635,20 @@ and is intended to be referenced by a callout within the source code</a:document
       </ref>
     </zeroOrMore>
   </define>
+  <define name="sourcecodebody">
+    <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+    <element name="body">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="callout">
+            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+          </ref>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="pre">
     <a:documentation>Pre-formatted block. Wrapper for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. 
 They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some 
@@ -1672,18 +1670,25 @@ which can be bookmarks as well as block or section references</a:documentation>
     </optional>
   </define>
   <define name="XrefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="ErefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement">
+            <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="fn">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.

data/lib/metanorma/itu/front.rb

@@ -24,7 +24,8 @@ module Metanorma
       end
 
       def title_defaultlang(node, xml)
-        a = node.attr("title") || node.attr("title-#{@lang}") || node.title
+        a = node.attr("title") || node.attr("title-#{@lang}") ||
+          node.attr("doctitle")
         insert_title(xml, "main", @lang, a)
         if a = node.attr("annextitle") || node.attr("annextitle-#{@lang}")
           insert_title(xml, "annex", @lang, a)

data/lib/metanorma/itu/isodoc.rng

@@ -33,6 +33,15 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="fn" combine="interleave">
+      <optional>
+        <attribute name="hiddenref">
+          <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
+This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -245,23 +254,9 @@
           <a:documentation>The caption of the block</a:documentation>
         </ref>
       </optional>
-      <oneOrMore>
-        <choice>
-          <text>
-            <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-          </text>
-          <ref name="callout">
-            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-          </ref>
-          <ref name="xref">
-            <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
-          </ref>
-          <ref name="eref">
-            <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
-          </ref>
-        </choice>
-      </oneOrMore>
+      <ref name="sourcecodebody">
+        <a:documentation>The sourcecode content</a:documentation>
+      </ref>
       <zeroOrMore>
         <ref name="annotation">
           <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -277,6 +272,26 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="sourcecodebody">
+      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+      <element name="body">
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout">
+              <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+            </ref>
+            <ref name="xref">
+              <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
+            </ref>
+            <ref name="eref">
+              <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
+            </ref>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="sections">
       <element name="sections">
         <oneOrMore>

data/lib/metanorma/itu/validate.rb

@@ -97,7 +97,6 @@ module Metanorma
 
       def itu_identifier_validate(xmldoc)
         xmldoc.xpath("//bibdata/docidentifier[@type = 'ITU']").each do |x|
-          warn x.text
           /^SG \d+/.match?(x.text) ||
           /^ITU-[RTD] [AD-VX-Z]\.\d+(\.\d+)?$/.match?(x.text) or
             @log.add("Style", nil, "#{x.text} does not match ITU document " \

data/lib/metanorma/itu/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Itu
-    VERSION = "2.6.1".freeze
+    VERSION = "2.6.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-itu
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -328,6 +328,7 @@ files:
 - lib/isodoc/itu/presentation_contribution.rb
 - lib/isodoc/itu/presentation_preface.rb
 - lib/isodoc/itu/presentation_ref.rb
+- lib/isodoc/itu/presentation_section.rb
 - lib/isodoc/itu/presentation_xml_convert.rb
 - lib/isodoc/itu/ref.rb
 - lib/isodoc/itu/terms.rb