metanorma-ieee 1.5.4 → 1.5.6

data/lib/isodoc/ieee/init.rb

@@ -22,8 +22,8 @@ module IsoDoc
       end
 
       def bibrenderer
-        ::Relaton::Render::Ieee::General.new(language: @lang,
-                                             i18nhash: @i18n.get)
+        ::Relaton::Render::Ieee::General
+          .new(language: @lang, script: @script, i18nhash: @i18n.get)
       end
 
       def fileloc(loc)

data/lib/isodoc/ieee/presentation_bibitem.rb

@@ -86,6 +86,7 @@ module IsoDoc
 
       def omit_docid_prefix(prefix)
         prefix == "DOI" and return true
+        prefix == "title" and return true
         super
       end
 

data/lib/isodoc/ieee/presentation_ref.rb

@@ -18,7 +18,7 @@ module IsoDoc
       # Style manual 19
       def anchor_linkend(node, linkend)
         if node["citeas"] && i = @bibanchors[node["bibitemid"]]
-          biblio_anchor_linkend(node, i)
+          biblio_anchor_linkend(node, i, linkend)
         elsif node["citeas"] && (i = @normrefanchors[node["bibitemid"]])
           cit = normref_anchor_linkend(node, i)
           cit || super
@@ -28,28 +28,47 @@ module IsoDoc
 
       # force Author-Date referencing on non-standards in norm ref
       def normref_anchor_linkend(node, bib)
-         @ref_renderings or return nil
-        %w(techreport standard).include?(bib[:type]) and return nil
+        @ref_renderings or return nil
+        %w(standard).include?(bib[:type]) and return nil
         cit = @ref_renderings[node["bibitemid"]][:citation]&.strip
         cit.empty? and cit = nil
         cit
       end
 
-      def biblio_anchor_linkend(node, bib)
-        if %w(techreport standard).include?(bib[:type])
-          if !node.children.empty?
-            to_xml(node.children).strip
-          elsif node["citeas"] == bib[:ord] then node["citeas"]
-          else [node["citeas"], bib[:ord]].compact.join(" ")
-          end
+      def biblio_anchor_linkend(node, bib, linkend)
+        if %w(standard).include?(bib[:type])
+          biblio_anchor_linkend_std(node, bib, linkend)
         else biblio_anchor_linkend_nonstd(node, bib)
         end
       end
 
+      def linkend_content(node)
+        c1 = non_locality_elems(node).select { |c| !c.text? || /\S/.match(c) }
+        c2 = node.xpath(ns("./locality | ./localityStack"))
+        [c1, c2]
+      end
+
+      def biblio_anchor_linkend_std(node, bib, linkend)
+        c1, c2 = linkend_content(node)
+        node["style"] == "no-biblio-tag" or tag = bib[:ord]
+        if !c1.empty?
+          c2.each(&:remove)
+          [c1.map(&:to_xml).join, tag].compact.join(" ")
+        elsif node.at(ns("./location"))
+          linkend
+        elsif node["citeas"] == bib[:ord] then node["citeas"]
+        else [linkend, tag].compact.join(" ")
+        end
+      end
+
       def biblio_anchor_linkend_nonstd(node, bib)
+        c1, c2 = linkend_content(node)
         node["style"] == "no-biblio-tag" or tag = node["citeas"]
-        if !node.children.empty?
-          "#{to_xml(node.children)} #{tag}".strip
+        if !c1.empty?
+          c2.each(&:remove)
+          "#{c1.map(&:to_xml).join} #{tag}".strip
+        elsif node.at(ns("./location"))
+          tag
         elsif node["style"] == "title" && bib[:title]
           "#{bib[:title]} #{tag}".strip
         elsif bib[:author] # default, also if node["style"] == "title"

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -87,32 +87,43 @@ module IsoDoc
         docxml.xpath(ns("//ol/li")).each { |f| ol_label(f) }
       end
 
