metanorma-ieee 0.0.2 → 0.0.3

data/lib/isodoc/ieee/metadata.rb

@@ -6,11 +6,13 @@ module IsoDoc
     class Metadata < IsoDoc::Metadata
       def initialize(lang, script, i18n, fonts_options = {})
         super
-        @metadata[:confirmeddate] = "&lt;Date Approved&gt;"
+        @metadata[:issueddate] = "&lt;Date Approved&gt;"
       end
 
       def bibdate(isoxml, _out)
-        super
+        isoxml.xpath(ns("//bibdata/date[@format = 'ddMMMyyyy']")).each do |d|
+          set("#{d['type'].gsub(/-/, '_')}date".to_sym, Common::date_range(d))
+        end
         draft = isoxml.at(ns("//bibdata/date[@type = 'issued']")) ||
           isoxml.at(ns("//bibdata/date[@type = 'circulated']")) ||
           isoxml.at(ns("//bibdata/date[@type = 'created']")) ||
@@ -25,8 +27,10 @@ module IsoDoc
         b = isoxml.at(ns("//bibdata/ext/doctype"))&.text or return
         set(:doctype, b.split(/[- ]/).map(&:capitalize).join(" "))
         set(:doctype_abbrev, @labels["doctype_abbrev"][b])
-        s = isoxml.at(ns("//bibdata/ext/docsubtype"))&.text and
+        s = isoxml.at(ns("//bibdata/ext/subdoctype"))&.text and
           set(:docsubtype, s.split(/[- ]/).map(&:capitalize).join(" "))
+        s = isoxml.at(ns("//bibdata/ext/trial-use"))&.text and s == "true" and
+          set(:trial_use, true)
       end
 
       def author(xml, _out)
@@ -35,7 +39,6 @@ module IsoDoc
         tc(xml)
         wg(xml)
         bg(xml)
-        std_group(xml)
       end
 
       def society(xml)
@@ -50,59 +53,17 @@ module IsoDoc
         set(:technical_committee, tc)
       end
 
-      def editor_names(xml, role)
-        xml.xpath(ns("//bibdata/contributor[role/@type = 'editor']"\
-                     "[role = '#{role}']/person/name/completename"))
-          &.each&.map(&:text)
-      end
-
-      def editor_name(xml, role)
-        editor_names(xml, role)&.first
-      end
-
       def wg(xml)
         wg = xml.at(ns("//bibdata/ext/editorialgroup/"\
                        "working-group")) or return nil
         set(:working_group, wg.text)
-        m = {}
-        ["Chair", "Vice-Chair", "Secretary"].each do |r|
-          a = editor_name(xml, "Working Group #{r}") and
-            m[r.downcase.gsub(/ /, "-")] = a
-        end
-        wg_members(xml, m)
-      end
-
-      def wg_members(xml, members)
-        a = editor_names(xml, "Working Group Member") and members["members"] = a
-        members["members"].empty? and (1..9).each do |i|
-          members["members"] << "Participant#{i}"
-        end
-        set(:wg_members, members)
       end
 
       def bg(xml)
         bg = xml.at(ns("//bibdata/ext/editorialgroup/"\
                        "balloting-group")) or return nil
         set(:balloting_group, bg.text)
-        m = {}
-        m["members"] = editor_names(xml, "Balloting Group Member")
-        m["members"].empty? and (1..9).each do |i|
-          m["members"] << "Balloter#{i}"
-        end
-        set(:balloting_group_members, m["members"])
-      end
-
-      def std_group(xml)
-        m = {}
-        ["Chair", "Vice-Chair", "Past Chair", "Secretary"].each do |r|
-          m[r.downcase.gsub(/ /, "-")] =
-            editor_name(xml, "Standards Board #{r}") || "&lt;Name&gt;"
-        end
-        m["members"] = editor_names(xml, "Standards Board Member")
-        m["members"].empty? and (1..9).each do |i|
-          m["members"] << "SBMember#{i}"
-        end
-        set(:std_board, m)
+        set(:balloting_group_type, bg["type"])
       end
 
       def otherid(isoxml, _out)
