metanorma-ieee 1.3.3 → 1.3.6

data/lib/isodoc/ieee/presentation_ref.rb

@@ -114,6 +114,20 @@ module IsoDoc
         id = UUIDTools::UUID.random_create.to_s
         "<fn reference='#{id}'><p>#{note.content}</p></fn>"
       end
+
+      def omit_docid_prefix(prefix)
+        prefix == "DOI" and return true
+        super
+      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
     end
   end
 end

data/lib/isodoc/ieee/presentation_terms.rb

@@ -2,6 +2,7 @@ module IsoDoc
   module Ieee
     class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
       def multidef(elem)
+       # require "debug"; binding.b
         number_multidef(elem)
         collapse_multidef(elem)
       end
@@ -10,8 +11,7 @@ module IsoDoc
         c = IsoDoc::XrefGen::Counter.new("@")
         elem.xpath(ns("./definition")).each do |d|
           c.increment(d)
-          d.elements.first.children.first.previous =
-            "<strong>(#{c.print})</strong>&#xa0;"
+          d.elements.first.add_first_child "<strong>(#{c.print})</strong>&#xa0;"
         end
       end
 
@@ -36,9 +36,11 @@ module IsoDoc
         docxml.xpath(ns(".//definition/verbal-definition")).each do |v|
           v.elements.all? { |e| %w(termsource p).include?(e.name) } or next
           p = v.xpath(ns("./p"))
+          s = v.xpath(ns('./termsource'))
+          s.empty? or 
+          s = " (#{s.map { |x| to_xml(x) }.join("\n")})"
           v.children =
-            "<p>#{p.map(&:children).map { |x| to_xml(x) }.join("\n")}</p>" \
-            "#{v.xpath(ns('./termsource')).to_xml}"
+            "<p>#{p.map(&:children).map { |x| to_xml(x) }.join("\n")}#{s}</p>"
         end
         super
       end
@@ -214,6 +216,13 @@ module IsoDoc
         end
       end
 
+      # domain is rendered in designation_field instead
+      def termdomain(elem)
+        d = elem.at(ns(".//domain")) or return
+        d["hidden"] = "true"
+      end
+
+      # TODO wrap domain not in <domain>, but <span class="domain"> or equivalent
       def designation_field(desgn, name)
         if desgn.name == "preferred"
           f = desgn.xpath(ns("./../domain | ./../subject")).map(&:remove)
@@ -236,8 +245,13 @@ module IsoDoc
       end
 
       def termnote1(elem)
+        lbl = termnote_label(elem)
+        prefix_name(elem, { label: block_delim }, lower2cap(lbl), "name")
+      end
+
+      def termnote_label(elem)
         lbl = l10n(@xrefs.anchor(elem["id"], :label)&.strip || "???")
-        prefix_name(elem, block_delim, lower2cap(lbl), "name")
+        l10n lbl
       end
 
       def term(docxml); end

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -18,8 +18,9 @@ module IsoDoc
         ret = resolve_eref_connectives(eref_locality_stacks(refs, target,
                                                             node))
         node["droploc"] = droploc
+        p = prefix_clause(target, refs.first.at(ns("./locality")))
         eref_localities1({ target: target, number: "pl",
-                           type: prefix_clause(target, refs.first.at(ns("./locality"))),
+                           type: p,
                            from: l10n(ret[1..-1].join), node: node,
                            lang: @lang })
       end
@@ -57,12 +58,18 @@ module IsoDoc
         @xrefs.anchor(node["target"], :type) == "clause" &&
           @xrefs.anchor(node["target"], :level) > 1 &&
           !start_of_sentence(node) and
-          linkend = linkend.sub(/^Clause /, "")
+          linkend = strip_initial_clause(linkend)
         container = @xrefs.anchor(node["target"], :container, false)
         linkend = prefix_container(container, linkend, node, node["target"])
         capitalise_xref(node, linkend, anchor_value(node["target"]))
       end
 
