metanorma-ieee 1.4.6 → 1.4.8

data/lib/isodoc/ieee/presentation_concepts.rb

@@ -103,7 +103,7 @@ module IsoDoc
           <semx element='related' source='#{adm['source']}' type='equivalent'><fmt-preferred>#{to_xml(adm)}</p></semx></fmt-preferred>
         TERM
         out.parent.next = <<~TERM
-          <term><fmt-preferred>#{to_xml(adm)}</fmt-preferred>
+          <term #{add_id_text}><fmt-preferred>#{to_xml(adm)}</fmt-preferred>
           <fmt-related>
             <semx element="related" source="#{pref['source']}" type="see"><fmt-preferred>#{to_xml(pref)}</fmt-preferred></semx>
           </fmt-related>

data/lib/isodoc/ieee/presentation_ref.rb

@@ -82,15 +82,15 @@ module IsoDoc
         true
       end
 
-      def creatornames(bibitem)
+      def creatornames(bib)
         ::Relaton::Render::Ieee::General
           .new(language: @lang, i18nhash: @i18n.get,
-               # template: { (bibitem["type"] || "misc").to_sym =>
+               # template: { (bib["type"] || "misc").to_sym =>
                # "{{ creatornames }}" },
                template: "{{ creatornames }}",
-               extenttemplate: { (bibitem["type"] || "misc").to_sym => "{{page}}" },
-               sizetemplate: { (bibitem["type"] || "misc").to_sym => "{{data}}" })
-          .render1(RelatonBib::XMLParser.from_xml(bibitem.to_xml))
+               extenttemplate: { (bib["type"] || "misc").to_sym => "{{page}}" },
+               sizetemplate: { (bib["type"] || "misc").to_sym => "{{data}}" })
+          .render1(RelatonBib::XMLParser.from_xml(bib.to_xml))
       end
 
       def bibliography_bibitem_number1(bibitem, idx, normative)
@@ -119,7 +119,8 @@ module IsoDoc
       def availability_note(bib)
         note = bib.at(ns("./note[@type = 'Availability']")) or return ""
         id = UUIDTools::UUID.random_create.to_s
-        "<fn id='_#{id}' reference='#{id}'><p>#{note.content}</p></fn>"
+        @new_ids[id] = nil
+        "<fn id='#{id}' reference='#{id}'><p>#{note.content}</p></fn>"
       end
 
       def omit_docid_prefix(prefix)
@@ -128,8 +129,7 @@ module IsoDoc
       end
 
       def bracket_if_num(num)
-        return nil if num.nil?
-
+        num.nil? and return nil
         num = num.text.sub(/^\[/, "").sub(/\]$/, "")
         return "[#{num}]" if /^B?\d+$/.match?(num)
 

data/lib/isodoc/ieee/presentation_terms.rb

@@ -63,7 +63,7 @@ module IsoDoc
       def termcontainers(docxml)
         super
         docxml.xpath(ns("//term[not(./fmt-definition)]")).each do |t|
-          t << "<fmt-definition></fmt-definition>"
+          t << "<fmt-definition #{add_id_text}></fmt-definition>"
         end
       end
 
@@ -73,12 +73,11 @@ module IsoDoc
 
       def collapse_term1(term)
         ret = collapse_term_template(
-          pref: term.at(ns("./fmt-preferred")),
+          pref: term.at(ns("./fmt-preferred"))&.remove,
           def: term.at(ns("./fmt-definition")),
           rels: term.at(ns("./fmt-related"))&.remove,
           source: term.at(ns("./fmt-termsource"))&.remove,
         )
-        term.at(ns("./fmt-preferred"))&.remove
         term.at(ns("./fmt-admitted"))&.remove
         ins = term.at(ns("./fmt-definition")) and
           ins.children = ret
@@ -86,24 +85,28 @@ module IsoDoc
 
       def collapse_term_related(rels)
         rels or return
+        collapse_term_related1(rels)
+        ret = rels.xpath(ns("./p")).map do |x|
+          to_xml(x.children).strip
+        end.join(". ")
+        ret += "." unless ret.empty?
+        ret
+      end
+
+      def collapse_term_related1(rels)
         rels.xpath(ns("./p")).each do |p|
           orig = p.at(ns(".//semx[@element = 'related']"))
           reln = "<em>#{@i18n.relatedterms[orig['type']]}:</em> "
           p.add_first_child reln
           p.xpath(ns(".//semx[@element = 'related']")).each do |r|