-      def ol_numbering(docxml)
-        p = "//clause | //annex | //foreword | //acknowledgements | " \
+      def ol_numbering_containers
+        "//clause | //annex | //foreword | //acknowledgements | " \
             "//introduction | //preface/abstract | //appendix | //terms | " \
             "//term | //definitions | //references | //colophon"
-        docxml.xpath(ns(p)).each do |c|
+      end
+
+      def ol_numbering(docxml)
+        docxml.xpath(ns(ol_numbering_containers)).each do |c|
+          i = -1
           (c.xpath(ns(".//ol")) -
           c.xpath(ns("./clause//ol | ./appendix//ol | ./term//ol | " \
                      "./terms//ol | ./definitions//ol | " \
-                     "/references//ol | ./colophon//ol")))
-            .each_with_index do |o, i|
+                     "/references//ol | ./colophon//ol"))).each do |o|
+            (o.ancestors("ol").size + o.ancestors("ul").size).zero? and
+              i += 1 # ol root list
             ol_numbering1(o, i)
           end
         end
       end
 
       def ol_numbering1(elem, idx)
-        elem["type"] = ol_depth_rotate(elem, idx).to_s
+        ancestors = elem.ancestors.map(&:name).reverse
+        ul_loc = ancestors.index("ul")
+        ol_loc = ancestors.index("ol")
+        # is this a ul//ol list? if so, ignore idx of list in labelling
+        ul_root = ul_loc && (!ol_loc || ul_loc < ol_loc)
+        elem["type"] = ol_depth_rotate(elem, ul_root ? 0 : idx).to_s
       end
 
       # overrides IsoDoc:: XrefGen::OlTypeProvider: we trigger
       # @xrefs.list_anchor_names after this is called, with elem["type"] set
+      # use the order of the ol in the clause to rotate the labelling
       def ol_depth_rotate(node, idx)
-        depth = node.ancestors("ol").size + idx
+        depth = node.ancestors("ol").size + node.ancestors("ul").size + idx
         type = :alphabet
-        type = :arabic if [2, 5, 8].include? depth
-        type = :roman if [3, 6, 9].include? depth
+        type = :arabic if [1, 4, 7].include? depth
+        type = :roman if [2, 5, 8].include? depth
         type
       end
 
@@ -125,24 +136,14 @@ module IsoDoc
         end
       end
 
-      def middle_title(docxml)
-        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>"
-        ret
-      end
-
-      def middle_title_insert(docxml)
-        s = docxml.at(ns("//sections")) or return
-        s.children.first
+      def middle_title_template
+        <<~OUTPUT
+          <p class='zzSTDTitle1'>{{ full_doctitle -}}
+          {% if amd or corr %}<br/>{% endif -%}
+          {% if amd %}Amendment {{ amd }}{% endif -%}
+          {% if amd and corr %}&#x20;{% endif -%}
+          {% if corr %}Corrigenda {{ corr }}{% endif %}</p>
+        OUTPUT
       end
 
       def preface_rearrange(doc)

data/lib/metanorma/ieee/cleanup.rb

@@ -95,14 +95,13 @@ module Metanorma
       end
 
       def boilerplate_isodoc(xmldoc)
-        x = xmldoc.dup
-        x.root.add_namespace(nil, xml_namespace)
+        x = dup_with_namespace(xmldoc.root)
         xml = Nokogiri::XML(x.to_xml)
-        i = isodoc(@lang, @script, @locale)
-        i.bibdata_i18n(xml.at("//xmlns:bibdata"))
-        i.localdir = @localdir
-        i.info(xml, nil)
-        i
+        @isodoc ||= isodoc(@lang, @script, @locale)
+        @isodoc.bibdata_i18n(xml.at("//xmlns:bibdata"))
+        @isodoc.localdir = @localdir
+        @isodoc.info(xml, nil)
+        @isodoc
       end
 
       def text_from_paras(node)
