metanorma-itu 2.4.3 → 2.4.5

data/lib/isodoc/itu/metadata.rb

@@ -1,4 +1,3 @@
-require "isodoc"
 require "twitter_cldr"
 
 module IsoDoc
@@ -11,6 +10,7 @@ module IsoDoc
         set(:logo_comb, fileloc("itu-document-comb.png"))
         set(:logo_word, fileloc(n))
         set(:logo_sp, fileloc("logo-sp.png"))
+        set(:logo_small, fileloc("logo-small.png"))
         @isodoc = IsoDoc::ITU::HtmlConvert.new({})
       end
 
@@ -19,21 +19,30 @@ module IsoDoc
         File.expand_path(File.join(here, "html", file))
       end
 
-      def title(isoxml, _out)
-        { doctitle: "//bibdata/title[@language='#{@lang}'][@type = 'main']",
-          docsubtitle: "//bibdata/title[@language='#{@lang}']" \
+      TITLE_XPATHS =
+        { doctitle: "//bibdata/title[@language='@_lang'][@type = 'main']",
+          docsubtitle: "//bibdata/title[@language='@_lang']" \
                        "[@type = 'subtitle']",
-          amendmenttitle: "//bibdata/title[@language='#{@lang}']" \
+          amendmenttitle: "//bibdata/title[@language='@_lang']" \
                           "[@type = 'amendment']",
-          corrigendumtitle: "//bibdata/title[@language='#{@lang}']" \
+          corrigendumtitle: "//bibdata/title[@language='@_lang']" \
                             "[@type = 'corrigendum']",
           series: "//bibdata/series[@type='main']/title",
           series1: "//bibdata/series[@type='secondary']/title",
           series2: "//bibdata/series[@type='tertiary']/title",
           annextitle: "//bibdata/title[@type='annex']",
-          positiontitle: "//bibdata/title[@type='position-sp']" }.each do |k, v|
-          titleset(isoxml, k, v)
+          collectiontitle: "//bibdata/title[@type='collection']",
+          slogantitle: "//bibdata/title[@type='slogan']",
+          positiontitle: "//bibdata/title[@type='position-sp']" }.freeze
+
+      def title(isoxml, _out)
+        TITLE_XPATHS.each do |k, v|
+          titleset(isoxml, k, v.sub("@_lang", @lang))
         end
+        titleset(isoxml, :doctitle_en,
+                 "//bibdata/title[@language='en'][@type = 'main']") or
+          titleset(isoxml, :doctitle_en,
+                   "//bibdata/title[@language='#{@lang}'][@type = 'main']")
       end
 
       def titleset(isoxml, key, xpath)
@@ -44,6 +53,7 @@ module IsoDoc
           end
         end.join
         set(key, out.sub(%r{^<span>}, "").sub(%r{</span>$}, ""))
+        true
       end
 
       def subtitle(_isoxml, _out)
@@ -51,12 +61,21 @@ module IsoDoc
       end
 
       def author(xml, _out)
-        bureau = xml.at(ns("//bibdata/ext/editorialgroup/bureau"))
-        set(:bureau, bureau.text) if bureau
+        sector = xml.at(ns("//bibdata/ext/editorialgroup/sector"))
+        set(:sector, sector.text) if sector
+        bureau(xml)
         tc = xml.at(ns("//bibdata/ext/editorialgroup/committee"))
         set(:tc, tc.text) if tc
         tc = xml.at(ns("//bibdata/ext/editorialgroup/group/name"))
         set(:group, tc.text) if tc
+        tc = xml.at(ns("//bibdata/ext/editorialgroup/group/acronym"))
+        set(:group_acronym, tc.text) if tc
+        start1 = xml.at(ns("//bibdata/ext/editorialgroup/group/period/start"))
+        end1 = xml.at(ns("//bibdata/ext/editorialgroup/group/period/end"))
+        if start1
+          set(:study_group_period,
+              @i18n.l10n("#{start1.text}–#{end1.text}"))
+        end
         tc = xml.at(ns("//bibdata/ext/editorialgroup/subgroup/name"))
         set(:subgroup, tc.text) if tc
         tc = xml.at(ns("//bibdata/ext/editorialgroup/workgroup/name"))
@@ -67,20 +86,34 @@ module IsoDoc
         person_attributes(authors) unless authors.empty?
       end
 
