metanorma-ieee 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bbf250e70bbe6d7c3ce624147d503935bf9005694965377bee47b61d3260c67
-  data.tar.gz: cd6e4e3f393d870c38f0d31ae11254123b7301659ed519e9a39988b472de9dcc
+  metadata.gz: 62bafd0727fc5b10d3a146196f4317b9d158802d918c7c3a7e407d689348bac9
+  data.tar.gz: ffd4fbc73ea2b2af25abf3b4b21863e07e79706fc2f2bf8403a75b804e8eb7cf
 SHA512:
-  metadata.gz: 7c10105ed014eb7919a245ee2b1ca5bb9165768aa9cd3390cf7782abcaac24e1ff35fd0fbf9c14bcedfb39f7b4090ef17b43c7ba1bc36dbd6f7ad96abef9a04a
-  data.tar.gz: 41d392c1240e1ad3f31660d22b3d46ff2471e4e4001fc990eea12ff388877aa39b6eb49fd119b19d707a26096f55955e8d31ea76827bdfdc3715e597896089fd
+  metadata.gz: 52bc01c58e681f92ed46c3241db36244fbb805d6ec81678e90ad07b5ad9b7c89c1a528fbfbe411af74a9b7d58c01f032b2bdebaaaa7996dc313fe052ba73e7f0
+  data.tar.gz: 6fb175826c51f3b48ceb6a7b330560f166d358a24412109b09b77f04f84a66bcdc2e75bff43d2d277767257cd619e33265218dd399c47eee842b85799b274ab0

data/README.adoc

@@ -8,7 +8,7 @@ image:https://img.shields.io/github/commits-since/metanorma/metanorma-ieee/lates
 
 == Functionality
 
-This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating ITU
+This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating IEEE
 standards and documents.
 
 The implementation inherits from https://github.com/metanorma/metanorma-standoc.

data/lib/html2doc/ieee/lists.rb

@@ -0,0 +1,44 @@
+class Html2Doc
+  class IEEE < ::Html2Doc
+    def style_list(elem, level, liststyle, listnumber)
+      super
+      elem.parent["level"] = level
+    end
+
+    def list2para(list)
+      return if list.xpath("./li").empty?
+
+      level = list["level"] || "1"
+      list.delete("level")
+      list2para1(list, level, list.name)
+    end
+
+    def list2para1(list, level, type)
+      list.xpath("./li").first["class"] ||= list_style(type, level, "First")
+      list.xpath("./li").last["class"] ||= list_style(type, level, "Last")
+      list.xpath("./li/p").each do |p|
+        p["class"] ||= list_style(type, level, "Middle")
+      end
+      list.xpath("./li").each do |l|
+        l.name = "p"
+        l["class"] ||= list_style(type, level, "Middle")
+        next unless l&.first_element_child&.name == "p"
+
+        l["style"] += (l.first_element_child["style"]&.sub(/mso-list[^;]+;/, "") || "")
+        l.first_element_child.replace(l.first_element_child.children)
+      end
+      list.replace(list.children)
+    end
+
+    def list_style(listtype, level, position)
+      case listtype
+      when "ol" then "IEEEStdsNumberedListLevel#{level}CxSp#{position}"
+      when "ul"
+        case level
+        when "1" then "IEEEStdsUnorderedListCxSp#{position}"
+        else "IEEEStdsUnorderedListLevel2"
+        end
+      end
+    end
+  end
+end

data/lib/html2doc/ieee/notes.rb