@@ -113,10 +112,18 @@ module Metanorma
       def bibdata_cleanup(xmldoc)
         super
         draft_id(xmldoc)
+        main_title(xmldoc)
         prefixed_title(xmldoc)
         provenance_title(xmldoc)
       end
 
+      def main_title(xmldoc)
+        t = xmldoc.at("//bibdata/title[@type = 'main']") and
+          t["type"] = "title-main"
+        t = xmldoc.at("//bibdata/title[@type = 'title-full']") and
+          t["type"] = "main"
+      end
+
       def prefixed_title(xmldoc)
         t, stage, trial = prefixed_title_prep(xmldoc)
         %w(main title-abbrev).reverse_each do |type|

data/lib/metanorma/ieee/cleanup_ref.rb

@@ -40,15 +40,15 @@ module Metanorma
 
       def designator_or_name(bib)
         id = designator_docid(bib)
-        ret = case bib["type"]
-              when "standard", "techreport" then id
-              else
-                bib1 = bib.dup
-                bib1.add_namespace(nil, xml_namespace)
-                n = @i.creatornames(bib1)
-                n.nil? && bib["type"].nil? and n = id
-                n
-              end
+        if %w(standard techreport).include?(bib["type"]) && id != "ZZZZ" &&
+            id != bib.at("./docidentifier[@type='metanorma']")&.text
+          ret = id
+        else
+          bib1 = dup_with_namespace(bib)
+          n = @i.creatornames(bib1)
+          n.nil? && bib["type"].nil? and n = id
+          ret = n
+        end
         [ret, id]
       end
 
@@ -121,6 +121,10 @@ module Metanorma
                        "@type = 'metanorma-ordinal']")
         if /^\[?\d+\]?$/.match?(docid&.text)
           docid.children = "[B#{idx}]"
+          # fix metanorma to metanorma-ordinal if designation supplied
+          if bib.at("./docidentifier[@type = 'title']")
+            docid["type"] = "metanorma-ordinal"
+          end
         elsif docid = bib.at("./docidentifier") || bib.at("./title[last()]") ||
             bib.at("./formattedref")
           docid.next =
@@ -130,7 +134,7 @@ module Metanorma
 
       def select_docid(ref, type = nil)
         ret = super
-        if %w(standard techreport).include?(ref["type"]) then ret
+        if %w(standard).include?(ref["type"]) then ret
         else
           ref.at("./docidentifier[@type = 'metanorma-ordinal']") || ret
         end
@@ -143,6 +147,10 @@ module Metanorma
 
       def bibitem_cleanup(xmldoc)
         super
+        supply_withdrawn_notes(xmldoc)
+      end
+
+      def supply_withdrawn_notes(xmldoc)
         f = File.join(File.dirname(__FILE__), "ieee-footnotes.yaml")
         @provenance_notes = YAML.safe_load(File.read(f))
         withdrawn_note(xmldoc, @provenance_notes)
@@ -157,6 +165,10 @@ module Metanorma
         bib.xpath("./contributor[role/@type = 'publisher']/organization/name")
           .map(&:text)
       end
+
+      def empty_docid_to_title?(bibitem)
+          bibitem["type"] == "standard"
+      end
     end
   end
 end

data/lib/metanorma/ieee/cleanup_ref_fn.rb

@@ -7,11 +7,11 @@ module Metanorma
 
       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'])]")
-        
+        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
@@ -37,7 +37,8 @@ module Metanorma
 
       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-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)

data/lib/metanorma/ieee/front.rb

@@ -194,24 +194,12 @@ module Metanorma
         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
+      def title_other(node, xml)
+        t = node.attr("title-full") and
+          add_title_xml(xml, t, @lang, "title-full")
+        t = node.attr("title-abbrev") and
+          add_title_xml(xml, t, @lang, "title-abbrev")
       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.2 -->
