metanorma-ieee 1.1.1 → 1.1.3

data/lib/isodoc/ieee/i18n-en.yaml

@@ -12,6 +12,7 @@ example: Example
 table_of_contents: Contents
 viewed: accessed
 adapted_from: "adapted from "
+references: References
 doctype_abbrev:
   standard: Std.
   recommended-practice: Rec. Prac.

data/lib/isodoc/ieee/metadata.rb

@@ -7,11 +7,21 @@ module IsoDoc
       def initialize(lang, script, i18n, fonts_options = {})
         super
         @metadata[:issueddate] = "<Date Approved>"
+        logos
+      end
+
+      def logos
+        here = File.join(File.dirname(__FILE__), "html")
+        %i(wp_image001_emz wp_image003_emz wp_image008_emz)
+          .each do |w|
+          img = w.to_s.sub("_emz", ".emz")
+          set(w, File.expand_path(File.join(here, img)))
+        end
       end
 
       def bibdate(isoxml, _out)
         isoxml.xpath(ns("//bibdata/date[@format = 'ddMMMyyyy']")).each do |d|
-          set("#{d['type'].gsub(/-/, '_')}date".to_sym, Common::date_range(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']")) ||
@@ -42,25 +52,25 @@ module IsoDoc
       end
 
       def society(xml)
-        society = xml.at(ns("//bibdata/ext/editorialgroup/"\
+        society = xml.at(ns("//bibdata/ext/editorialgroup/" \
                             "society"))&.text || "<Society>"
         set(:society, society)
       end
 
       def tc(xml)
-        tc = xml.at(ns("//bibdata/ext/editorialgroup/"\
+        tc = xml.at(ns("//bibdata/ext/editorialgroup/" \
                        "committee"))&.text || "<Committee Name>"
         set(:technical_committee, tc)
       end
 
       def wg(xml)
-        wg = xml.at(ns("//bibdata/ext/editorialgroup/"\
+        wg = xml.at(ns("//bibdata/ext/editorialgroup/" \
                        "working-group")) or return nil
         set(:working_group, wg.text)
       end
 
       def bg(xml)
-        bg = xml.at(ns("//bibdata/ext/editorialgroup/"\
+        bg = xml.at(ns("//bibdata/ext/editorialgroup/" \
                        "balloting-group")) or return nil
         set(:balloting_group, bg.text)
         set(:balloting_group_type, bg["type"])

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -39,9 +39,8 @@ module IsoDoc
       end
 
       def eref_localities1(opt)
-        return nil if opt[:type] == "anchor"
-
-        opt[:type] = opt[:type].downcase
+        opt[:type] == "anchor" and return nil
+        opt[:type].downcase!
         opt[:lang] == "zh" and return l10n(eref_localities1_zh(opt))
         ret = ""
         opt[:node]["droploc"] != "true" &&
@@ -80,6 +79,23 @@ module IsoDoc
       end
 
       def annex1(elem)
+        if @doctype == "whitepaper"
+          annex1_whitepaper(elem)
+        else
+          annex1_default(elem)
+        end
+      end
+
+      def annex1_whitepaper(elem)
+        lbl = @xrefs.anchor(elem["id"], :label)
+        if t = elem.at(ns("./title"))
+          t.name = "variant-title"
+          t["type"] = "sub"
+        end
+        elem.children.first.previous = "<title>#{lbl}</title>"
+      end
+
+      def annex1_default(elem)
         lbl = @xrefs.anchor(elem["id"], :label)
         if t = elem.at(ns("./title"))
           t.children = "<strong>#{to_xml(t.children)}</strong>"
@@ -164,14 +180,37 @@ module IsoDoc
       end
 
       def middle_title(docxml)
-        s = docxml.at(ns("//sections")) or return
+        s = middle_title_insert(docxml) or return
+        s.previous = middle_title_body
+      end
+
+      def middle_title_body
         ret = "<p class='zzSTDTitle1'>#{@meta.get[:full_doctitle]}"
         @meta.get[:amd] || @meta.get[:corr] and ret += "<br/>"
         @meta.get[:amd] and ret += "Amendment #{@meta.get[:amd]}"
         @meta.get[:amd] && @meta.get[:corr] and ret += " "
         @meta.get[:corr] and ret += "Corrigenda #{@meta.get[:corr]}"
         ret += "</p>"
-        s.children.first.previous = ret
+        ret
+      end
+
+      def middle_title_insert(docxml)
+        s = docxml.at(ns("//sections")) or return
+        s.children.first
+      end
+
+      def preface_rearrange(doc)
+        move_abstract(doc)
+        super
+      end
+
+      def move_abstract(doc)
+        doc.at(ns("//bibdata/ext/doctype"))&.text == "whitepaper" or return
+        source = doc.at(ns("//preface/abstract")) or return
+        dest = doc.at(ns("//sections")) ||
+          doc.at(ns("//preface")).after("<sections> </sections>").next_element
+        dest.children.empty? and dest.children = " "
+        dest.children.first.next = source
       end
 
       include Init

data/lib/isodoc/ieee/word_authority.rb

@@ -71,7 +71,7 @@ module IsoDoc
       def officemember_style(docxml)
         docxml.xpath("//p[@type = 'officemember' or @type = 'officeorgmember']")
           .each do |p|
-          p["class"] = "IEEEStdsNamesList"
+          p["class"] = stylesmap[:nameslist]
         end
         docxml.xpath("//p[@type = 'emeritus_sign']").each do |p|
           p["class"] = "IEEEStdsParaMemEmeritus"
@@ -80,20 +80,19 @@ module IsoDoc
 
       def officeorgrep_style(docxml)
         docxml.xpath("//p[@type = 'officeorgrepmemberhdr']").each do |p|
-          p["class"] = "IEEEStdsNamesList"
+          p["class"] = stylesmap[:nameslist]
           p["style"] =
             "margin-bottom:6.0pt;tab-stops:right 432.0pt;"
         end
         docxml.xpath("//p[@type = 'officeorgrepmember']").each do |p|
-          p["class"] = "IEEEStdsNamesList"
+          p["class"] = stylesmap[:nameslist]
           p["style"] =
             "margin-top:6.0pt;tab-stops:right dotted 432.0pt;"
         end
       end
 
       def three_column_officemembers(div)
-        return unless div
-
+        div or return
         ret = three_column_officemembers_split(div)
         three_column_officemembers_render(div, ret)
       end
@@ -128,6 +127,7 @@ module IsoDoc
         end
       end
 
+      # STYLE
       def feedback_table1(trow)
         trow.name = "p"
         trow["class"] = "IEEEStdsCRTextReg"
@@ -149,6 +149,7 @@ module IsoDoc
         end
       end
 
+      # STYLE
       def feedback_style1(div, idx)
         div.xpath(".//p").each_with_index do |p, j|
           p["class"] = idx == 4 ? "IEEEStdsCRTextItal" : "IEEEStdsCRTextReg"
@@ -160,7 +161,7 @@ module IsoDoc
 
       def authority_cleanup1(docxml, klass)
         dest = docxml.at("//div[@id = 'boilerplate-#{klass}-destination']")
-        auth = docxml.at("//div[@id = 'boilerplate-#{klass}' "\
+        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)
@@ -171,7 +172,7 @@ module IsoDoc
         (1..2).each do |i|
           auth&.xpath(".//h#{i}")&.each do |h|
             h.name = "p"
-            h["class"] = "IEEEStdsLevel#{i}frontmatter"
+            h["class"] = "level#{i}frontmatter"
           end
         end
       end
@@ -191,18 +192,18 @@ module IsoDoc
       def abstract_cleanup1(source, dest)
         source.elements.reject { |e| %w(h1 h2).include?(e.name) }.each do |e|
           e1 = e.dup
-          e1.xpath(".//p").each do |p|
+          e1.xpath("self::p | .//p").each do |p|
+            p["class"] = stylesmap[:abstract]
             p["style"] ||= ""
-            p["style"] = 'font-family: "Arial", sans-serif;' + p["style"]
+            p["style"] = "font-family: 'Arial', sans-serif;#{p['style']}"
           end
-          %w(ul ol).include?(e1.name) or e1["class"] = "IEEEStdsAbstractBody"
-          dest << e1
+          dest and dest << e1
         end
       end
 
       def abstract_header(dest)
         dest.elements.first.children.first.previous =
-          "<span class='IEEEStdsAbstractHeader'><span lang='EN-US'>"\
+          "<span class='IEEEStdsAbstractHeader'><span lang='EN-US'>" \
           "Abstract:</span></span> "
       end
 
@@ -221,7 +222,7 @@ module IsoDoc
         dest.replace(intro.remove)
         i = docxml.at("//h1[@class = 'IntroTitle']")
         if i.next_element.name == "div" &&
-            i.next_element["class"] == "IEEEStdsIntroduction"
+            i.next_element["class"] == stylesmap[:intro]
           i.next_element.name = "p"
         end
       end

data/lib/isodoc/ieee/word_cleanup.rb

@@ -3,7 +3,7 @@ module IsoDoc
     class WordConvert < IsoDoc::WordConvert
       def toWord(result, filename, dir, header)
         result = from_xhtml(word_cleanup(to_xhtml(result)))
-          .gsub(/-DOUBLE_HYPHEN_ESCAPE-/, "--")
+          .gsub("-DOUBLE_HYPHEN_ESCAPE-", "--")
         @wordstylesheet = wordstylesheet_update
         ::Html2Doc::IEEE.new(
           filename: filename,
@@ -18,7 +18,7 @@ module IsoDoc
       end
 
       def sourcecode_style
-        "IEEEStdsComputerCode"
+        stylesmap[:Sourcecode]
       end
 
       def word_cleanup(docxml)
@@ -75,10 +75,10 @@ module IsoDoc
           hdr["style"] = "mso-list:l13 level#{idx} lfo33;"
         elsif hdr.at("./ancestor::div[@class = 'Section3' or @class = 'WordSectionContents']")
           hdr.name = "p"
-          hdr["class"] = "IEEEStdsLevel#{idx}frontmatter"
+          hdr["class"] = stylesmap["level#{idx}frontmatter".to_sym]
         else
           hdr.name = "p"
-          hdr["class"] = "IEEEStdsLevel#{idx}Header"
+          hdr["class"] = stylesmap["level#{idx}header".to_sym]
         end
       end
 
@@ -89,6 +89,7 @@ module IsoDoc
         end
       end
 
+      # STYLE
       def div_cleanup(docxml)
         d = docxml.at("//div[@class = 'WordSection2']" \
                       "[div[@class = 'WordSection2']]") and
@@ -102,36 +103,58 @@ module IsoDoc
         end
       end
 
-      STYLESMAP = {
-        example: "IEEEStdsParagraph",
-        MsoNormal: "IEEEStdsParagraph",
-        NormRef: "IEEEStdsParagraph",
-        Biblio: "IEEEStdsBibliographicEntry",
-        figure: "IEEEStdsImage",
-        formula: "IEEEStdsEquation",
-        Sourcecode: "IEEEStdsComputerCode",
-        TableTitle: "IEEEStdsRegularTableCaption",
-        FigureTitle: "IEEEStdsRegularFigureCaption",
-      }.freeze
+      def stylesmap
+        {
+          example: "IEEEStdsParagraph",
+          MsoNormal: "IEEEStdsParagraph",
+          NormRef: "IEEEStdsParagraph",
+          Biblio: "IEEEStdsBibliographicEntry",
+          figure: "IEEEStdsImage",
+          formula: "IEEEStdsEquation",
+          Sourcecode: "IEEEStdsComputerCode",
+          TableTitle: "IEEEStdsRegularTableCaption",
+          FigureTitle: "IEEEStdsRegularFigureCaption",
+          admonition: "IEEEStdsWarning",
+          abstract: "IEEEStdsAbstractBody",
+          AbstractTitle: "AbstractTitle",
+          level1frontmatter: "IEEEStdsLevel1frontmatter",
+          level2frontmatter: "IEEEStdsLevel2frontmatter",
+          level3frontmatter: "IEEEStdsLevel3frontmatter",
+          level1header: "IEEEStdsLevel1Header",
+          level2header: "IEEEStdsLevel2Header",
+          level3header: "IEEEStdsLevel3Header",
+          level4header: "IEEEStdsLevel4Header",
+          level5header: "IEEEStdsLevel5Header",
+          level6header: "IEEEStdsLevel6Header",
+          zzSTDTitle1: "IEEEStdsTitle",
+          tabledata_center: "IEEEStdsTableData-Center",
+          tabledata_left: "IEEEStdsTableData-Left",
+          table_head: "IEEEStdsTableLineHead",
+          table_subhead: "IEEEStdsTableLineSubhead",
+          table_columnhead: "IEEEStdsTableColumnHead",
+          nameslist: "IEEEStdsNamesList",
+          intro: "IEEEStdsIntroduction",
+        }
+      end
 
       def table_toc_class
-        %w(IEEEStdsRegularTableCaption TableTitle tabletitle)
+        [stylesmap[:TableTitle], "TableTitle", "tabletitle"]
       end
 
       def figure_toc_class
-        %w(IEEEStdsRegularFigureCaption FigureTitle figuretitle)
+        [stylesmap[:FigureTitle], "FigureTitle", "figuretitle"]
       end
 
       def style_cleanup(docxml)
         note_style_cleanup(docxml)
         docxml.xpath("//div[@class = 'formula']/p").each do |p|
-          p["class"] = "IEEEStdsEquation"
+          p["class"] = stylesmap[:formula]
         end
-        STYLESMAP.each do |k, v|
+        stylesmap.each do |k, v|
           docxml.xpath("//*[@class = '#{k}']").each { |s| s["class"] = v }
         end
         docxml.xpath("//p[not(@class)]").each do |p|
-          p["class"] = "IEEEStdsParagraph"
+          p["class"] = stylesmap[:MsoNormal]
         end
       end
     end

data/lib/isodoc/ieee/word_cleanup_blocks.rb

@@ -1,13 +1,13 @@
 module IsoDoc
   module IEEE
     class WordConvert < IsoDoc::WordConvert
+      # STYLE
       def admonition_cleanup(docxml)
         super
         docxml.xpath("//div[@class = 'zzHelp']").each do |d|
           d.xpath(".//p").each do |p|
-            %w(IEEEStdsWarning IEEEStdsParagraph).include?(p["class"]) ||
-              !p["class"] or next
-
+            [stylesmap[:admonition], stylesmap[:MsoNormal]]
+              .include?(p["class"]) || !p["class"] or next
             p["class"] = "zzHelp"
           end
         end
@@ -22,15 +22,20 @@ module IsoDoc
       def thead_cleanup(docxml)
         docxml.xpath("//thead").each do |h|
           h.xpath(".//td | .//th").each do |t|
-            if t.at("./p")
-              t.xpath("./p").each do |p|
-                p["class"] = "IEEEStdsTableColumnHead"
-              end
-            else
-              t.children =
-                "<p class='IEEEStdsTableColumnHead'>#{to_xml(t.children)}</p>"
-            end
+            thead_cell_cleanup(t)
+          end
+        end
+      end
+
+      def thead_cell_cleanup(cell)
+        s = stylesmap[:table_columnhead]
+        if cell.at("./p")
+          cell.xpath("./p").each do |p|
+            p["class"] = s
           end
+        else
+          cell.children =
+            "<p class='#{s}'>#{to_xml(cell.children)}</p>"
         end
       end
 
@@ -63,12 +68,12 @@ module IsoDoc
       end
 
       def td_style(cell, idx)
-        if cell.name == "th" && idx.zero? then "IEEEStdsTableLineHead"
-        elsif cell.name == "th" then "IEEEStdsTableLineSubhead"
+        if cell.name == "th" && idx.zero? then stylesmap[:table_head]
+        elsif cell.name == "th" then stylesmap[:table_subhead]
         elsif cell["align"] == "center" ||
-            /text-align:center/.match?(cell["style"])
-          "IEEEStdsTableData-Center"
-        else "IEEEStdsTableData-Left"
+            cell["style"].include?("text-align:center")
+          stylesmap[:tabledata_center]
+        else stylesmap[:tabledata_left]
         end
       end
 
@@ -95,7 +100,7 @@ module IsoDoc
       def example_caption(docxml)
         docxml.xpath("//p[@class = 'example-title']").each do |s|
           s.children = "<em>#{to_xml(s.children)}</em>"
-          s["class"] = "IEEEStdsParagraph"
+          s["class"] = stylesmap[:MsoNormal]
         end
       end
 
@@ -135,6 +140,7 @@ module IsoDoc
       end
 
       # hardcoded list style for notes
+      # STYLE
       def note_style_cleanup1(multi, div, seq)
         div.xpath(".//p[@class = 'Note' or not(@class)]")
           .each_with_index do |p, i|

data/lib/isodoc/ieee/word_convert.rb

@@ -3,6 +3,7 @@ require_relative "init"
 require_relative "word_cleanup"
 require_relative "word_cleanup_blocks"
 require_relative "word_authority"
+require_relative "word_wp_convert"
 
 module IsoDoc
   module IEEE
@@ -10,16 +11,32 @@ module IsoDoc
       def initialize(options)
         @libdir = File.dirname(__FILE__)
         super
+        init_wp(options)
+      end
+
+      def init_wp(options)
+        @wp = ::IsoDoc::IEEE::WordWPConvert.new(options)
       end
 
       def convert1(docxml, filename, dir)
-        doctype = docxml.at(ns("//bibdata/ext/doctype"))
-        if %w(amendment corrigendum).include?(doctype&.text)
+        if %w(amendment corrigendum).include?(@doctype)
           @header = html_doc_path("header_amd.html")
         end
         super
       end
 
+      def convert(input_filename, file = nil, debug = false,
+          output_filename = nil)
+        file ||= File.read(input_filename, encoding: "utf-8")
+        docxml = Nokogiri::XML(file) { |config| config.huge }
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        if @wp && doctype == "whitepaper"
+          @wp.convert(input_filename, file, debug, output_filename)
+        else
+          super
+        end
+      end
+
       def default_fonts(options)
         { bodyfont: (if options[:script] == "Hans"
                        '"Source Han Sans",serif'
@@ -51,7 +68,7 @@ module IsoDoc
         page_break(out)
         out.div **attr_code(id: clause["id"], class: "abstract") do |s|
           clause_name(clause, clause.at(ns("./title")), s,
-                      { class: "AbstractTitle" })
+                      { class: stylesmap[:AbstractTitle] })
           clause.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
       end
@@ -76,13 +93,14 @@ module IsoDoc
 
       def middle_title_ieee(docxml, out)
         title = docxml.at(ns("//p[@class = 'zzSTDTitle1']")) or return
-        out.p(class: "IEEEStdsTitle", style: "margin-top:70.0pt") do |p|
+        out.p(class: stylesmap[:zzSTDTitle1],
+              style: "margin-left:0cm;margin-top:70.0pt") do |p|
           title.children.each { |n| parse(n, p) }
         end
       end
 
       def admonition_name_parse(_node, div, name)
-        div.p class: "IEEEStdsWarning", style: "text-align:center;" do |p|
+        div.p class: stylesmap[:admonition], style: "text-align:center;" do |p|
           p.b do |b|
             name.children.each { |n| parse(n, b) }
           end
@@ -92,8 +110,8 @@ module IsoDoc
       def admonition_class(node)
         if node["type"] == "editorial" then "zzHelp"
         elsif node.ancestors("introduction").empty?
-          "IEEEStdsWarning"
-        else "IEEEStdsIntroduction"
+          stylesmap[:admonition]
+        else stylesmap[:intro]
         end
       end
 
@@ -121,6 +139,7 @@ module IsoDoc
         end
       end
 
+      # STYLE
       def formula_where1(out, dterm, ddefn)
         out.p class: "IEEEStdsEquationVariableList" do |p|
           dterm.children.each { |n| parse(n, p) }
@@ -176,6 +195,7 @@ module IsoDoc
         end
       end
 
+      # STYLE
       def table_of_contents(clause, out)
         out.div class: "WordSectionContents" do |div|
           clause_name(clause, clause.at(ns("./title")), div,