-            r.at(ns("./fmt-preferred")) or r.add_first_child "**RELATED TERM NOT FOUND**"
+            r.at(ns("./fmt-preferred")) or
+              r.add_first_child "**RELATED TERM NOT FOUND**"
           end
         end
-        ret = rels.xpath(ns("./p")).map do |x|
-          to_xml(x.children).strip
-        end.join(". ")
-        ret += "." unless ret.empty?
-        ret
       end
 
       def collapse_term_template(opt)
         defn, multiblock = collapse_unwrap_definition(opt[:def])
-        #src = nil
         opt[:source] and src = "(#{to_xml(opt[:source].remove.children).strip})"
         t = collapse_term_pref(opt)
         tail = "#{collapse_term_related(opt[:rels])} #{src}"

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -171,9 +171,6 @@ module IsoDoc
 
       def ol_numbering1(elem, idx)
         elem["type"] = ol_depth_rotate(elem, idx).to_s
-        elem.xpath(ns("./li")).each do |li|
-          li["id"] ||= "_#{UUIDTools::UUID.random_create}"
-        end
       end
 
       # overrides IsoDoc:: XrefGen::OlTypeProvider: we trigger

data/lib/metanorma/ieee/cleanup.rb

@@ -1,51 +1,10 @@
 require_relative "cleanup_ref"
+require_relative "cleanup_boilerplate"
 require_relative "term_lookup_cleanup"
 
 module Metanorma
   module Ieee
     class Converter < Standoc::Converter
-      def initial_boilerplate(xml, isodoc)
-        intro_boilerplate(xml, isodoc)
-        super if @document_scheme == "ieee-sa-2021"
-        xml.at("//boilerplate") or return
-        initial_note(xml)
-        word_usage(xml)
-        participants(xml)
-        footnote_boilerplate_renumber(xml)
-      end
-
-      def footnote_boilerplate_renumber(xml)
-        xml.xpath("//boilerplate//fn").each_with_index do |f, i|
-          f["reference"] = "_boilerplate_#{i + 1}"
-        end
-      end
-
-      def intro_boilerplate(xml, isodoc)
-        intro = xml.at("//introduction/title") or return
-        template = <<~ADM
-          This introduction is not part of P{{ docnumeric }}{% if draft %}/D{{ draft }}{% endif %}, {{ full_doctitle }}
-        ADM
-        adm = isodoc.populate_template(template)
-        intro.next = "<admonition>#{adm}</admonition>"
-      end
-
-      def initial_note(xml)
-        n = xml.at("//boilerplate//note[@anchor = 'boilerplate_front']")
-        s = xml.at("//sections")
-        (n && s) or return
-        s.children.empty? and s << " "
-        s.children.first.previous = n.remove
-      end
-
-      def word_usage(xml)
-        @document_scheme == "ieee-sa-2021" or return
-        n = xml.at("//boilerplate//clause[@anchor = 'boilerplate_word_usage']")
-          &.remove
-        s = xml.at("//clause[@type = 'overview']")
-        (n && s) or return
-        s << n
-      end
-
       def obligations_cleanup_norm(xml)
         super
         xml.xpath("//sections/clause").each do |r|
@@ -94,6 +53,7 @@ module Metanorma
         ins = n.at("./p[last()]")
         ins << "<fn reference='_boilerplate_cleanup1'>" \
                "<p>#{@i18n.note_inform_fn}</p></fn>"
+        add_id(ins.last_element_child)
       end
 
       def table_footnote_renumber1(fnote, idx, seen)
@@ -135,7 +95,7 @@ module Metanorma
 
       def boilerplate_isodoc(xmldoc)
         x = xmldoc.dup
-        x.root.add_namespace(nil, self.class::XML_NAMESPACE)
+        x.root.add_namespace(nil, xml_namespace)
         xml = Nokogiri::XML(x.to_xml)
         i = isodoc(@lang, @script, @locale)
         i.bibdata_i18n(xml.at("//xmlns:bibdata"))
@@ -143,75 +103,6 @@ module Metanorma
         i
       end
 
