metanorma-ieee 1.5.3 → 1.5.4

data/lib/metanorma/ieee/cleanup_ref.rb

@@ -157,104 +157,6 @@ module Metanorma
         bib.xpath("./contributor[role/@type = 'publisher']/organization/name")
           .map(&:text)
       end
-
-      BIBITEM_NO_AVAIL =
-        "//references/bibitem[not(note[@type = 'Availability'])]".freeze
-
-      def withdrawn_note(xmldoc, provenance_notes)
-        xmldoc.xpath(BIBITEM_NO_AVAIL).each do |b|
-          bib_pubs(b).include?(IEEE) or next
-          b.at("./status/stage")&.text == "withdrawn" or next
-          docid = b.at("./docidentifier[@type = 'IEEE'][not(@scope)]")
-          note = provenance_notes["ieee-withdrawn"].sub("%", docid.text)
-          insert_availability_note(b, note)
-        end
-      end
-
-      AVAIL_PUBS = {
-        ieee: IEEE,
-        cispr: "International special committee on radio interference",
-        etsi: "European Telecommunications Standards Institute",
-        oasis: "OASIS",
-        "w3c": "World Wide Web Consortium",
-        "3gpp": "3rd Generation Partnership Project",
-      }.freeze
-
-      def available_note(xmldoc, provenance_notes)
-        iso_iec_available_note(xmldoc, provenance_notes["iso-iec"], true, true)
-        iso_iec_available_note(xmldoc, provenance_notes["iso"], true, false)
-        iso_iec_available_note(xmldoc, provenance_notes["iec"], false, true)
-        itu_available_note(xmldoc, provenance_notes["itut"], true)
-        itu_available_note(xmldoc, provenance_notes["itur"], false)
-        nist_available_note(xmldoc, provenance_notes["fips"], true)
-        nist_available_note(xmldoc, provenance_notes["nist"], false)
-        ietf_available_note(xmldoc, provenance_notes["ietf"])
-        AVAIL_PUBS.each do |k, v|
-          sdo_available_note(xmldoc, provenance_notes[k.to_s], v)
-        end
-      end
-
-      def sdo_available_note(xmldoc, note, publisher)
-        ret = xmldoc.xpath(BIBITEM_NO_AVAIL).detect do |b|
-          bib_pubs(b).include?(publisher)
-        end
-        insert_availability_note(ret, note)
-      end
-
-      def iso_iec_available_note(xmldoc, note, iso, iec)
-        ret = xmldoc.xpath(BIBITEM_NO_AVAIL).detect do |b|
-          pubs = bib_pubs(b)
-          has_iec = pubs.include?("International Electrotechnical Commission")
-          has_iso = pubs.include?("International Organization for Standardization")
-          ((has_iec && iec) || (!has_iec && !iec)) &&
-            ((has_iso && iso) || (!has_iso && !iso))
-        end
-        insert_availability_note(ret, note)
-      end
-
-      def ietf_available_note(xmldoc, note)
-        ret = xmldoc.xpath(BIBITEM_NO_AVAIL).detect do |b|
-          b.at("./docidentifier[@type = 'IETF']")
-        end
-        insert_availability_note(ret, note)
-      end
-
-      def itu_available_note(xmldoc, note, itu_t)
-        ret = xmldoc.xpath(BIBITEM_NO_AVAIL).detect do |b|
-          has_itu_t = /^ITU-T/.match?(b.at("./docidentifier[@type = 'ITU']")&.text)
-          bib_pubs(b).include?("International Telecommunication Union") &&
-            !has_itu_t && !itu_t || (has_itu_t && itu_t)
-        end
-        insert_availability_note(ret, note)
-      end
-
-      def nist_available_note(xmldoc, note, fips)
-        ret = xmldoc.xpath(BIBITEM_NO_AVAIL).detect do |b|
-          id = b.at("./docidentifier[@type = 'NIST']")
-          has_fips = /\bFIPS\b/.match?(id&.text)
-          id && ((has_fips && !fips) || (!has_fips && fips))
-        end
-        insert_availability_note(ret, note)
-      end
-
-      def insert_availability_note(bib, msg)
-        bib or return
-        Array(msg).each do |msg1|
-          note = %(<note type="Availability"><p>#{msg1}</p></note>)
-          if b = insert_availability_note_ins(bib)
-            b.next = note
-          end
-        end
-      end
-
-      def insert_availability_note_ins(bib)
-        if b = bib.at("./language | ./script | ./abstract | ./status")
-          b.previous
-        else bib.at("./contributor") || bib.at("./date") ||
-          bib.at("./docnumber") || bib.at("./docidentifier") ||
-          bib.at("./title")
-        end
-      end
     end
   end
 end

data/lib/metanorma/ieee/cleanup_ref_fn.rb

@@ -0,0 +1,116 @@
+module Metanorma
+  module Ieee
+    class Converter < Standoc::Converter
+      BIBITEM_NO_AVAIL =
+        "//references[@normative='true']/bibitem[not(note[@type = 'Availability'])] | "\
+        "//references[@normative='false']/bibitem[not(note[@type = 'Availability'])]".freeze
+
+      def sorted_bibitem_no_avail(xmldoc)
+        # Get normative references first, maintaining their order
+        normative_bibitems = xmldoc.xpath("//references[@normative='true']/bibitem[not(note[@type = 'Availability'])]")
+        
+        # Get non-normative references second, maintaining their order  
+        non_normative_bibitems = xmldoc.xpath("//references[@normative='false']/bibitem[not(note[@type = 'Availability'])]")
+        
+        # Return concatenated array with normative first
+        normative_bibitems.to_a + non_normative_bibitems.to_a
+      end
+
+      def withdrawn_note(xmldoc, provenance_notes)
+        sorted_bibitem_no_avail(xmldoc).each do |b|
+          bib_pubs(b).include?(IEEE) or next
+          b.at("./status/stage")&.text == "withdrawn" or next
+          docid = b.at("./docidentifier[@type = 'IEEE'][not(@scope)]")
+          note = provenance_notes["ieee-withdrawn"].sub("%", docid.text)
+          insert_availability_note(b, note)
+        end
+      end
+
+      AVAIL_PUBS = {
+        ieee: IEEE,
+        cispr: "International special committee on radio interference",
+        etsi: "European Telecommunications Standards Institute",
+        oasis: "OASIS",
+        "w3c": "World Wide Web Consortium",
+        "3gpp": "3rd Generation Partnership Project",
+      }.freeze
+
+      def available_note(xmldoc, provenance_notes)
+        bibitems = sorted_bibitem_no_avail(xmldoc)
+        iso_iec_available_note(bibitems, provenance_notes["iso-iec"], true, true)
+        iso_iec_available_note(bibitems, provenance_notes["iso"], true, false)
+        iso_iec_available_note(bibitems, provenance_notes["iec"], false, true)
+        itu_available_note(bibitems, provenance_notes["itut"], true)
+        itu_available_note(bibitems, provenance_notes["itur"], false)
+        nist_available_note(bibitems, provenance_notes["fips"], true)
+        nist_available_note(bibitems, provenance_notes["nist"], false)
+        ietf_available_note(bibitems, provenance_notes["ietf"])
+        AVAIL_PUBS.each do |k, v|
+          sdo_available_note(bibitems, provenance_notes[k.to_s], v)
+        end
+      end
+
+      def sdo_available_note(bibitems, note, publisher)
+        ret = bibitems.detect do |b|
+          bib_pubs(b).include?(publisher)
+        end
+        insert_availability_note(ret, note)
+      end
+
+      def iso_iec_available_note(bibitems, note, iso, iec)
+        ret = bibitems.detect do |b|
+          pubs = bib_pubs(b)
+          has_iec = pubs.include?("International Electrotechnical Commission")
+          has_iso = pubs.include?("International Organization for Standardization")
+          ((has_iec && iec) || (!has_iec && !iec)) &&
+            ((has_iso && iso) || (!has_iso && !iso))
+        end
+        insert_availability_note(ret, note)
+      end
+
+      def ietf_available_note(bibitems, note)
+        ret = bibitems.detect do |b|
+          b.at("./docidentifier[@type = 'IETF']")
+        end
+        insert_availability_note(ret, note)
+      end
+
+      def itu_available_note(bibitems, note, itu_t)
+        ret = bibitems.detect do |b|
+          has_itu_t = /^ITU-T/.match?(b.at("./docidentifier[@type = 'ITU']")&.text)
+          bib_pubs(b).include?("International Telecommunication Union") &&
+            !has_itu_t && !itu_t || (has_itu_t && itu_t)
+        end
+        insert_availability_note(ret, note)
+      end
+
+      def nist_available_note(bibitems, note, fips)
+        ret = bibitems.detect do |b|
+          id = b.at("./docidentifier[@type = 'NIST']")
+          has_fips = /\bFIPS\b/.match?(id&.text)
+          id && ((has_fips && !fips) || (!has_fips && fips))
+        end
+        insert_availability_note(ret, note)
+      end
+
+      def insert_availability_note(bib, msg)
+        bib or return
+        Array(msg).each do |msg1|
+          note = %(<note type="Availability"><p>#{msg1}</p></note>)
+          if b = insert_availability_note_ins(bib)
+            b.next = note
+          end
+        end
+      end
+
+      def insert_availability_note_ins(bib)
+        if b = bib.at("./language | ./script | ./abstract | ./status")
+          b.previous
+        else bib.at("./contributor") || bib.at("./date") ||
+          bib.at("./docnumber") || bib.at("./docidentifier") ||
+          bib.at("./title")
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/front.rb

@@ -91,6 +91,7 @@ module Metanorma
         ret = { number: node.attr("docnumber"),
                 part: node.attr("partnumber"),
                 year: ieee_id_year(node, initial: true),
+                draft: ieee_draft_numbers(node),
                 redline: @doctype == "redline",
                 publisher: pub[0],
                 copublisher: pub[1..-1] }
@@ -98,6 +99,12 @@ module Metanorma
         compact_blank(ret)
       end
 
+      def ieee_draft_numbers(node)
+        draft = node.attr("draft") or return nil
+        d = draft.split(".")
+        { version: d[0], revision: d[1] }.compact
+      end
+
       def ieee_id_params_amd(node, core)
         if a = node.attr("corrigendum-number")
           { corrigendum: { version: a,
@@ -186,6 +193,25 @@ module Metanorma
           a = node.attr("copyright-year") and i.year a
         end
       end
+
+      def title_english(node, xml)
+        title = node.attr("title") || node.attr("title-en") ||
+          node.attr("doctitle")
+        title_english1(title, "title-main", xml)
+        title_english1(node.attr("title-full"), "main", xml)
+        title_english1(node.attr("title-abbrev"), "title-abbrev", xml)
+      end
+
+      def title_english1(title, type, xml)
+        title.nil? and return
+        at = { language: "en", format: "text/plain" }
+        title = Metanorma::Utils::asciidoc_sub(title)
+        xml.title **attr_code(at.merge(type: type)) do |t|
+          t << title
+        end
+      end
+
+      def title_otherlangs(node, xml); end
     end
   end
 end

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.1.1 -->
+<!-- VERSION v2.1.2 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -123,6 +123,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="OlBody">
       <optional>
@@ -140,6 +144,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="OlAttributes">
       <a:documentation>NOTE: `start` attribute is not included by default, because of problems it raises with DOC output</a:documentation>
@@ -188,6 +196,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="dt">
       <element name="dt">
@@ -871,6 +883,12 @@ titlecase, or lowercase</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="ParagraphFnBody" combine="interleave">
+    <ref name="BlockSource">
+      <a:documentation>Bibliographic source for the information in the paragraph
+parargaph sources are currently only rendered in metanorma-plateau</a:documentation>
+    </ref>
+  </define>
   <define name="BasicBlock" combine="choice">
     <ref name="columnbreak"/>
   </define>

data/lib/metanorma/ieee/processor.rb

@@ -26,6 +26,7 @@ module Metanorma
           "Source Han Sans" => nil,
           "Source Han Sans Normal" => nil,
           "STIX Two Math" => nil,
+          "Montserrat ExtraBold" => nil,
         }
       end
 

data/lib/metanorma/ieee/relaton-ieee.rng

@@ -26,6 +26,10 @@
         <value>amendment</value>
         <value>corrigendum</value>
         <value>erratum</value>
+        <value>icap</value>
+        <value>document</value>
+        <value>industry-connections-report</value>
+        <value>industry-affiliate-network</value>
       </choice>
     </define>
   </include>

data/lib/metanorma/ieee/validate.rb

@@ -60,7 +60,7 @@ module Metanorma
       # Style manual 12.3.2
       def locality_erefs_validate(root)
         root.xpath("//eref[descendant::locality]").each do |t|
-          if !/[:-](\d+{4})$/.match?(t["citeas"])
+          if !/[:-](\d+{4})($|-\d\d)/.match?(t["citeas"])
             @log.add("Style", t,
                      "Undated reference #{t['citeas']} should not contain " \
                      "specific elements")

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ieee
-    VERSION = "1.5.3".freeze
+    VERSION = "1.5.4".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-18 00:00:00.000000000 Z
+date: 2025-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -299,6 +299,7 @@ files:
 - lib/isodoc/ieee/metadata.rb
 - lib/isodoc/ieee/pdf_convert.rb
 - lib/isodoc/ieee/presentation_bibdata.rb
+- lib/isodoc/ieee/presentation_bibitem.rb
 - lib/isodoc/ieee/presentation_concepts.rb
 - lib/isodoc/ieee/presentation_ref.rb
 - lib/isodoc/ieee/presentation_terms.rb
@@ -307,6 +308,7 @@ files:
 - lib/isodoc/ieee/word_cleanup.rb
 - lib/isodoc/ieee/word_cleanup_blocks.rb
 - lib/isodoc/ieee/word_convert.rb
+- lib/isodoc/ieee/word_toc.rb
 - lib/isodoc/ieee/word_wp_cleanup.rb
 - lib/isodoc/ieee/word_wp_convert.rb
 - lib/isodoc/ieee/xref.rb
@@ -320,6 +322,7 @@ files:
 - lib/metanorma/ieee/cleanup.rb
 - lib/metanorma/ieee/cleanup_boilerplate.rb
 - lib/metanorma/ieee/cleanup_ref.rb
+- lib/metanorma/ieee/cleanup_ref_fn.rb
 - lib/metanorma/ieee/converter.rb
 - lib/metanorma/ieee/front.rb
 - lib/metanorma/ieee/ieee-footnotes.yaml