+      def strip_initial_clause(linkend)
+        x = Nokogiri::XML("<a>#{linkend}</a>")
+        x.at(".//span[@class = 'fmt-element-name']")&.remove
+        to_xml(x.elements.first.children).strip
+      end
+
       def eref_locality_populate(type, node, number)
         type == "page" and return ""
         super
@@ -72,38 +79,41 @@ module IsoDoc
         "&#x2014;"
       end
 
-      def note1(elem)
-        elem.parent.name == "bibitem" || elem["notag"] == "true" and return
-        n = @xrefs.get[elem["id"]]
-        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")
+      def note_delim(_elem)
+        "&#x2014;"
       end
 
       def annex1(elem)
         if @doctype == "whitepaper"
           annex1_whitepaper(elem)
         else
-          annex1_default(elem)
+          super
         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"
+          d = t.dup
+          # TODO fmt-variant-title
+          d.name = "variant-title"
+          d["type"] = "sub"
+          t.next = d
         end
-        elem.children.first.previous = "<title>#{lbl}</title>"
+        elem.add_first_child "<fmt-title>#{lbl}</fmt-title>"
       end
 
+      def annex_delim(_elem)
+      "<br/>"
+    end
+
+      # KILL
       def annex1_default(elem)
         lbl = @xrefs.anchor(elem["id"], :label)
         if t = elem.at(ns("./title"))
           t.children = "<strong>#{to_xml(t.children)}</strong>"
         end
-        prefix_name(elem, "<br/>", lbl, "title")
+        prefix_name(elem, { caption: "<br/>" }, lbl, "title")
       end
 
       def amend1(elem)
@@ -216,6 +226,13 @@ module IsoDoc
         dest.children.first.next = source
       end
 
+      def example1(elem)
+        super
+        n = elem.at(ns("./fmt-name")) or return
+        n << l10n("<span class='fmt-caption-delim'>:</span>")
+        n.children.wrap("<em></em>")
+      end
+
       include Init
     end
   end

data/lib/isodoc/ieee/word_authority.rb

@@ -153,9 +153,9 @@ module IsoDoc
       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=""/>'
+          j.zero? && idx.zero? and p.add_first_child <<~XML
+            <a style="mso-footnote-id:ftn0" href="#_ftnref0" name="_ftn0" title=""/>
+          XML
         end
       end
 
@@ -203,9 +203,9 @@ module IsoDoc
       end
 
       def abstract_header(dest)
-        dest.elements.first.children.first.previous =
-          "<span class='IEEEStdsAbstractHeader'><span lang='EN-US'>" \
-          "Abstract:</span></span> "
+        dest.elements.first.add_first_child <<~XML
+          <span class='IEEEStdsAbstractHeader'><span lang='EN-US'>Abstract:</span></span>
+        XML
       end
 
       def introduction_cleanup(docxml)

data/lib/isodoc/ieee/word_cleanup_blocks.rb

@@ -78,28 +78,11 @@ module IsoDoc
       end
 
       def caption_cleanup(docxml)
-        table_caption(docxml)
-        figure_caption(docxml)
         example_caption(docxml)
       end
 