-      PARTICIPANT_BOILERPLATE_LOCATIONS =
-        { "boilerplate-participants-wg": "working group",
-          "boilerplate-participants-bg": "balloting group",
-          "boilerplate-participants-sb": "standards board",
-          "boilerplate-participants-blank": nil }.freeze
-
-      def participants(xml)
-        @document_scheme == "ieee-sa-2021" or return
-        PARTICIPANT_BOILERPLATE_LOCATIONS.each do |k, v|
-          populate_participants(xml, k.to_s, v)
-        end
-        p = xml.at(".//p[@type = 'emeritus_sign']")
-        ul = xml.at("//clause[@anchor = 'boilerplate-participants-sb']//ul")
-        p && ul and ul.next = p
-        xml.at("//sections//clause[@type = 'participants']")&.remove
-      end
-
-      def populate_participants(xml, target, subtitle)
-        t = xml.at("//clause[@anchor = '#{target}']/membership") or return
-        s = xml.xpath("//clause[@type = 'participants']/clause").detect do |x|
-          n = x.at("./title") and n.text.strip.downcase == subtitle
-        end
-        t.replace(populate_participants1(s || t))
-      end
-
-      def populate_participants1(clause)
-        participants_dl_to_ul(clause)
-        clause.xpath(".//ul | .//ol").each do |ul|
-          ul.name = "ul"
-          ul.xpath("./li").each { |li| populate_participants2(li) }
-          ul.xpath(".//p[normalize-space() = '']").each(&:remove)
-        end
-        clause.at("./title")&.remove
-        clause.children.to_xml
-      end
-
-      def participants_dl_to_ul(clause)
-        clause.xpath(".//dl").each do |dl|
-          dl.ancestors("dl, ul, ol").empty? or next
-          dl.name = "ul"
-          dl.xpath("./dt").each(&:remove)
-          dl.xpath("./dd").each { |li| li.name = "li" }
-        end
-      end
-
-      def populate_participants2(list)
-        curr = list
-        p = curr.at("./p[text() != '']") and curr = p
-        if dl = curr.at("./dl")
-          ret = extract_participants(dl)
-          dl.children = ret.keys.map do |k|
-            "<dt>#{k}</dt><dd><p>#{ret[k]}</p></dd>"
-          end.join
-        else list.children = "<dl><dt>name</dt><dd><p>#{curr.children.to_xml}" \
-                          "</p></dd><dt>role</dt><dd><p>member</p></dd></dl>"
-        end
-      end
-
-      def extract_participants(dlist)
-        key = ""
-        map = dlist.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
-          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) or
-            m[key.strip.downcase] = text_from_paras(dtd)
-        end
-        map["company"] &&= "<span class='organization'>#{map['company']}</span>"
-        map["role"] ||= "member"
-        map
-      end
-
       def text_from_paras(node)
         r = node.at("./p") and node = r
         node.children.to_xml.strip

data/lib/metanorma/ieee/cleanup_boilerplate.rb