@@ -0,0 +1,57 @@
+class Html2Doc
+  class IEEE < ::Html2Doc
+    def process_footnote_texts(docxml, footnotes)
+      body = docxml.at("//body")
+      list = body.add_child("<div style='mso-element:footnote-list'/>")
+      footnotes.each_with_index do |f, i|
+        if i.zero?
+          fn = list.first.add_child(footnote_container_nofn(docxml, i + 1))
+          f.parent = fn.first
+          footnote_div_to_p_unstyled(f)
+        else
+          fn = list.first.add_child(footnote_container(docxml, i + 1))
+          f.parent = fn.first
+          footnote_div_to_p(f)
+        end
+      end
+      footnote_cleanup(docxml)
+    end
+
+    def footnote_container_nofn(_docxml, idx)
+      <<~DIV
+        <div style='mso-element:footnote' id='ftn#{idx}'>
+          <a style='mso-footnote-id:ftn#{idx}' href='#_ftn#{idx}'
+             name='_ftnref#{idx}' title='' id='_ftnref#{idx}'></a></div>
+      DIV
+    end
+
+    def footnote_div_to_p_unstyled(elem)
+      if %w{div aside}.include? elem.name
+        if elem.at(".//p")
+          elem.replace(elem.children)
+        else
+          elem.name = "p"
+        end
+      end
+    end
+
+    def transform_footnote_text(note)
+      note["id"] = ""
+      note.xpath(".//div").each { |div| div.replace(div.children) }
+      note.xpath(".//aside | .//p").each do |p|
+        p.name = "p"
+        %w(IEEEStdsCRTextReg IEEEStdsCRTextItal).include?(p["class"]) or
+          p["class"] = "IEEEStdsFootnote"
+      end
+      note.remove
+    end
+
+    def cleanup(docxml)
+      super
+      docxml.xpath("//div[@class = 'Note']").each do |d|
+        d.delete("class")
+      end
+      docxml
+    end
+  end
+end

data/lib/html2doc/ieee.rb

@@ -1,89 +1,7 @@
-class Html2Doc
-  class IEEE < ::Html2Doc
-    def process_footnote_texts(docxml, footnotes)
-      body = docxml.at("//body")
-      list = body.add_child("<div style='mso-element:footnote-list'/>")
-      footnotes.each_with_index do |f, i|
-        if i.zero?
-          fn = list.first.add_child(footnote_container_nofn(docxml, i + 1))
-          f.parent = fn.first
-          footnote_div_to_p_unstyled(f)
-        else
-          fn = list.first.add_child(footnote_container(docxml, i + 1))
-          f.parent = fn.first
-          footnote_div_to_p(f)
-        end
-      end
-      footnote_cleanup(docxml)
-    end
-
-    def footnote_container_nofn(_docxml, idx)
-      <<~DIV
-        <div style='mso-element:footnote' id='ftn#{idx}'>
-          <a style='mso-footnote-id:ftn#{idx}' href='#_ftn#{idx}'
-             name='_ftnref#{idx}' title='' id='_ftnref#{idx}'></a></div>
-      DIV
-    end
-
-    def footnote_div_to_p_unstyled(elem)
-      if %w{div aside}.include? elem.name
-        if elem.at(".//p")
-          elem.replace(elem.children)
-        else
-          elem.name = "p"
-        end
-      end
-    end
-
-    def transform_footnote_text(note)
-      note["id"] = ""
-      note.xpath(".//div").each { |div| div.replace(div.children) }
-      note.xpath(".//aside | .//p").each do |p|
-        p.name = "p"
-        %w(IEEEStdsCRTextReg IEEEStdsCRTextItal).include?(p["class"]) or
-          p["class"] = "IEEEStdsFootnote"
-      end
-      note.remove
-    end
+require "html2doc/ieee/notes"
+require "html2doc/ieee/lists"
 
-    def list2para(list)
-      return if list.xpath("./li").empty?
-
-      if list.name == "ol"
-        list2para_ol(list)
-      else
-        list2para_ul(list)
-      end
-    end
-
-    def list2para_ul(list)
-      list.xpath("./li").first["class"] ||= "IEEEStdsUnorderedListCxSpFirst"
-      list.xpath("./li").last["class"] ||= "IEEEStdsUnorderedListCxSpLast"
-      list.xpath("./li/p").each do |p|
-        p["class"] ||= "IEEEStdsUnorderedListCxSpMiddle"
-      end
-      list.xpath("./li").each do |l|
-        l.name = "p"
-        l["class"] ||= "IEEEStdsUnorderedListCxSpMiddle"
-        l&.first_element_child&.name == "p" and
-          l.first_element_child.replace(l.first_element_child.children)
-      end
-      list.replace(list.children)
-    end
-
-    def list2para_ol(list)
-      list.xpath("./li").first["class"] ||= "IEEEStdsNumberedListLevel1CxSpFirst"
-      list.xpath("./li").last["class"] ||= "IEEEStdsNumberedListLevel1CxSpLast"
-      list.xpath("./li/p").each do |p|
-        p["class"] ||= "IEEEStdsNumberedListLevel1CxSpMiddle"
-      end
-      list.xpath("./li").each do |l|
-        l.name = "p"
-        l["class"] ||= "IEEEStdsNumberedListLevel1CxSpMiddle"
-        l&.first_element_child&.name == "p" and
-          l.first_element_child.replace(l.first_element_child.children)
-      end
-      list.replace(list.children)
-    end
+class Html2Doc
+  class IEEE
   end
 end