+      def bureau(xml)
+        if bureau = xml.at(ns("//bibdata/ext/editorialgroup/bureau"))
+          set(:bureau, bureau.text)
+          case bureau.text
+          when "T" then set(:bureau_full, @i18n.tsb_full)
+          when "D" then set(:bureau_full, @i18n.bdt_full)
+          when "R" then set(:bureau_full, @i18n.br_full)
+          end
+        end
+      end
+
       def append(key, value)
         @metadata[key] << value
       end
 
+      PERSON_ATTRS = { affiliations: "./affiliation/organization/name",
+                       addresses: "./affiliation/organization/address/" \
+                                     "formattedAddress",
+                       emails: "./email",
+                       faxes: "./phone[@type = 'fax']",
+                       phones: "./phone[not(@type = 'fax')]" }.freeze
+
       def person_attributes(authors)
-        %i(affiliations addresses emails faxes phones).each { |i| set(i, []) }
+        PERSON_ATTRS.each_key { |k| set(k, []) }
         authors.each do |a|
-          append(:affiliations,
-                 a.at(ns("./affiliation/organization/name"))&.text)
-          append(:addresses, a.at(ns("./affiliation/organization/address/" \
-                                     "formattedAddress"))&.text)
-          append(:emails, a.at(ns("./email"))&.text)
-          append(:faxes, a.at(ns("./phone[@type = 'fax']"))&.text)
-          append(:phones, a.at(ns("./phone[not(@type = 'fax')]"))&.text)
+          PERSON_ATTRS.each do |k, v|
+            append(k, a.at(ns(v))&.text)
+          end
         end
       end
 
@@ -130,6 +163,9 @@ module IsoDoc
       def keywords(isoxml, _out)
         super
         set(:keywords, get[:keywords].sort)
+        q = isoxml.xpath(ns("//bibdata/ext/question/identifier"))
+        q.empty? or set(:questions,
+                        q.map { |x| x.text.sub(/^Q/, "") }.join(", "))
       end
 
       def doctype(isoxml, _out)

data/lib/isodoc/itu/presentation_preface.rb

@@ -2,8 +2,13 @@ module IsoDoc
   module ITU
     class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
       def insert_preface_sections(docxml)
-        x = insert_editors_clause(docxml) and
-          editors_insert_pt(docxml).next = x
+        if @doctype == "contribution"
+          x = contribution_table(docxml) and
+            contribution_table_insert_pt(docxml).next = x
+        else
+          x = insert_editors_clause(docxml) and
+            editors_insert_pt(docxml).next = x
+        end
       end
 
       def editors_insert_pt(docxml)
@@ -13,6 +18,74 @@ module IsoDoc
         docxml.at(ns("//preface")).children[-1]
       end
 
+      def contribution_table_insert_pt(docxml)
+        docxml.at(ns("//preface")) || docxml.at(ns("//sections"))
+          .add_previous_sibling("<preface> </preface>").first
+        docxml.at(ns("//preface")).children.first.before(" ").previous
+      end
+
+      def contribution_table(_doc)
+        @doctype == "contribution" or return
+        bureau = bold_and_upcase(@meta.get[:bureau_full])
+        <<~TABLE
+          <clause unnumbered="true" type="contribution-metadata">
+          <table class="contribution-metadata" unnumbered="true" width="100%">
+          <colgroup><col width="11.8%"/><col width="41.2%"/><col width="47.0%"/></colgroup>
+          <thead>
+          <tr><th rowspan="3"><image height="56" width="56" src="#{@meta.get[:logo_small]}"/></th>
+          <td rowspan="3"><p style="font-size:8pt;margin-top:6pt;margin-bottom:0pt;">#{@i18n.international_telecommunication_union.upcase}</p>
+          <p class="bureau_big" style="font-size:13pt;margin-top:6pt;margin-bottom:0pt;">#{bureau}</p>
+          <p style="font-size:10pt;margin-top:6pt;margin-bottom:0pt;">#{@i18n.studyperiod.sub('%', @meta.get[:study_group_period]).upcase}</p></th>
+          <th align="right"><p style="font-size:16pt;">#{@meta.get[:docnumber]}</p></th></tr>
+          <tr><th align="right"><p  style="font-size:14pt;">#{@meta.get[:group].upcase}</p></th></tr>
+          <tr>
+          <th align="right"><p style="font-size:14pt;">#{@i18n.l10n("#{@i18n.original}: #{@i18n.current_language}")}</p></th>
+          </tr></thead>
+          <tbody>
+          <tr><th align="left" width="95">#{colon_i18n(@i18n.questions)}</th><td>#{@meta.get[:questions]}</td>
+          <td align="right">#{@i18n.l10n("#{@meta.get[:meeting_place]}, #{@meta.get[:meeting_date]}")}</td></tr>
+          <tr><th align="center" colspan="3">#{@i18n.get['doctype_dict']['contribution'].upcase}</th></tr>
+          <tr><th align="left" width="95">#{colon_i18n(@i18n.document_source)}</th><td colspan="2">#{@meta.get[:source]}</td></tr>
+          <tr><th align="left" width="95">#{colon_i18n(@i18n.title)}</th><td colspan="2">#{@meta.get[:doctitle_en]}</td></tr>
+          #{contribution_table_contacts}
+          </tbody></table>
+          </clause>
+        TABLE
+      end
+
+      def colon_i18n(text)
+        @i18n.l10n("#{text}:")
+      end
+
+      def bold_and_upcase(xml)
+        x = Nokogiri::XML("<root>#{xml}</root>")
+        x.traverse do |e|
+          e.text? or next
+          e.replace("<strong>#{e.text.upcase}</strong>")
+        end
+        x.root.children.to_xml
+      end
+
+      def contribution_table_contacts
+        n = (0..@meta.get[:authors]&.size).each_with_object([]) do |i, ret|
+          ret << contribution_table_contact(i)
+        end
+        n.map do |x|
+          lbl = colon_i18n(@i18n.contact)
+          "<tr><th align='left' width='95'>#{lbl}</th>#{x}</tr>"
+        end.join("\n")
+      end
+
+      def contribution_table_contact(idx)
+        <<~CELL
+          <td>#{@meta.get[:authors][idx]}<br/>
+          #{@meta.get[:affiliations][idx]}<br/>
+          #{@meta.get[:addresses][idx]}</td>
+          <td>#{@i18n.tel_abbrev}<tab/>#{@meta.get[:phones][idx]}<br/>
+          #{@i18n.email}<tab/>#{@meta.get[:emails][idx]}</td>
+        CELL
+      end
+
       def insert_editors_clause(doc)
         ret = extract_editors(doc) or return
         eds = ret[:names].each_with_object([]).with_index do |(_x, acc), i|
@@ -57,19 +130,47 @@ module IsoDoc
 
       def rearrange_clauses(docxml)
         super
-        k = keywords(docxml) or return
-        if a = docxml.at(ns("//preface/abstract"))
-          a.next = k
-        elsif a = docxml.at(ns("//preface"))
-          a.children.first.previous = k
+        insert_preface_sections(docxml)
+        a = docxml.at(ns("//preface/abstract"))
+        keywords_abstract_swap(a, keywords(docxml), docxml)
+        c = docxml.at(ns("//preface/clause[@type='contribution-metadata']")) and
+          a and c.next = a
+        abstract_render(a)
+      end
+
+      def keywords_abstract_swap(abstract, keywords, docxml)
+        @doctype == "contribution" and return
+        keywords or return
+        if abstract then abstract.next = keywords
+        else
+          p = contribution_table_insert_pt(docxml)
+          p.next = keywords
         end
       end
 
+      def abstract_render(abstract)
+        @doctype == "contribution" or return
+        abstract.at(ns("./title"))&.remove
+        abstract.children = <<~TABLE
+          <table class="abstract" unnumbered="true" width="100%">
+          <colgroup><col width="11.8%"/><col width="78.2%"/></colgroup>
+          <tbody>
+          <tr><th align="left" width="95"><p>#{colon_i18n(@i18n.abstract)}</p></th>
+          <td>#{abstract.children.to_xml}</td></tr>
+          </tbody></table>
+        TABLE
+      end
+
       def keywords(_docxml)
         kw = @meta.get[:keywords]
-        kw.nil? || kw.empty? and return
+        kw.nil? || kw.empty? || @doctype == "contribution" and return
         "<clause type='keyword'><title>#{@i18n.keywords}</title>" \
-          "<p>#{kw.join(', ')}.</p>"
+          "<p>#{@i18n.l10n(kw.join(', '))}.</p>"
+      end
+
+      def toc_title(docxml)
+        %w(resolution contribution).include?(@doctype) and return
+        super
       end
 
       include Init

data/lib/isodoc/itu/presentation_ref.rb

@@ -24,29 +24,34 @@ module IsoDoc
       end
 
       def multi_bibitem_ref_code(bib)