@@ -120,6 +81,10 @@ module IsoDoc
         set(:stdid_pdf, dn&.text || "STDXXXXX")
         dn = isoxml.at(ns("//#{id}[@scope = 'print']"))
         set(:stdid_print, dn&.text || "STDPDXXXXX")
+        dn = isoxml.at(ns("//bibdata/ext/structuredidentifier/amendment")) and
+          set(:amd, dn.text)
+        dn = isoxml.at(ns("//bibdata/ext/structuredidentifier/corrigendum")) and
+          set(:corr, dn.text)
       end
 
       def title(isoxml, _out)
@@ -152,6 +117,19 @@ module IsoDoc
         end
         set(type.to_sym, ret)
       end
+
+      def ddMMMyyyy(isodate)
+        return nil if isodate.nil?
+
+        arr = isodate.split("-")
+        if arr.size == 1 && (/^\d+$/.match isodate)
+          Date.new(*arr.map(&:to_i)).strftime("%Y")
+        elsif arr.size == 2
+          Date.new(*arr.map(&:to_i)).strftime("%b %Y")
+        else
+          Date.parse(isodate).strftime("%d %b %Y")
+        end
+      end
     end
   end
 end

data/lib/isodoc/ieee/pdf_convert.rb

@@ -12,8 +12,8 @@ module IsoDoc
       end
 
       def pdf_stylesheet(docxml)
-        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
-        if doctype == "amendment"
+        doctype = docxml&.at(ns("//bibdata/ext/subdoctype"))&.text
+        if %w(amendment corrigendum erratum).include?(doctype)
           "ieee.amendment.xsl"
         else
           "ieee.standard.xsl"

data/lib/isodoc/ieee/presentation_ref.rb

@@ -0,0 +1,70 @@
+module IsoDoc
+  module IEEE
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      # Style manual 19
+      def anchor_linkend(node, linkend)
+        @bibanchors ||= biblio_ids_titles(node.document)
+        if node["citeas"] && i = @bibanchors[node["bibitemid"]]
+          biblio_anchor_linkend(node, i)
+        else super
+        end
+      end
+
+      def biblio_anchor_linkend(node, bib)
+        if %w(techreport standard).include?(bib[:type])
+          node["citeas"] + " #{bib[:ord]}"
+        else
+          "#{bib[:title]} " + node["citeas"]
+        end
+      end
+
+      def biblio_ids_titles(xmldoc)
+        xmldoc.xpath(ns("//references[@normative = 'false']/bibitem"))
+          .each_with_object({}) do |b, m|
+          m[b["id"]] =
+            { docid: pref_ref_code(b), type: b["type"],
+              title: b.at(ns("./title"))&.text ||
+                     b.at(ns("./formattedref"))&.text,
+              ord: b.at(ns("./docidentifier[@type = 'metanorma' or "\
+                           "@type = 'metanorma-ordinal']")).text }
+        end
+      end
+
+      def bibrenderer
+        ::Relaton::Render::IEEE::General.new(language: @lang,
+                                             i18nhash: @i18n.get)
+      end
+
+      def bibrender_relaton(xml)
+        bib = xml.dup
+        bib["suppress_identifier"] == true and
+          bib.xpath(ns("./docidentifier")).each(&:remove)
+        xml.children =
+          "#{bibrenderer.render(bib.to_xml)}"\
+          "#{xml.xpath(ns('./docidentifier | ./uri | ./note | ./title')).to_xml}"
+      end
+
+      def creatornames(bibitem)
+        ::Relaton::Render::IEEE::General
+          .new(language: @lang, i18nhash: @i18n.get,
+               template: { (bibitem["type"] || "misc").to_sym =>
+                           "{{ creatornames }}" })
+          .parse1(RelatonBib::XMLParser.from_xml(bibitem.to_xml))
+      end
+
+      def bibliography_bibitem_number1(bibitem, idx)
+        if mn = bibitem.at(ns(".//docidentifier[@type = 'metanorma']"))
+          /^\[?\d\]?$/.match?(mn&.text) and
+            idx = mn.text.sub(/^\[B?/, "").sub(/\]$/, "").to_i
+        end
+        unless bibliography_bibitem_number_skip(bibitem)
+
+          idx += 1
+          bibitem.at(ns(".//docidentifier")).previous =
+            "<docidentifier type='metanorma-ordinal'>[B#{idx}]</docidentifier>"
+        end
+        idx
+      end
+    end
+  end
+end

data/lib/isodoc/ieee/presentation_terms.rb

@@ -12,7 +12,8 @@ module IsoDoc
         c = IsoDoc::XrefGen::Counter.new("@")
         elem.xpath(ns("./definition")).each do |d|
           c.increment(d)
-          d.elements.first.previous = "<strong>(#{c.print})</strong>&#xa0;"
+          d.elements.first.children.first.previous =
+            "<strong>(#{c.print})</strong>&#xa0;"
         end
       end
 
@@ -20,9 +21,20 @@ module IsoDoc
         ins = elem.at(ns("./definition")).previous_element
         coll = elem.xpath(ns("./definition"))
         coll.each(&:remove)
-        ins.next = "<definition>#{coll.map do |c|
-                                    c.children.to_xml
-                                  end }</definition>"
+        ins.next = "<definition>#{unwrap_multidef(coll)}</definition>"
+      end
+
+      def unwrap_multidef(coll)
+        if coll.all? do |c|
+          c.elements.size == 1 && c.elements.first.name == "p"
+        end
+          ret = coll.map do |c|
+            c.elements.first.children.to_xml
+          end
+          "<p>#{ret.join}</p>"
+        else
+          coll.map { |c| c.children.to_xml }.join
+        end
       end
 
       def unwrap_definition(docxml)
@@ -60,10 +72,10 @@ module IsoDoc
 
       def sort_terms_key(term)
         d = term.at(ns("./preferred/expression/name | "\
-                       "./preferred/letter-designation/name | "\
+                       "./preferred/letter-symbol/name | "\
                        "./preferred/graphical-symbol/figure/name | "\
                        "./preferred/graphical-symbol/figure/@id"))
-        d&.text&.downcase
+        HTMLEntities.new.decode(d&.text&.strip&.downcase) || "ZZZ"
       end
 
       def term_related_reorder(coll)
@@ -99,21 +111,47 @@ module IsoDoc
 
       def admitted_to_related(docxml)
         docxml.xpath(ns("//term/admitted")).each do |a|
-          a["type"] = "equivalent"
-          a.name = "related"
-          a.children = "<preferred>#{a.children.to_xml}</preferred>"
+          admitted_to_related1(a, a.parent.at(ns("./preferred")))
         end
+        term_reorder(docxml)
       end
 
-      def collapse_term(docxml)
-        docxml.xpath(ns("//term")).each do |t|
-          collapse_term1(t)
+      def admitted_to_related1(adm, pref)
+        new = adm.dup
+        adm["type"] = "equivalent"
+        adm.name = "related"
+        adm.children = "<preferred>#{adm.children.to_xml}</preferred>"
+        adm.parent.next = <<~TERM
+          <term><preferred>#{new.children.to_xml}</preferred>
+          <related type='see'><preferred>#{pref.children.to_xml}</preferred></related></term>
+        TERM
+      end
+
+      def term_reorder(xmldoc)
+        xmldoc.xpath(ns("//terms")).each { |t| term_reorder1(t) }
+      end
+
+      def term_reorder1(terms)
+        ins = terms.at(ns("./term"))&.previous_element or return
+        coll = terms.xpath(ns("./term"))
+        ret = sort_terms(coll)
+        coll.each(&:remove)
+        ret.reverse.each { |t| ins.next = t }
+      end
+
+      def sort_terms(terms)
+        terms.sort do |a, b|
+          sort_terms_key(a) <=> sort_terms_key(b)
         end
       end
 