-      def table_caption(docxml)
-        docxml.xpath("//p[@class = 'TableTitle']").each do |s|
-          s.children = to_xml(s.children)
-            .sub(/^#{@i18n.table}(\s+[A-Z0-9.]+)?/, "")
-        end
-      end
-
-      def figure_caption(docxml)
-        docxml.xpath("//p[@class = 'FigureTitle']").each do |s|
-          s.children = to_xml(s.children)
-            .sub(/^#{@i18n.figure}(\s+[A-Z0-9.]+)?/, "")
-        end
-      end
-
       def example_caption(docxml)
         docxml.xpath("//p[@class = 'example-title']").each do |s|
-          s.children = "<em>#{to_xml(s.children)}</em>"
           s["class"] = stylesmap[:MsoNormal]
         end
       end

data/lib/isodoc/ieee/word_convert.rb

@@ -67,9 +67,9 @@ module IsoDoc
       def abstract(clause, out)
         page_break(out)
         out.div **attr_code(id: clause["id"], class: "abstract") do |s|
-          clause_name(clause, clause.at(ns("./title")), s,
+          clause_name(clause, clause.at(ns("./fmt-title")), s,
                       { class: stylesmap[:AbstractTitle] })
-          clause.elements.each { |e| parse(e, s) unless e.name == "title" }
+          clause.elements.each { |e| parse(e, s) unless e.name == "fmt-title" }
         end
       end
 
@@ -120,8 +120,7 @@ module IsoDoc
           formula_parse1(node, div)
           formula_where(node.at(ns("./dl")), div)
           node.children.each do |n|
-            next if %w(stem dl name).include? n.name
-
+            %w(stem dl fmt-name).include? n.name and next
             parse(n, div)
           end
         end
@@ -132,8 +131,7 @@ module IsoDoc
       end
 
       def formula_where(dlist, out)
-        return unless dlist
-
+        dlist or return
         dlist.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
           formula_where1(out, dt, dd)
         end
@@ -158,54 +156,73 @@ module IsoDoc
       end
 
       def annex_name(_annex, name, div)
-        return if name.nil?
-
-        name&.at(ns("./strong"))&.remove # supplied by CSS list numbering
+        name.nil? and return
+        name&.at(ns(".//strong"))&.remove # supplied by CSS list numbering
         div.h1 class: "Annex" do |t|
-          annex_name1(name, t)
+          # annex_name1(name, t)
+          children_parse(name, t)
           clause_parse_subtitle(name, t)
         end
       end
 
-      def annex_name1(name, out)
-        name.children.each do |c2|
-          if c2.name == "span" && c2["class"] == "obligation"
-            out.span style: "font-weight:normal;" do |s|
-              c2.children.each { |c3| parse(c3, s) }
-            end
-          else parse(c2, out)
-          end
+      def span_parse(node, out)
+        if node["class"] == "fmt-obligation"
+          node.delete("class")
+          node["style"] = "font-weight:normal;"
         end
+        super
       end
 
       def termnote_parse(node, out)
-        name = node&.at(ns("./name"))&.remove
+        name = node.at(ns("./fmt-name"))
+        para = node.at(ns("./p"))
         out.div **note_attrs(node) do |div|
           div.p do |p|
             name and termnote_label(p, name)
-            para_then_remainder(node.first_element_child, node, p, div)
+            children_parse(para, p)
           end
+          para.xpath("./following-sibling::*").each { |n| parse(n, div) }
         end
       end
 
       def termnote_label(para, name)
         para.span class: "note_label" do |s|
           name.children.each { |n| parse(n, s) }
-          s << termnote_delim
         end
       end
 
       # STYLE
       def table_of_contents(clause, out)
         out.div class: "WordSectionContents" do |div|
-          clause_name(clause, clause.at(ns("./title")), div,
+          clause_name(clause, clause.at(ns("./fmt-title")), div,
                       { class: "IEEEStdsLevel1frontmatter" })
           clause.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
 
+      # Figure 1— remove each of these
+      def figure_name_parse(_node, div, name)
+        name.nil? and return
+        name.at(".//xmlns:semx[@element = 'autonum']/"\
+          "preceding-sibling::*[normalize-space() = '']")&.remove
+        name.xpath(ns(".//span[@class = 'fmt-element-name']  | "\
+                      ".//span[@class = 'fmt-caption-delim'] | "\
+                      ".//semx[@element = 'autonum']")).each(&:remove)
+        super
+      end
+
+      def table_title_parse(node, out)
+        name = node.at(ns("./fmt-name")) or return
+        name.at(".//xmlns:semx[@element = 'autonum']/"\
+          "preceding-sibling::*[normalize-space() = '']")&.remove
+        name.xpath(ns(".//span[@class = 'fmt-element-name']  | "\
+                      ".//span[@class = 'fmt-caption-delim'] | "\
+                      ".//semx[@element = 'autonum']")).each(&:remove)
+        super
+      end
+
       include BaseConvert
       include Init
     end

data/lib/isodoc/ieee/word_wp_convert.rb

@@ -85,10 +85,10 @@ module IsoDoc
       end
 
       def abstract_body(clause, out)
-        clause_name(clause, clause.at(ns("./title")), out,
+        clause_name(clause, clause.at(ns("./fmt-title")), out,
                     { class: stylesmap[:AbstractTitle],
                       style: ABSTRACT_MARGIN })
-        clause.elements.each { |e| parse(e, out) unless e.name == "title" }
+        clause.elements.each { |e| parse(e, out) unless e.name == "fmt-title" }
       end
 
       def clause(node, out)
@@ -98,10 +98,9 @@ module IsoDoc
 
       def figure_parse1(node, out)
         out.div **figure_attrs(node) do |div|
-          figure_name_parse(node, div, node.at(ns("./name")))
+          figure_name_parse(node, div, node.at(ns("./fmt-name")))
           node.children.each do |n|
-            figure_key(out) if n.name == "dl"
-            parse(n, div) unless n.name == "name"
+            parse(n, div) unless n.name == "fmt-name"
           end
         end
       end

data/lib/isodoc/ieee/xref.rb

@@ -50,14 +50,13 @@ module IsoDoc
           "#{@klass.norm_ref_xpath} | //sections/terms | " \
           "//sections/definitions | //clause[parent::sections]"
         if @hierarchical_assets
-          hierarchical_asset_names(doc.xpath("//xmlns:preface/child::*"),
-                                   "Preface")
+          hierarchical_asset_names(doc.xpath("//xmlns:preface/child::*"), "Preface")
           doc.xpath(ns(middle_sections)).each do |c|
             hierarchical_asset_names(c, @anchors[c["id"]][:label])
           end
         else
-          sequential_asset_names(doc.xpath(ns("//preface/*")))
-          sequential_asset_names(doc.xpath(ns(middle_sections)))
+          sequential_asset_names(doc.xpath(ns("//preface/* | " + middle_sections)))
+          #sequential_asset_names(doc.xpath(ns(middle_sections)))
         end
       end
 
@@ -65,9 +64,9 @@ module IsoDoc
         c = Counter.new
         clause.xpath(ns(".//formula")).noblank.each do |t|
           @anchors[t["id"]] = anchor_struct(
-            c.increment(t).print, container ? t : nil,
+            c.increment(t).print, t,
             t["inequality"] ? @labels["inequality"] : @labels["formula"],
-            "formula", t["unnumbered"]
+            "formula", { container: container, unnumb: t["unnumbered"] }
           )
         end
       end
@@ -78,10 +77,20 @@ module IsoDoc
           sequence = UUIDTools::UUID.random_create.to_s
           notes = t.xpath(ns("./termnote"))
           notes.noblank.each do |n|
-            @anchors[n["id"]] =
-              anchor_struct("#{@labels['termnote']} #{increment_label(notes, n, c)}",
-                            n, @labels["note_xref"], "termnote", false)
+              @anchors[n["id"]] =
+              { label: termnote_label(n, increment_label(notes, n, c)), type: "termnote",
+                value: c.print, elem: @labels["termnote"],
+                container: t["id"],
+                xref: anchor_struct_xref(c.print, n, @labels["note_xref"]) }
+            .merge(sequence: sequence)
+=begin
+              anchor_struct(
+                termnote_label(n, increment_label(notes, n, c)),
+                #labelled_autonum(@labels["termnote"], increment_label(notes, n, c)),
+                #"#{@labels['termnote']} #{increment_label(notes, n, c)}",
+                            n, @labels["note_xref"], "termnote", { container: true })
                 .merge(sequence: sequence)
+=end
           end
         end
       end
@@ -93,7 +102,7 @@ module IsoDoc
 
           @anchors[n["id"]] =
             anchor_struct(increment_label(notes, n, counter), n,
-                          @labels["note_xref"], "note", false)
+                          @labels["note_xref"], "note", { container: true })
               .merge(sequence: sequence)
         end
       end
@@ -102,9 +111,8 @@ module IsoDoc
         if @doctype == "whitepaper"
           title = Common::case_with_markup(@labels["annex"], "capital",
                                            @script)
-          l10n("#{title} #{num}")
-        else
-          super.sub(%r{<br/>(.*)$}, "<br/><span class='obligation'>\\1</span>")
+           l10n(labelled_autonum(title, num))
+        else super
         end
       end
     end

data/lib/metanorma/ieee/biblio.rng

@@ -1783,9 +1783,21 @@ that the `number` given for the series applies to the second iteration of number
 May be used to differentiate rendering of notes in bibliographies</a:documentation>
         </attribute>
       </optional>
-      <ref name="LocalizedMarkedUpString">
+      <ref name="LocalizedStringAttributes">
         <a:documentation>The content of the note</a:documentation>
       </ref>
+      <choice>
+        <oneOrMore>
+          <ref name="BasicBlockNoId">
+            <a:documentation>Multiple blocks of content</a:documentation>
+          </ref>
+        </oneOrMore>
+        <oneOrMore>
+          <ref name="TextElement">
+            <a:documentation>Single block of content</a:documentation>
+          </ref>
+        </oneOrMore>
+      </choice>
     </element>
   </define>
   <define name="bibabstract">

data/lib/metanorma/ieee/cleanup.rb

@@ -235,7 +235,9 @@ module Metanorma
       def provenance_title1(updates, merges)
         ret = ""
         u = @isodoc.i18n.boolean_conj(tm_id_extract(updates), "and")
+          .gsub(%r{</?(conn|comma|enum-comma)>}, "")
         m = @isodoc.i18n.boolean_conj(tm_id_extract(merges), "and")
+          .gsub(%r{</?(conn|comma|enum-comma)>}, "")
         u.empty? or ret += "Revision of #{u}"
         !u.empty? && !m.empty? and ret += "<br/>"
         m.empty? or ret += "Incorporates #{m}"

data/lib/metanorma/ieee/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.3.4 -->
+<!-- VERSION v1.4.1 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -326,7 +326,7 @@ normative or informative references, some split references into sections organiz
       <a:documentation>Content of note</a:documentation>
       <oneOrMore>
         <choice>
-          <ref name="paragraph"/>
+          <ref name="paragraph-with-footnote"/>
           <ref name="ul"/>
           <ref name="ol"/>
           <ref name="dl"/>
@@ -412,7 +412,7 @@ normative or informative references, some split references into sections organiz
       <element name="note">
         <ref name="OptionalId"/>
         <oneOrMore>
-          <ref name="paragraph"/>
+          <ref name="paragraph-with-footnote"/>
         </oneOrMore>
       </element>
     </define>
@@ -1977,7 +1977,7 @@ used in document amendments</a:documentation>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the verbal representation of the term</a:documentation>
-          <ref name="paragraph"/>
+          <ref name="paragraph-with-footnote"/>
           <ref name="dl"/>
           <ref name="ol"/>
           <ref name="ul"/>
@@ -2015,7 +2015,7 @@ used in document amendments</a:documentation>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the term note</a:documentation>
-          <ref name="paragraph"/>
+          <ref name="paragraph-with-footnote"/>
           <ref name="ul"/>
           <ref name="ol"/>
           <ref name="dl"/>
@@ -2037,7 +2037,7 @@ used in document amendments</a:documentation>
           <ref name="dl"/>
           <ref name="quote"/>
           <ref name="sourcecode"/>
-          <ref name="paragraph"/>
+          <ref name="paragraph-with-footnote"/>
           <ref name="figure"/>
         </choice>
       </oneOrMore>

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ieee
-    VERSION = "1.3.3".freeze
+    VERSION = "1.3.6".freeze
   end
 end

data/metanorma-ieee.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 2.9.6"
+  spec.add_dependency "metanorma-standoc", "~> 2.10.2"
   spec.add_dependency "mnconvert", "~> 1.20"
   spec.add_dependency "pubid"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.6
+        version: 2.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.6
+        version: 2.10.2
 - !ruby/object:Gem::Dependency
   name: mnconvert
   requirement: !ruby/object:Gem::Requirement