+<!-- VERSION v2.1.3 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -455,14 +455,7 @@ normative or informative references, some split references into sections organiz
           </ref>
         </zeroOrMore>
         <zeroOrMore>
-          <ref name="doc_bibitem">
-            <a:documentation>Bibliographic item cited in the document</a:documentation>
-          </ref>
-          <zeroOrMore>
-            <ref name="note">
-              <a:documentation>Annotation of the bibliographic item</a:documentation>
-            </ref>
-          </zeroOrMore>
+          <ref name="ReferenceEntry"/>
         </zeroOrMore>
         <zeroOrMore>
           <ref name="references">
@@ -604,18 +597,21 @@ gives an explicit page orientation</a:documentation>
         </element>
       </optional>
     </define>
-  </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.
+    <define name="FnAttributes">
+      <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.
 This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
-        <data type="boolean"/>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="reference">
+        <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
       </attribute>
-    </optional>
-  </define>
+    </define>
+  </include>
+  <!-- end overrides -->
   <define name="TdAttributes" combine="interleave">
     <ref name="RequiredId"/>
     <optional>
@@ -853,6 +849,17 @@ titlecase, or lowercase</a:documentation>
       <value>informative</value>
     </choice>
   </define>
+  <define name="ReferenceEntry">
+    <a:documentation>Entry in bibliography</a:documentation>
+    <ref name="doc_bibitem">
+      <a:documentation>Bibliographic item cited in the document</a:documentation>
+    </ref>
+    <zeroOrMore>
+      <ref name="note">
+        <a:documentation>Annotation of the bibliographic item</a:documentation>
+      </ref>
+    </zeroOrMore>
+  </define>
   <define name="doc_bibitem">
     <a:documentation>Standardisation document representation of bibliographic entry</a:documentation>
     <element name="bibitem">

data/lib/metanorma/ieee/version.rb

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

data/lib/relaton/render/config.yml

@@ -3,13 +3,20 @@ nametemplate:
   two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %} , {{ labels['and'] }} {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{initials[1] | join: '. '}}. {{surname[1] }}{% endif %}"
   more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{initials[1] | join: '. '}}. {{surname[1] }}{% endif %} , {{ labels['and'] }} {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{initials[2] | join: '. '}}. {{surname[2] }}{% endif %}"
   etal: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{initials[1] | join: '. '}}. {{surname[1] }}{% endif %} , {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{initials[2] | join: '. '}}. {{surname[2] }}{% endif %} <em>et al.</em>"
-  etal_count: 10
-  etal_render: 7
+  etal_count: 6
+  etal_display: 3
+authorcitetemplate:
+  one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} {% endif %}"
+  two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }}{% endif %} , {{ labels['and'] }} {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1] }}{% endif %}"
+  more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }}{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1] }}{% endif %} , {{ labels['and'] }} {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{surname[2] }}{% endif %}"
+  etal: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }}{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{surname[1] }}{% endif %} , {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{surname[2] }}{% endif %} <em>et al.</em>"
+  etal_count: 3
+  etal_display: 1
 extenttemplate:
   misc: "{{ volume }}, {{issue}}, {{ page }}, {{ duration }}"
 template:
   # skip authoritative_identifier, it is inserted in front of formattedref within metanorma
-  standard: "{% if home_standard %}{{ title }}.{% else %}{{ creatornames }}, “{{ title }},” {{ extent }},  {{ labels['version'] }}_{{ edition_raw }}, {{date}}, {{labels['updated'] | capitalize }}_{{date_updated}}, {{status }}, {{ authorizer }}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} .{% endif %}"
+  standard: "{{ title }}{% if home_standard %}{%else%}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %}{% endif %}."
   article: "{{creatornames}}, “{{title}},” <em>{{ series }}</em>, {{ extent }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
   book: "{{creatornames}}, <em>{{title}}</em>, {{ edition }}, {{place}}: {{publisher}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
   techreport: book

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-01 00:00:00.000000000 Z
+date: 2025-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc