metanorma-ieee 0.0.1

data/lib/isodoc/ieee/init.rb

@@ -0,0 +1,28 @@
+require "isodoc"
+require_relative "metadata"
+require_relative "xref"
+require_relative "i18n"
+
+module IsoDoc
+  module IEEE
+    module Init
+      def metadata_init(lang, script, i18n)
+        @meta = Metadata.new(lang, script, i18n)
+      end
+
+      def xref_init(lang, script, _klass, i18n, options)
+        html = HtmlConvert.new(language: lang, script: script)
+        options = options.merge(hierarchical_assets: @hierarchical_assets)
+        @xrefs = Xref.new(lang, script, html, i18n, options)
+      end
+
+      def i18n_init(lang, script, i18nyaml = nil)
+        @i18n = I18n.new(lang, script, i18nyaml: i18nyaml || @i18nyaml)
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+    end
+  end
+end

data/lib/isodoc/ieee/metadata.rb

@@ -0,0 +1,136 @@
+require "isodoc"
+require "twitter_cldr"
+
+module IsoDoc
+  module IEEE
+    class Metadata < IsoDoc::Metadata
+      def initialize(lang, script, i18n, fonts_options = {})
+        super
+        @metadata[:confirmeddate] = "&lt;Date Approved&gt;"
+      end
+
+      def bibdate(isoxml, _out)
+        super
+        draft = isoxml.at(ns("//bibdata/date[@type = 'issued']")) ||
+          isoxml.at(ns("//bibdata/date[@type = 'circulated']")) ||
+          isoxml.at(ns("//bibdata/date[@type = 'created']")) ||
+          isoxml.at(ns("//bibdata/version/revision-date")) or return
+        date = DateTime.parse(draft.text)
+        set(:draft_month, date.strftime("%B"))
+        set(:draft_year, date.strftime("%Y"))
+      rescue StandardError
+      end
+
+      def doctype(isoxml, _out)
+        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
+          set(:docsubtype, s.split(/[- ]/).map(&:capitalize).join(" "))
+      end
+
+      def author(xml, _out)
+        super
+        society(xml)
+        tc(xml)
+        wg(xml)
+        bg(xml)
+        std_group(xml)
+      end
+
+      def society(xml)
+        society = xml.at(ns("//bibdata/ext/editorialgroup/"\
+                            "society"))&.text || "&lt;Society&gt;"
+        set(:society, society)
+      end
+
+      def tc(xml)
+        tc = xml.at(ns("//bibdata/ext/editorialgroup/"\
+                       "technical-committee"))&.text || "&lt;Committee Name&gt;"
+        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)
+      end
+
+      def otherid(isoxml, _out)
+        id = "bibdata/docidentifier[@type = 'ISBN']"
+        dn = isoxml.at(ns("//#{id}[@scope = 'PDF']"))
+        set(:isbn_pdf, dn&.text || "978-0-XXXX-XXXX-X")
+        dn = isoxml.at(ns("//#{id}[@scope = 'print']"))
+        set(:isbn_print, dn&.text || "978-0-XXXX-XXXX-X")
+      end
+
+      def docid(isoxml, _out)
+        super
+        id = "bibdata/docidentifier[@type = 'IEEE']"
+        dn = isoxml.at(ns("//#{id}[@scope = 'PDF']"))
+        set(:stdid_pdf, dn&.text || "STDXXXXX")
+        dn = isoxml.at(ns("//#{id}[@scope = 'print']"))
+        set(:stdid_print, dn&.text || "STDPDXXXXX")
+      end
+
+      def title(isoxml, _out)
+        super
+        draft = isoxml&.at(ns("//bibdata/version/draft"))
+        doctype(isoxml, _out)
+        title = "#{@metadata[:doctype_abbrev] || '???'} for "\
+                "#{@metadata[:doctitle] || '???'}"
+        draft and title = "Draft #{title}"
+        set(:full_doctitle, title)
+      end
+    end
+  end
+end

data/lib/isodoc/ieee/pdf_convert.rb

@@ -0,0 +1,24 @@
+require "isodoc"
+require "fileutils"
+
+module IsoDoc
+  module IEEE
+    # A {Converter} implementation that generates PDF HTML output, and a
+    # document schema encapsulation of the document for validation
+    class PdfConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def pdf_stylesheet(docxml)
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        if doctype == "amendment"
+          "ieee.amendment.xsl"
+        else
+          "ieee.standard.xsl"
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/ieee/presentation_terms.rb

@@ -0,0 +1,181 @@
+module IsoDoc
+  module IEEE
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def multidef(elem)
+        number_multidef(elem)
+        collapse_multidef(elem)
+      end
+
+      def number_multidef(elem)
+        c = IsoDoc::XrefGen::Counter.new("@")
+        elem.xpath(ns("./definition")).each do |d|
+          c.increment(d)
+          d.elements.first.previous = "<strong>(#{c.print})</strong>&#xa0;"
+        end
+      end
+
+      def collapse_multidef(elem)
+        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>"
+      end
+
+      def unwrap_definition(docxml)
+        docxml.xpath(ns("//definition/verbal-definition")).each do |v|
+          next unless v.elements.all? { |e| %w(termsource p).include?(e.name) }
+
+          s = v.xpath(ns("./termsource"))
+          p = v.xpath(ns("./p"))
+          v.children =
+            "<p>#{p.map(&:children).map(&:to_xml).join("\n")}</p>#{s.to_xml}"
+        end
+        super
+      end
+
+      def related(docxml)
+        docxml.xpath(ns("//term[related]")).each { |f| related_term(f) }
+      end
+
+      def related_term(term)
+        coll = term_related_reorder(term.xpath(ns("./related")))
+        term_related_collapse(coll)
+      end
+
+      def term_related_collapse(coll)
+        prev = 0
+        coll[1..-1].each_with_index do |r, i|
+          if coll[prev]["type"] == r["type"]
+            coll[prev].at(ns("./preferred")) << "; #{r.at(ns('./preferred'))
+              .children.to_xml}"
+            r.remove
+          else prev = i
+          end
+        end
+      end
+
+      def sort_terms_key(term)
+        d = term.at(ns("./preferred/expression/name | "\
+                       "./preferred/letter-designation/name | "\
+                       "./preferred/graphical-symbol/figure/name | "\
+                       "./preferred/graphical-symbol/figure/@id"))
+        d&.text&.downcase
+      end
+
+      def term_related_reorder(coll)
+        ins = coll.first.previous_element
+        ret = sort_related(coll)
+        coll.each(&:remove)
+        ret.reverse.each { |t| ins.next = t }
+        ins.parent.xpath(ns("./related"))
+      end
+
+      def sort_related(coll)
+        coll.sort do |a, b|
+          sort_related_key(a) <=> sort_related_key(b)
+        end
+      end
+
+      def sort_related_key(related)
+        type = case related["type"]
+               when "contrast" then 1
+               when "equivalent" then 2
+               when "see" then 3
+               when "seealso" then 4
+               else "5-#{related['type']}"
+               end
+        "#{type} :: #{sort_terms_key(related)}"
+      end
+
+      def terms(docxml)
+        admitted_to_related docxml
+        super
+        collapse_term docxml
+      end
+
+      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>"
+        end
+      end
+
+      def collapse_term(docxml)
+        docxml.xpath(ns("//term")).each do |t|
+          collapse_term1(t)
+        end
+      end
+
+      def collapse_term1(term)
+        ret = collapse_term_template(
+          pref: term.at(ns("./preferred")).remove,
+          def: term.at(ns("./definition")),
+          rels: term.xpath(ns("./related")).map(&:remove),
+          source: term.at(ns("./termsource")),
+        )
+        (ins = term.elements.first and ins.previous = ret) or
+          term << ret
+      end
+
+      def collapse_term_related(rels)
+        ret = rels.map do |r|
+          "<em>#{@i18n.relatedterms[r['type']]}:</em> "\
+            "#{r.at(ns('./preferred')).children.to_xml}"
+        end.join(". ")
+        ret += "." unless ret.empty?
+        ret
+      end
+
+      def collapse_term_template(opt)
+        defn = collapse_unwrap_definition(opt[:def])
+        source = opt[:source] ? "(#{opt[:source].remove.children.to_xml})" : nil
+        <<~TERM
+          <p>#{opt[:pref].children.to_xml}: #{defn}
+          #{collapse_term_related(opt[:rels])}
+          #{source}</p>
+        TERM
+      end
+
+      def collapse_unwrap_definition(defn)
+        return nil if defn.nil?
+
+        s = defn.remove.xpath(ns("./termsource"))
+        p = defn.at(ns("./p"))
+        !s.empty? && p and p << s.map(&:remove).map(&:children).map(&:to_xml).join
+        if defn.elements.size == 1 && defn.elements.first.name == "p"
+          defn.elements.first.children
+        else defn.elements
+        end
+      end
+
+      def termsource1(elem)
+        while elem&.next_element&.name == "termsource"
+          elem << "; #{elem.next_element.remove.children.to_xml}"
+        end
+      end
+
+      def designation_field(desgn, name)
+        if desgn.name == "preferred"
+          f = desgn.xpath(ns("./../domain | ./../subject")).map(&:remove)
+            .map { |u| u.children.to_xml }.join(", ")
+          name << ", &#x3c;#{f}&#x3e;" unless f.empty?
+        end
+        super
+      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
+        end
+      end
+
+      def term(docxml); end
+    end
+  end
+end

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -0,0 +1,89 @@
+require_relative "init"
+require_relative "presentation_terms"
+require "isodoc"
+
+module IsoDoc
+  module IEEE
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def initialize(options)
+        @hierarchical_assets = options[:hierarchical_assets]
+        super
+      end
+
+      def eref_localities_conflated(refs, target, node)
+        droploc = node["droploc"]
+        node["droploc"] = true
+        ret = resolve_eref_connectives(eref_locality_stacks(refs, target,
+                                                            node))
+        node["droploc"] = droploc
+        eref_localities1(target,
+                         prefix_clause(target, refs.first.at(ns("./locality"))),
+                         l10n(ret[1..-1].join), nil, node, @lang)
+      end
+
+      def prefix_clause(target, loc)
+        loc["type"] == "clause" or return loc["type"]
+
+        if subclause?(target, loc["type"],
+                      loc&.at(ns("./referenceFrom"))&.text)
+          ""
+        else "clause"
+        end
+      end
+
+      def subclause?(target, type, from)
+        (from&.match?(/\./) && type == "clause") ||
+          target&.gsub(/<[^>]+>/, "")&.match(/^IEV$|^IEC 60050-/)
+      end
+
+      def eref_localities1(target, type, from, upto, node, lang = "en")
+        return nil if type == "anchor"
+
+        type = type.downcase
+        lang == "zh" and
+          return l10n(eref_localities1_zh(target, type, from, upto,
+                                          node))
+        ret = ""
+        node["droploc"] != "true" && !subclause?(target, type,
+                                                 from) and
+          ret = eref_locality_populate(type, node)
+        ret += " #{from}" if from
+        ret += "&#x2013;#{upto}" if upto
+        ret += ")" if type == "list"
+        l10n(ret)
+      end
+
+      def anchor_linkend1(node)
+        linkend = @xrefs.anchor(node["target"], :xref)
+        @xrefs.anchor(node["target"], :type) == "clause" &&
+          @xrefs.anchor(node["target"], :level) > 1 &&
+          !start_of_sentence(node) and
+          linkend = linkend.sub(/^Clause /, "")
+        container = @xrefs.anchor(node["target"], :container, false)
+        prefix_container?(container, node) and
+          linkend = prefix_container(container, linkend, node["target"])
+        capitalise_xref(node, linkend, anchor_value(node["target"]))
+      end
+
+      def block_delim
+        "&#x2014;"
+      end
+
+      def display_order(docxml)
+        i = 0
+        i = display_order_xpath(docxml, "//preface/*", i)
+        i = display_order_at(docxml, "//clause[@type = 'overview']", i)
+        i = display_order_at(docxml, @xrefs.klass.norm_ref_xpath, i)
+        i = display_order_at(docxml, "//sections/terms | "\
+                                     "//sections/clause[descendant::terms]", i)
+        i = display_order_at(docxml, "//sections/definitions", i)
+        i = display_order_xpath(docxml, @xrefs.klass.middle_clause(docxml), i)
+        i = display_order_xpath(docxml, "//annex", i)
+        i = display_order_xpath(docxml, @xrefs.klass.bibliography_xpath, i)
+        display_order_xpath(docxml, "//indexsect", i)
+      end
+
+      include Init
+    end
+  end
+end

data/lib/isodoc/ieee/word_authority.rb

@@ -0,0 +1,160 @@
+module IsoDoc
+  module IEEE
+    class WordConvert < IsoDoc::WordConvert
+      def authority_cleanup(docxml)
+        feedback_footnote(docxml)
+        %w(copyright license disclaimers participants).each do |t|
+          authority_cleanup1(docxml, t)
+        end
+        coverpage_note_cleanup(docxml)
+        authority_style(docxml)
+      end
+
+      def feedback_footnote(docxml)
+        feedback_style(docxml)
+        feedback_table(docxml)
+        f = docxml.at("//div[@class = 'boilerplate-feedback']") or return
+        docxml.at("//aside").previous = <<~FN
+          <aside id="ftn0">#{f.remove.to_xml}</aside>
+        FN
+      end
+
+      def authority_style(docxml)
+        copyright_style(docxml)
+        license_style(docxml)
+        officer_style(docxml)
+      end
+
+      def copyright_style(docxml)
+        docxml.at("//div[@class = 'boilerplate-copyright']")&.xpath(".//p")
+          &.reverse&.each_with_index do |p, i|
+          p["class"] =
+            i.zero? ? "IEEEStdsTitleDraftCRBody" : "IEEEStdsTitleDraftCRaddr"
+        end
+      end
+
+      def license_style(docxml)
+        docxml.at("//div[@class = 'boilerplate-license']")&.xpath(".//p")
+          &.reverse&.each_with_index do |p, i|
+          p["class"] =
+            i.zero? ? "IEEEStdsTitleDraftCRBody" : "IEEEStdsTitleDraftCRaddr"
+        end
+      end
+
+      def officer_style(docxml)
+        docxml.xpath("//p[@type = 'officeholder']").each do |p|
+          officeholder_style(p)
+        end
+        officemember_style(docxml)
+        three_column_officemembers(docxml
+          .at("//div[@id = 'boilerplate-participants']"))
+      end
+
+      def officeholder_style(para)
+        n = para.next_element
+        p = para.previous_element
+        n && n.name == "p" && n["type"] == "officeholder" and
+          klass = "IEEEStdsNamesCtrCxSpLast"
+        p && p.name == "p" && p["type"] == "officeholder" and
+          klass = "IEEEStdsNamesCtrCxSpFirst"
+        para["class"] = klass || "IEEEStdsNamesCtrCxSpMiddle"
+      end
+
+      SECTIONBREAK = <<~BREAK.freeze
+        <span lang="EN-US" style='font-size:9.0pt;mso-bidi-font-size:10.0pt;font-family:
+        "Times New Roman",serif;mso-fareast-font-family:"Times New Roman";mso-ansi-language:
+        EN-US;mso-fareast-language:JA;mso-bidi-language:AR-SA'><br clear="all"
+        style='page-break-before:auto;mso-break-type:section-break'></span>
+      BREAK
+
+      def officemember_style(docxml)
+        docxml.xpath("//p[@type = 'officemember']").each do |p|
+          p["class"] = "IEEEStdsNamesList"
+        end
+        docxml.xpath("//p[@type = 'emeritus_sign']").each do |p|
+          p["class"] = "IEEEStdsParaMemEmeritus"
+        end
+      end
+
+      def three_column_officemembers(div)
+        return unless div
+
+        ret = three_column_officemembers_split(div)
+        three_column_officemembers_render(div, ret)
+      end
+
+      def three_column_officemembers_split(div)
+        prev = false
+        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]
+          prev = member
+        end.map(&:join)
+      end
+
+      def three_column_officemembers_render(div, ret)
+        div.children = ret[0]
+        out = ret[1..-1].map.with_index do |d, i|
+          para = i % 2 == 1 && i != ret.size - 2 ? "<p>&#xa0;</p>" : ""
+          "<div class='WordSection'>#{para}#{d}</div>"
+        end.join(SECTIONBREAK)
+        div.document.at("//div[@class = 'WordSection11']")
+          .previous_element.previous = SECTIONBREAK + out
+      end
+
+      def feedback_table(docxml)
+        docxml.at("//div[@class = 'boilerplate-feedback']")&.xpath(".//table")
+          &.each do |t|
+          t.xpath(".//tr").each do |tr|
+            feedback_table1(tr)
+          end
+          t.replace(t.at(".//tbody").elements)
+        end
+      end
+
+      def feedback_table1(trow)
+        trow.name = "p"
+        trow["class"] = "IEEEStdsCRTextReg"
+        trow.xpath("./td").each do |td|
+          td.next_element and td << "<span style='mso-tab-count:1'> </span>"
+          td.replace(td.children)
+        end
+      end
+
+      def feedback_style(docxml)
+        docxml.at("//div[@class = 'boilerplate-feedback']")&.xpath("./div")
+          &.each_with_index do |div, i|
+          i.zero? or div.elements.first.previous = "<p>&#xa0;</p>"
+          feedback_style1(div, i)
+        end
+      end
+
+      def feedback_style1(div, idx)
+        div.xpath(".//p").each_with_index do |p, j|
+          p["class"] = idx == 4 ? "IEEEStdsCRTextItal" : "IEEEStdsCRTextReg"
+          j.zero? && idx.zero? and
+            p.children.first.previous =
+              '<a style="mso-footnote-id:ftn0" href="#_ftnref0" name="_ftn0" title=""/>'
+        end
+      end
+
+      def authority_cleanup1(docxml, klass)
+        dest = docxml.at("//div[@id = 'boilerplate-#{klass}-destination']")
+        auth = docxml.at("//div[@id = 'boilerplate-#{klass}' "\
+                         "or @class = 'boilerplate-#{klass}']")
+        auth&.xpath(".//h1[not(text())] | .//h2[not(text())]")&.each(&:remove)
+        authority_cleanup_hdr(auth)
+        dest and auth and dest.replace(auth.remove)
+      end
+
+      def authority_cleanup_hdr(auth)
+        (1..2).each do |i|
+          auth&.xpath(".//h#{i}")&.each do |h|
+            h.name = "p"
+            h["class"] = "IEEEStdsLevel#{i}frontmatter"
+          end
+        end
+      end
+    end
+  end
+end