-        skip = IsoDoc::Function::References::SKIP_DOCID
-        skip1 = "@type = 'metanorma' or @type = 'metanorma-ordinal'"
-        prim = "[@primary = 'true']"
-        id = bib.xpath(ns("./docidentifier#{prim}[not(#{skip} or #{skip1})]"))
-        id.empty? and id = bib.xpath(ns("./docidentifier#{prim}[not(#{skip1})]"))
-        id.empty? and id = bib.xpath(ns("./docidentifier[not(#{skip} or #{skip1})]"))
-        id.empty? and id = bib.xpath(ns("./docidentifier[not(#{skip1})]"))
-        id.empty? and return id
-        id.sort_by { |i| i["type"] == "ITU" ? 0 : 1 }
+        id = pref_ref_code_parse(bib)
+        id.nil? and return []
+        id.sort_by { |i| /^ITU/.match?(i) ? 0 : 1 }
       end
 
-      def render_multi_identifiers(ids)
+      def render_multi_identifiers(ids, bib)
         ids.map do |id|
-          if id["type"] == "ITU" then doctype_title(id)
+          if /^ITU/.match?(id) then doctype_title(id, bib)
           else
-            docid_prefix(id["type"], id.text.sub(/^\[/, "").sub(/\]$/, ""))
+            id.sub(/^\[/, "").sub(/\]$/, "")
           end
         end.join(" | ")
       end
 
+      def doctype_title(id, bib)
+        type = bib.at(ns("./ext/doctype"))&.text || "recommendation"
+        if type == "recommendation" &&
+            /^(?<prefix>ITU-[A-Z][  ][A-Z])[  .-]Sup[a-z]*\.[  ]?(?<num>\d+)$/ =~ id
+          "#{prefix}-series Recommendations – Supplement #{num}"
+        else
+          d = id.sub(/^\[/, "").sub(/\]$/, "")
+          "#{titlecase(type)} #{d}"
+        end
+      end
+
       def reference_format_start(bib)
         id = multi_bibitem_ref_code(bib)
-        id1 = render_multi_identifiers(id)
+        id1 = render_multi_identifiers(id, bib)
         out = id1
         date = bib.at(ns("./date[@type = 'published']/on | " \
           "./date[@type = 'published']/from")) and

data/lib/isodoc/itu/presentation_xml_convert.rb

@@ -25,11 +25,6 @@ module IsoDoc
         super
       end
 
-      def convert1(docxml, filename, dir)
-        insert_preface_sections(docxml)
-        super
-      end
-
       def eref(docxml)
         docxml.xpath(ns("//eref")).each { |f| eref1(f) }
       end
@@ -87,24 +82,12 @@ module IsoDoc
         str.gsub(/ |_|-/, " ").split(/ /).map(&:capitalize).join(" ")
       end
 
-      def doctype_title(id)
-        type = id.parent&.at(ns("./ext/doctype"))&.text || "recommendation"
-        if type == "recommendation" &&
-            /^(?<prefix>ITU-[A-Z][  ][A-Z])[  .-]Sup[a-z]*\.[  ]?(?<num>\d+)$/ =~ id.text
-          "#{prefix}-series Recommendations – Supplement #{num}"
-        else
-          d = docid_prefix(id["type"], id.text.sub(/^\[/, "").sub(/\]$/, ""))
-          "#{titlecase(type)} #{d}"
-        end
-      end
-
       def twitter_cldr_localiser_symbols
         { group: "'" }
       end
 
       def clause1(elem)
-        @doctype == "resolution" or return super
-        %w(sections bibliography).include? elem.parent.name or return super
+        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) or return
@@ -113,6 +96,11 @@ module IsoDoc
           "#{@i18n.get['section'].upcase} #{lbl}</p>"
       end
 
+      def clause1_super?(elem)
+        @doctype != "resolution" ||
+          !%w(sections bibliography).include?(elem.parent.name)
+      end
+
       def annex1(elem)
         @doctype == "resolution" or return super
         elem.elements.first.previous = annex1_supertitle(elem)
@@ -145,16 +133,13 @@ module IsoDoc
         super
       end
 
-      def toc_title(docxml)
-        @doctype == "resolution" and return
-        super
-      end
-
       def middle_title(isoxml)
         s = isoxml.at(ns("//sections")) or return
         titfn = isoxml.at(ns("//note[@type = 'title-footnote']"))
-        if @meta.get[:doctype] == "Resolution"
+        case @doctype
+        when "resolution"
           middle_title_resolution(isoxml, s.children.first)
+        when "contribution"
         else
           middle_title_recommendation(isoxml, s.children.first)
         end
@@ -162,7 +147,8 @@ module IsoDoc
       end
 
       def renumber_footnotes(isoxml)
-        (isoxml.xpath(ns("//fn")) - isoxml.xpath(ns("//table//fn | //figure//fn")))
+        (isoxml.xpath(ns("//fn")) -
+         isoxml.xpath(ns("//table//fn | //figure//fn")))
           .each_with_index do |fn, i|
             fn["reference"] = (i + 1).to_s
           end