@@ -0,0 +1,119 @@
+module Metanorma
+  module Ieee
+    class Converter < Standoc::Converter
+      def initial_boilerplate(xml, isodoc)
+        intro_boilerplate(xml, isodoc)
+        super if @document_scheme == "ieee-sa-2021"
+        xml.at("//boilerplate") or return
+        initial_note(xml)
+        word_usage(xml)
+        participants(xml)
+        footnote_boilerplate_renumber(xml)
+      end
+
+      def footnote_boilerplate_renumber(xml)
+        xml.xpath("//boilerplate//fn").each_with_index do |f, i|
+          f["reference"] = "_boilerplate_#{i + 1}"
+        end
+      end
+
+      def intro_boilerplate(xml, isodoc)
+        intro = xml.at("//introduction/title") or return
+        template = <<~ADM
+          This introduction is not part of P{{ docnumeric }}{% if draft %}/D{{ draft }}{% endif %}, {{ full_doctitle }}
+        ADM
+        adm = isodoc.populate_template(template)
+        intro.next = "<admonition>#{adm}</admonition>"
+        add_id(intro.next)
+      end
+
+      def initial_note(xml)
+        n = xml.at("//boilerplate//note[@anchor = 'boilerplate_front']")
+        s = xml.at("//sections")
+        (n && s) or return
+        s.children.empty? and s << " "
+        s.children.first.previous = n.remove
+      end
+
+      def word_usage(xml)
+        @document_scheme == "ieee-sa-2021" or return
+        n = xml.at("//boilerplate//clause[@anchor = 'boilerplate_word_usage']")
+          &.remove
+        s = xml.at("//clause[@type = 'overview']")
+        (n && s) or return
+        s << n
+      end
+
+      PARTICIPANT_BOILERPLATE_LOCATIONS =
+        { "boilerplate-participants-wg": "working group",
+          "boilerplate-participants-bg": "balloting group",
+          "boilerplate-participants-sb": "standards board",
+          "boilerplate-participants-blank": nil }.freeze
+
+      def participants(xml)
+        @document_scheme == "ieee-sa-2021" or return
+        PARTICIPANT_BOILERPLATE_LOCATIONS.each do |k, v|
+          populate_participants(xml, k.to_s, v)
+        end
+        p = xml.at(".//p[@type = 'emeritus_sign']")
+        ul = xml.at("//clause[@anchor = 'boilerplate-participants-sb']//ul")
+        p && ul and ul.next = p
+        xml.at("//sections//clause[@type = 'participants']")&.remove
+      end
+
+      def populate_participants(xml, target, subtitle)
+        t = xml.at("//clause[@anchor = '#{target}']/membership") or return
+        s = xml.xpath("//clause[@type = 'participants']/clause").detect do |x|
+          n = x.at("./title") and n.text.strip.downcase == subtitle
+        end
+        t.replace(populate_participants1(s || t))
+      end
+
+      def populate_participants1(clause)
+        participants_dl_to_ul(clause)
+        clause.xpath(".//ul | .//ol").each do |ul|
+          ul.name = "ul"
+          ul.xpath("./li").each { |li| populate_participants2(li) }
+          ul.xpath(".//p[normalize-space() = '']").each(&:remove)
+        end
+        clause.at("./title")&.remove
+        clause.children.to_xml
+      end
+
+      def participants_dl_to_ul(clause)
+        clause.xpath(".//dl").each do |dl|
+          dl.ancestors("dl, ul, ol").empty? or next
+          dl.name = "ul"
+          dl.xpath("./dt").each(&:remove)
+          dl.xpath("./dd").each { |li| li.name = "li" }
+        end
+      end
+
+      def populate_participants2(list)
+        add_id(list)
+        curr = list
+        p = curr.at("./p[text() != '']") and curr = p
+        if dl = curr.at("./dl")
+          ret = extract_participants(dl)
+          dl.children = ret.keys.map do |k|
+            "<dt>#{k}</dt><dd #{add_id_text}><p>#{ret[k]}</p></dd>"
+          end.join
+        else list.children =
+         "<dl><dt>name</dt><dd #{add_id_text}><p>#{curr.children.to_xml}" \
+         "</p></dd><dt>role</dt><dd #{add_id_text}><p>member</p></dd></dl>"
+        end
+      end
+
+      def extract_participants(dlist)
+        key = ""
+        map = dlist.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
+          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) or
+            m[key.strip.downcase] = text_from_paras(dtd)
+        end
+        map["company"] &&= "<span class='organization'>#{map['company']}</span>"
+        map["role"] ||= "member"
+        map
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/cleanup_ref.rb

@@ -44,7 +44,7 @@ module Metanorma
               when "standard", "techreport" then id
               else
                 bib1 = bib.dup
-                bib1.add_namespace(nil, self.class::XML_NAMESPACE)
+                bib1.add_namespace(nil, xml_namespace)
                 n = @i.creatornames(bib1)
                 n.nil? && bib["type"].nil? and n = id
                 n

data/lib/metanorma/ieee/converter.rb

@@ -9,9 +9,6 @@ require_relative "validate"
 module Metanorma
   module Ieee
     class Converter < Standoc::Converter
-      XML_ROOT_TAG = "ieee-standard".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/ieee".freeze
-
       register_for "ieee"
 
       def init(node)

data/lib/metanorma/ieee/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <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">
-<!-- VERSION v2.0.5 -->
+<!-- VERSION v2.0.7 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -76,6 +76,7 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
         <a:documentation>Title proper for a clause</a:documentation>
+        <ref name="RequiredId"/>
         <zeroOrMore>
           <ref name="TextElement"/>
         </zeroOrMore>