data/lib/isodoc/ieee/base_convert.rb

@@ -28,6 +28,62 @@ module IsoDoc
       def para_attrs(node)
         super.merge(type: node["type"])
       end
+
+      def note_delim
+        "—"
+      end
+
+      def note_p_parse(node, div)
+        name = node&.at(ns("./name"))&.remove
+        div.p do |p|
+          name and p.span **{ class: "note_label" } do |s|
+            name.children.each { |n| parse(n, s) }
+            s << note_delim
+          end
+          node.first_element_child.children.each { |n| parse(n, p) }
+        end
+        node.element_children[1..-1].each { |n| parse(n, div) }
+      end
+
+      def note_parse1(node, div)
+        name = node&.at(ns("./name"))&.remove
+        name and div.p do |p|
+          p.span **{ class: "note_label" } do |s|
+            name.children.each { |n| parse(n, s) }
+            s << note_delim
+          end
+        end
+        node.children.each { |n| parse(n, div) }
+      end
+
+      def termnote_delim
+        "&#x2014;"
+      end
+
+      def formula_where(dlist, out)
+        return unless dlist
+
+        parse(dlist, out)
+        out.parent.at("./dl")["class"] = "formula_dl"
+      end
+
+      def bracket_if_num(num)
+        return nil if num.nil?
+
+        num = num.text.sub(/^\[/, "").sub(/\]$/, "")
+        return "[#{num}]" if /^B?\d+$/.match?(num)
+
+        num
+      end
+
+      def example_label(_node, div, name)
+        return if name.nil?
+
+        name << ":"
+        div.p **{ class: "example-title" } do |p|
+          name.children.each { |n| parse(n, p) }
+        end
+      end
     end
   end
 end

data/lib/isodoc/ieee/html/header.html

@@ -62,8 +62,7 @@ xmlns="http://www.w3.org/TR/REC-html40">
   <p class=MsoHeader><span lang=EN-US>P{{ docnumeric }}{% if draft %}/D{{ draft }},
     {{ draft_month }} {{ draft_year }}{% endif %}</span></p>
 
-  <p class=MsoHeader><span lang=EN-US>{% if draft %}Draft{% endif %} {{ doctype_abbrev }} for
-    {{ doctitle }}</span></p>
+  <p class=MsoHeader><span lang=EN-US>{{ full_doctitle }}</span></p>
 
 </div>
 

data/lib/isodoc/ieee/html/header_amd.html