+      def collapse_term(docxml)
+        docxml.xpath(ns("//term")).each { |t| collapse_term1(t) }
+      end
+
       def collapse_term1(term)
         ret = collapse_term_template(
-          pref: term.at(ns("./preferred")).remove,
+          pref: term.at(ns("./preferred"))&.remove,
           def: term.at(ns("./definition")),
           rels: term.xpath(ns("./related")).map(&:remove),
           source: term.at(ns("./termsource")),
@@ -124,8 +162,9 @@ module IsoDoc
 
       def collapse_term_related(rels)
         ret = rels.map do |r|
+          p = r.at(ns("./preferred"))
           "<em>#{@i18n.relatedterms[r['type']]}:</em> "\
-            "#{r.at(ns('./preferred')).children.to_xml}"
+            "#{p&.children&.to_xml || '**RELATED TERM NOT FOUND**'}"
         end.join(". ")
         ret += "." unless ret.empty?
         ret
@@ -136,7 +175,7 @@ module IsoDoc
         src = nil
         opt[:source] and src = "(#{opt[:source].remove.children.to_xml.strip})"
         <<~TERM
-          <p>#{opt[:pref].children.to_xml}: #{defn}
+          <p>#{opt[:pref]&.children&.to_xml || '**TERM NOT FOUND**'}: #{defn}
           #{collapse_term_related(opt[:rels])}
           #{src}</p>
         TERM
@@ -158,6 +197,14 @@ module IsoDoc
         while elem&.next_element&.name == "termsource"
           elem << "; #{elem.next_element.remove.children.to_xml}"
         end
+        adapt = termsource_adapt(elem["status"]) and
+          elem.children = l10n("#{adapt}#{elem.children.to_xml.strip}")
+      end
+
+      def termsource_adapt(status)
+        case status
+        when "adapted" then @i18n.adapted_from
+        end
       end
 
       def designation_field(desgn, name)
@@ -170,12 +217,12 @@ module IsoDoc
       end
 
       def merge_second_preferred(term)
-        super
-        term.xpath(ns("./preferred[expression/name]")).each_with_index do |p, i|
-          unless i.zero?
-            p.remove # whatever was eligible to display has already been merged
-          end
+        prefs = term.xpath(ns("./preferred[expression/name]"))
+        prefs.size > 1 or return
+        alts = prefs[1..-1].map do |p|
+          p.remove.at(ns("./expression/name")).children.to_xml.strip
         end
+        prefs.first.at(ns("./expression/name")) << " (#{alts.join(', ')})"
       end
 
       def termnote1(elem)

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -1,5 +1,6 @@
 require_relative "init"
 require_relative "presentation_terms"
+require_relative "presentation_ref"
 require "isodoc"
 
 module IsoDoc
@@ -53,35 +54,6 @@ module IsoDoc
         l10n(ret)
       end
 
-      # Style manual 19
-      def anchor_linkend(node, linkend)
-        @bibanchors ||= biblio_ids_titles(node.document)
-        if node["citeas"] && i = @bibanchors[node["bibitemid"]]
-          biblio_anchor_linkend(node, i)
-        else super
-        end
-      end
-
-      def biblio_anchor_linkend(node, bib)
-        if %w(techreport standard).include?(bib[:type])
-          node["citeas"] + " #{bib[:ord]}"
-        else
-          "#{bib[:title]} " + node["citeas"]
-        end
-      end
-
-      def biblio_ids_titles(xmldoc)
-        xmldoc.xpath(ns("//references[@normative = 'false']/bibitem"))
-          .each_with_object({}) do |b, m|
-          m[b["id"]] =
-            { docid: pref_ref_code(b), type: b["type"],
-              title: b.at(ns("./title"))&.text ||
-                     b.at(ns("./formattedref"))&.text,
-              ord: b.at(ns("./docidentifier[@type = 'metanorma' or "\
-                           "@type = 'metanorma-ordinal']")).text }
-        end
-      end
-
       def anchor_linkend1(node)
         linkend = @xrefs.anchor(node["target"], :xref)
         @xrefs.anchor(node["target"], :type) == "clause" &&
@@ -102,10 +74,8 @@ module IsoDoc
         return if elem.parent.name == "bibitem" || elem["notag"] == "true"
 
         n = @xrefs.get[elem["id"]]
-        lbl = if n.nil? || n[:label].nil? || n[:label].empty?
-                @i18n.note
-              else
-                l10n("#{@i18n.note} #{n[:label]}")
+        lbl = if n.nil? || n[:label].nil? || n[:label].empty? then @i18n.note
+              else l10n("#{@i18n.note} #{n[:label]}")
               end
         prefix_name(elem, block_delim, lbl, "name")
       end
@@ -124,48 +94,112 @@ module IsoDoc
         display_order_xpath(docxml, "//indexsect", i)
       end
 
-      def bibrenderer
-        ::Relaton::Render::IEEE::General.new(language: @lang,
-                                             i18nhash: @i18n.get)
+      def annex1(elem)
+        lbl = @xrefs.anchor(elem["id"], :label)
+        if t = elem.at(ns("./title"))
+          t.children = "<strong>#{t.children.to_xml}</strong>"
+        end
+        prefix_name(elem, "<br/>", lbl, "title")
       end
 
-      def bibrender_relaton(xml)
-        bib = xml.dup
-        bib["suppress_identifier"] == true and
-          bib.xpath(ns("./docidentifier")).each(&:remove)
-        xml.children =
-          "#{bibrenderer.render(bib.to_xml)}"\
-          "#{xml.xpath(ns('./docidentifier | ./uri | ./note | ./title')).to_xml}"
+      def bibdata_i18n(bib)
+        super
+        bibdata_dates(bib)
       end
 
-      def creatornames(bibitem)
-        ::Relaton::Render::IEEE::General
-          .new(language: @lang, i18nhash: @i18n.get,
-               template: { (bibitem["type"] || "misc").to_sym =>
-                           "{{ creatornames }}" })
-          .parse1(RelatonBib::XMLParser.from_xml(bibitem.to_xml))
+      def bibdata_dates(bib)
+        bib.xpath(ns("./date")).each do |d|
+          d.next = d.dup
+          d.next["format"] = "ddMMMyyyy"
+          d.next.xpath(ns("./from | ./to | ./on")).each do |x|
+            x.children = ddMMMyyyy(x.text)
+          end
+        end
       end
 
-      def bibliography_bibitem_number1(bibitem, idx)
-        if mn = bibitem.at(ns(".//docidentifier[@type = 'metanorma']"))
-          /^\[?\d\]?$/.match?(mn&.text) and
-            idx = mn.text.sub(/^\[B?/, "").sub(/\]$/, "").to_i
+      def ddMMMyyyy(isodate)
+        return nil if isodate.nil?
+
+        arr = isodate.split("-")
+        if arr.size == 1 && (/^\d+$/.match isodate)
+          Date.new(*arr.map(&:to_i)).strftime("%Y")
+        elsif arr.size == 2
+          Date.new(*arr.map(&:to_i)).strftime("%b %Y")
+        else
+          Date.parse(isodate).strftime("%d %b %Y")
         end
-        unless bibliography_bibitem_number_skip(bibitem)
+      end
 
-          idx += 1
-          bibitem.at(ns(".//docidentifier")).previous =
-            "<docidentifier type='metanorma-ordinal'>[B#{idx}]</docidentifier>"
+      def amend1(elem)
+        elem.xpath(ns("./description/p")).each do |p|
+          p.children = p.children.to_xml.strip
+          amend_format(p)
         end
-        idx
+        super
       end
 
-      def annex1(elem)
-        lbl = @xrefs.anchor(elem["id"], :label)
-        if t = elem.at(ns("./title"))
-          t.children = "<strong>#{t.children.to_xml}</strong>"
+      def amend_format(para)
+        2.times do
+          para.children.size == 1 &&
+            %(em strong).include?(para.children.first.name) and
+            para.children = para.elements.first.children
         end
-        prefix_name(elem, "<br/>", lbl, "title")
+        para.children = "<strong><em>#{para.children.to_xml}</em></strong>"
+      end
+
+      def section(docxml)
+        boilerplate(docxml)
+        super
+      end
+
+      def boilerplate(docxml)
+        docxml.xpath(ns("//clause[@id = 'boilerplate-participants']/"\
+                        "clause/title")).each(&:remove)
+        docxml.xpath(ns("//clause[@id = 'boilerplate-participants']/clause"))
+          .each do |clause|
+          participants(clause)
+        end
+      end
+
+      def participants(clause)
+        clause.xpath(ns(".//ul")).each_with_index do |ulist, idx|
+          ulist.xpath(ns("./li")).each { |list| participants1(list, idx) }
+          ulist.replace(ulist.children)
+        end
+      end
+
+      def participants1(list, idx)
+        key = ""
+        map = list.xpath(ns(".//dt | .//dd")).each_with_object({}) do |dtd, m|
+          (dtd.name == "dt" and key = dtd.text) or
+            m[key] = dtd.text.strip
+        end
+        list.replace(participant_para(map, idx))
+      end
+
+      def participant_para(map, idx)
+        name = participant_name(map)
+        if map["role"]&.casecmp("member")&.zero?
+          participant_member_para(map, name, idx)
+        else
+          participant_officeholder_para(map, name, idx)
+        end
+      end
+
+      def participant_member_para(map, name, _idx)
+        (map["company"] and "<p type='officeorgmember'>#{name}</p>") or
+          "<p type='officemember'>#{name}</p>"
+      end
+
+      def participant_officeholder_para(map, name, idx)
+        name = "<strong>#{name}</strong>" if idx.zero?
+        br = map["role"].size > 30 ? "<br/>" : ""
+        "<p type='officeholder' align='center'>#{name}, #{br}"\
+          "<em>#{map['role']}</em></p>"
+      end
+
+      def participant_name(map)
+        map["company"] || map["name"] || "#{map['given']} #{map['surname']}"
       end
 
       include Init

data/lib/isodoc/ieee/word_authority.rb

@@ -53,9 +53,9 @@ module IsoDoc
       def officeholder_style(para)
         n = para.next_element
         p = para.previous_element
-        n && n.name == "p" && n["type"] == "officeholder" and
+        n && n.name == "p" && n["type"] != "officeholder" and
           klass = "IEEEStdsNamesCtrCxSpLast"
-        p && p.name == "p" && p["type"] == "officeholder" and
+        p && p.name == "p" && p["type"] != "officeholder" and
           klass = "IEEEStdsNamesCtrCxSpFirst"
         para["class"] = klass || "IEEEStdsNamesCtrCxSpMiddle"
       end
@@ -68,7 +68,8 @@ module IsoDoc
       BREAK
 
       def officemember_style(docxml)
-        docxml.xpath("//p[@type = 'officemember']").each do |p|
+        docxml.xpath("//p[@type = 'officemember' or @type = 'officeorgmember']")
+          .each do |p|
           p["class"] = "IEEEStdsNamesList"
         end
         docxml.xpath("//p[@type = 'emeritus_sign']").each do |p|
@@ -85,6 +86,7 @@ module IsoDoc
 
       def three_column_officemembers_split(div)
         prev = false
+        div.xpath(".//div").each { |d| d.replace(d.children) }
         div.elements.each_with_object([[]]) do |e, m|
           member = e.name == "p" && e["type"] == "officemember"
           (prev == member and m[-1] << e.to_xml) or m << [e.to_xml]

data/lib/isodoc/ieee/word_convert.rb

@@ -12,6 +12,14 @@ module IsoDoc
         super
       end
 
+      def convert1(docxml, filename, dir)
+        doctype = docxml.at(ns("//bibdata/ext/doctype"))
+        if %w(amendment corrigendum).include?(doctype&.text)
+          @header = html_doc_path("header_amd.html")
+        end
+        super
+      end
+
       def default_fonts(options)
         { bodyfont: (if options[:script] == "Hans"
                        '"Source Han Sans",serif'
@@ -65,6 +73,10 @@ module IsoDoc
       def middle_title_ieee(_docxml, out)
         out.p(**{ class: "IEEEStdsTitle", style: "margin-top:70.0pt" }) do |p|
           p << @meta.get[:full_doctitle]
+          @meta.get[:amd] || @meta.get[:corr] and p << "<br/>"
+          @meta.get[:amd] and p << "Amendment #{@meta.get[:amd]}"
+          @meta.get[:amd] && @meta.get[:corr] and p << " "
+          @meta.get[:corr] and p << "Corrigenda #{@meta.get[:corr]}"
         end
       end