@@ -223,7 +209,8 @@ module IsoDoc
 
       def dl1(dlist)
         ins = dlist.at(ns("./dt"))
-        ins.previous = '<colgroup><col width="20%"/><col width="80%"/></colgroup>'
+        ins.previous =
+          '<colgroup><col width="20%"/><col width="80%"/></colgroup>'
       end
 
       include Init

data/lib/isodoc/itu/word_cleanup.rb

@@ -32,11 +32,11 @@ module IsoDoc
 
       def word_title_cleanup(docxml)
         docxml.xpath("//p[@class = 'annex_obligation']").each do |h|
-          h&.next_element&.name == "p" or next
+          h.next_element&.name == "p" or next
           h.next_element["class"] ||= "Normalaftertitle"
         end
         docxml.xpath("//p[@class = 'FigureTitle']").each do |h|
-          h&.parent&.next_element&.name == "p" or next
+          h.parent&.next_element&.name == "p" or next
           h.parent.next_element["class"] ||= "Normalaftertitle"
         end
       end
@@ -103,8 +103,8 @@ module IsoDoc
 
       def authority_hdr_cleanup2(docxml)
         %w(copyright license legal).each do |t|
-          docxml&.xpath("//div[@class = 'boilerplate-#{t}']")&.each do |d|
-            para = d&.at("./descendant::h1[2]") and
+          docxml.xpath("//div[@class = 'boilerplate-#{t}']")&.each do |d|
+            para = d.at("./descendant::h1[2]") and
               para.previous = "<p>&#xa0;</p><p>&#xa0;</p><p>&#xa0;</p>"
             d.xpath(".//h1 | .//h2").each do |p|
               p.name = "p"

data/lib/isodoc/itu/word_convert.rb

@@ -21,9 +21,24 @@ module IsoDoc
         end
       end
 
+      def make_body1(body, _docxml)
+        @wordcoverpage or return
+        super
+      end
+
+      def make_body2(body, docxml)
+        body.div class: "WordSection2" do |div2|
+          boilerplate docxml, div2
+          content(div2, docxml, ns("//preface/*[@displayorder]"))
+          div2.p { |p| p << "&#xa0;" } # placeholder
+        end
+        @doctype == "contribution" or section_break(body)
+      end
+
       def abstract(clause, out)
         out.div **attr_code(id: clause["id"], class: "Abstract") do |s|
-          clause_name(clause, "Summary", s, class: "AbstractTitle")
+          @doctype == "contribution" or
+            clause_name(clause, "Summary", s, class: "AbstractTitle")
           clause.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
       end
@@ -42,10 +57,14 @@ module IsoDoc
       end
 
       def convert1(docxml, filename, dir)
-        if @doctype == "service-publication"
+        case @doctype
+        when "service-publication"
           @wordcoverpage = html_doc_path("word_itu_titlepage_sp.html")
           options[:bodyfont] = "Arial"
           options[:headerfont] = "Arial"
+        when "contribution"
+          @wordcoverpage = nil
+          @wordintropage = nil
         end
         super
       end

data/lib/metanorma/itu/biblio.rng

@@ -208,7 +208,9 @@
   </define>
   <define name="roledescription">
     <element name="description">
-      <ref name="FormattedString"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="person">
@@ -333,7 +335,9 @@
   </define>
   <define name="affiliationdescription">
     <element name="description">
-      <ref name="FormattedString"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="organization">
@@ -897,7 +901,9 @@
   </define>
   <define name="formattedref">
     <element name="formattedref">
-      <ref name="FormattedString"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="license">
@@ -942,7 +948,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
-    <ref name="FormattedString"/>
+    <zeroOrMore>
+      <ref name="TextElement"/>
+    </zeroOrMore>
   </define>
   <!-- TitleType = ( "alternative" | "original" | "unofficial" | "subtitle" | "main" ) -->
   <define name="TypedUri">
@@ -1042,7 +1050,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="docnumber">
@@ -1267,12 +1277,16 @@
       <optional>
         <attribute name="type"/>
       </optional>
-      <ref name="FormattedString"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="bibabstract">
     <element name="abstract">
-      <ref name="FormattedString"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="copyright">
@@ -1377,7 +1391,9 @@
       </attribute>
       <optional>
         <element name="description">
-          <ref name="FormattedString"/>
+          <oneOrMore>
+            <ref name="TextElement"/>
+          </oneOrMore>
         </element>
       </optional>
       <element name="bibitem">