@@ -0,0 +1,105 @@
+<html xmlns:v="urn:schemas-microsoft-com:vml"
+xmlns:o="urn:schemas-microsoft-com:office:office"
+xmlns:w="urn:schemas-microsoft-com:office:word"
+xmlns:m="http://schemas.microsoft.com/office/2004/12/omml"
+xmlns="http://www.w3.org/TR/REC-html40">
+
+<head>
+<meta http-equiv=Content-Type content="text/html; charset=utf-8">
+<meta name=ProgId content=Word.Document>
+<meta name=Generator content="Microsoft Word 15">
+<meta name=Originator content="Microsoft Word 15">
+<link id=Main-File rel=Main-File
+href="../IEEESTD-WORDTEMPLATE_Amendments-Corri-v7-2022.html">
+<!--[if gte mso 9]><xml>
+ <o:shapedefaults v:ext="edit" spidmax="2050"/>
+</xml><![endif]-->
+</head>
+
+<body lang=el-AU link=blue vlink=purple>
+
+<div style='mso-element:footnote-separator' id=fs>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1 width="33%">
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:footnote-continuation-separator' id=fcs>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-continuation-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1>
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:endnote-separator' id=es>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1 width="33%">
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:endnote-continuation-separator' id=ecs>
+
+<p class=MsoNormal><span lang=EN-US><span style='mso-special-character:footnote-continuation-separator'><![if !supportFootnotes]>
+
+<hr align=left size=1>
+
+<![endif]></span></span></p>
+
+</div>
+
+<div style='mso-element:header' id=h1>
+
+<p class=MsoHeader><span lang=EN-US>IEEE
+  P{{ docnumeric }}{% if draft %}/D{{ draft }}, {{ draft_month }} {{ draft_year }}{% endif %}</span></p>
+
+</div>
+
+<div style='mso-element:header' id=fh1>
+
+<p class=MsoHeader><span lang=EN-US>IEEE P{{ docnumeric }}{% if draft %}/D{{ draft }}, {{ draft_month }} {{ draft_year }}{% endif %}</span></p>
+
+</div>
+
+<div style='mso-element:footer' id=f8>
+
+<p class=MsoFooter style='tab-stops:right 432.0pt'><!--[if supportFields]><span
+class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><span
+style='mso-element:field-begin'></span>PAGE<span style='mso-spacerun:yes'> 
+</span><span style='mso-element:field-separator'></span></span></span><![endif]--><span
+class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'>9</span></span><!--[if supportFields]><span
+class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><span
+style='mso-element:field-end'></span></span></span><![endif]--><span
+class=MsoPageNumber><span lang=EN-US style='font-size:10.0pt'><o:p></o:p></span></span></p>
+
+<p class=MsoFooter style='tab-stops:right 432.0pt'><span lang=EN-US>Copyright ©
+{{ draft_year }} IEEE. All rights reserved.</span></p>
+
+<p class=MsoFooter style='tab-stops:right 432.0pt'><span lang=EN-US>This is an
+unapproved IEEE Standards Draft, subject to change.</span></p>
+
+</div>
+
+<div style='mso-element:header' id=h9>
+
+<p class=MsoHeader align=center style='text-align:center;tab-stops:right 432.0pt'><span
+lang=EN-US style='mso-bidi-font-size:8.0pt'>IEEE
+P&lt;designation&gt;/D&lt;draft_number&gt;, &lt;draft_month&gt;
+&lt;draft_year&gt;<o:p></o:p></span></p>
+
+</div>
+
+</body>
+
+</html>
+

data/lib/isodoc/ieee/html/html_ieee_titlepage.html

@@ -2,30 +2,32 @@
 
 <div class="doctitle-en"><span>P{{ docnumeric }}™{% if draft %}/D{{ draft }}{% endif %}</span><br/>
    <span lang="EN-US">{{ full_doctitle }}</span></div>
-{% if doctitleamdlabel %}
-<div class="doctitle-part">{{ doctitleamdlabel }}{% if doctitleamd %}: {{ doctitleamd }}{% endif %}</div>
+{% if amd %}
+<div class="doctitle-part">Amendment {{ amd }}</div>
 {% endif %}
-{% if doctitlecorrlabel %}
-<div class="doctitle-part">{{ doctitlecorrlabel }}</div>
+{% if corr %}
+<div class="doctitle-part">Corrigenda {{ corr }}</div>
 {% endif %}
+{%if provenance_doctitle %}
+<div class="doctitle-part">({{ provenance_doctitle }})</div>
+{%endif%}
 </div>
 
 <div><p>Developed by the</p>
   <p><b>{{ technical_committee }}</b></p>
 <p>of the</p>
 <p><b>IEEE {{ society }}</b></p>
-<p>Approved {{ confirmeddate }}</p>
+<p>Approved {{ issueddate }}</p>
 <p>IEEE SA Standards Board</p>
 </div>
 
-
-
-
-<div class="coverpage_docstage">
-  {% if unpublished %}
-  <p>{{ stageabbr }} stage</p>
-  {% endif %}
+{% if trial_use %}
+<div>
+  {% if feedback_endeddate %}<p>Comments due: {{ feedback_endeddate }}</p>{% endif %}
+  {% if obsoleteddate %}<p>Expires: {{ obsoleteddate }}</p>{% endif %}
 </div>
+{% endif %}
+
 
 {% if unpublished %}
 <div class="coverpage_warning">

data/lib/isodoc/ieee/html/htmlstyle.css

@@ -865,7 +865,8 @@ pre {
     text-transform: uppercase;
     margin-left: -1.5em; }
   .example .example-title {
-    margin-left: -1.5em; }
+    margin-left: -1.5em;
+    font-style: italic; }
   .example pre,
   .example .pseudocode {
     background: none; }

data/lib/isodoc/ieee/html/htmlstyle.scss

@@ -560,6 +560,7 @@ pre {
 
     .example-title {
         margin-left: -1.5em;
+        font-style: italic;
     }
 
     pre,