@@ -83,10 +84,19 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <zeroOrMore>
         <element name="variant-title">
           <a:documentation>Alternate title for a clause</a:documentation>
+          <ref name="RequiredId"/>
           <ref name="TypedTitleString"/>
         </element>
       </zeroOrMore>
     </define>
+    <define name="tname">
+      <element name="name">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="NestedTextElement"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="UlBody">
       <optional>
         <ref name="tname">
@@ -475,6 +485,7 @@ normative or informative references, some split references into sections organiz
     <!-- exclude figures? -->
     <define name="dd">
       <element name="dd">
+        <ref name="OptionalId"/>
         <zeroOrMore>
           <!-- exclude figures? -->
           <ref name="BasicBlock"/>
@@ -526,6 +537,7 @@ normative or informative references, some split references into sections organiz
       </choice>
     </define>
     <define name="TrAttributes">
+      <ref name="OptionalId"/>
       <optional>
         <attribute name="style">
           <a:documentation>CSS style: only background-color supported</a:documentation>
@@ -595,6 +607,7 @@ gives an explicit page orientation</a:documentation>
   </include>
   <!-- end overrides -->
   <define name="FnAttributes" combine="interleave">
+    <ref name="RequiredId"/>
     <optional>
       <attribute name="hiddenref">
         <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
@@ -604,6 +617,7 @@ This is done if the footnote reference is already presented in some other form,
     </optional>
   </define>
   <define name="TdAttributes" combine="interleave">
+    <ref name="RequiredId"/>
     <optional>
       <attribute name="style">
         <a:documentation>CSS style: only background-color supported</a:documentation>
@@ -801,6 +815,12 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="source">
+        <a:documentation>Sourcing of the current element in an external data model</a:documentation>
+        <ref name="IdRefType"/>
+      </attribute>
+    </optional>
   </define>
   <define name="OptionalId" combine="interleave">
     <optional>
@@ -808,6 +828,12 @@ titlecase, or lowercase</a:documentation>
         <a:documentation> User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="source">
+        <a:documentation>Sourcing of the current element in an external data model</a:documentation>
+        <ref name="IdRefType"/>
+      </attribute>
+    </optional>
   </define>
   <define name="ObligationType">
     <a:documentation>The force of a clause in a standard document: whether it has normative or informative effect</a:documentation>
@@ -954,6 +980,7 @@ titlecase, or lowercase</a:documentation>
 is used in particular to capture mutually agreed definitions of codepoints in Unicode Private Use Area</a:documentation>
         </attribute>
       </optional>
+      <ref name="OptionalId"/>
       <oneOrMore>
         <ref name="TextElement">
           <a:documentation>Textual content of span</a:documentation>
@@ -1808,7 +1835,7 @@ used in document amendments</a:documentation>
     </element>
   </define>
   <define name="TermAttributes">
-    <ref name="OptionalId"/>
+    <ref name="RequiredId"/>
     <ref name="LocalizedStringAttributes"/>
     <ref name="BlockAttributes"/>
   </define>
@@ -2151,6 +2178,7 @@ used in document amendments</a:documentation>
   <define name="termdefinition">
     <a:documentation>The definition of a term applied in the current document</a:documentation>
     <element name="definition">
+      <ref name="RequiredId"/>
       <optional>
         <attribute name="type">
           <a:documentation>Type of definition, used to differentiate it from other definitions of the same term if present</a:documentation>
@@ -2172,6 +2200,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="verbaldefinition">
     <element name="verbal-definition">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the verbal representation of the term</a:documentation>
@@ -2192,6 +2221,7 @@ used in document amendments</a:documentation>
   <define name="nonverbalrep">
     <a:documentation>Non-verbal representation of the term</a:documentation>
     <element name="non-verbal-representation">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the non-verbal representation of the term</a:documentation>

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ieee
-    VERSION = "1.4.6".freeze
+    VERSION = "1.4.8".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.4.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -332,6 +332,7 @@ files:
 - lib/metanorma/ieee/boilerplate.adoc
 - lib/metanorma/ieee/boilerplate_wp.adoc
 - lib/metanorma/ieee/cleanup.rb
+- lib/metanorma/ieee/cleanup_boilerplate.rb
 - lib/metanorma/ieee/cleanup_ref.rb
 - lib/metanorma/ieee/converter.rb
 - lib/metanorma/ieee/front.rb