metanorma-ieee 1.4.1 → 1.4.3

data/lib/isodoc/ieee/presentation_ref.rb

@@ -45,18 +45,25 @@ module IsoDoc
         super
       end
 
-      KEEP_BIBRENDER_XPATH =
-        "./docidentifier | ./uri | ./note | ./title | ./biblio-tag".freeze
-
       def bibrender_relaton(xml, renderings)
-        f = renderings[xml["id"]][:formattedref]
-        fn = availability_note(xml)
-        f &&= "<formattedref>#{f}#{fn}</formattedref>"
-        xml.children = "#{f}#{xml.xpath(ns(KEEP_BIBRENDER_XPATH)).to_xml}"
+        bibrender_relaton1(xml, renderings)
         author_date(xml, renderings)
         @author[xml["id"]] = renderings[xml["id"]][:author]
       end
 
+      def bibrender_relaton1(xml, renderings)
+        f = renderings[xml["id"]][:formattedref] or return
+        fn = availability_note(xml)
+        f = "<formattedref>#{f}#{fn}</formattedref>"
+        if x = xml.at(ns("./formattedref"))
+          x.replace(f)
+        elsif xml.children.empty?
+          xml << f
+        else
+          xml.children.first.previous = f
+        end
+      end
+
       def author_date(xml, renderings)
         author_date?(xml) or return
         cit = renderings[xml["id"]][:citation]

data/lib/isodoc/ieee/word_convert.rb

@@ -86,8 +86,8 @@ module IsoDoc
         section_break(body, continuous: true)
         body.div class: "WordSectionMain" do |div3|
           content(div3, docxml, ns(self.class::MAIN_ELEMENTS))
-          footnotes div3
-          comments div3
+          footnotes docxml, div3
+          comments docxml, div3
         end
       end
 
@@ -202,29 +202,35 @@ module IsoDoc
         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
+      # "Figure 1—" remove each of these: strip elements in caption associated
+      # with autonumbering -- # but not in footnotes. The autonumber captions
+      # are provided by Word styles instead
+      def strip_caption_semx(name)
+        name.xpath(".//xmlns:semx[@element = 'autonum']/"\
+                   "preceding-sibling::*[normalize-space() = '']").each do |s|
+                     s.ancestors("fn").empty? and s.remove
+                   end
         name.xpath(ns(".//span[@class = 'fmt-element-name']  | "\
                       ".//span[@class = 'fmt-caption-delim'] | "\
-                      ".//semx[@element = 'autonum']")).each(&:remove)
+                      ".//semx[@element = 'autonum']")).each do |s|
+                        s.ancestors("fn").empty? and s.remove
+                      end
+      end
+
+      def figure_name_parse(_node, div, name)
+        name.nil? and return
+        strip_caption_semx(name)
         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)
+        strip_caption_semx(name)
         super
       end
 
       include BaseConvert
       include Init
-    end
-  end
+end
+end
 end

data/lib/isodoc/ieee/word_wp_convert.rb

@@ -45,8 +45,8 @@ module IsoDoc
         section_break(body)
         body.div class: "WordSection4" do |div3|
           backcover div3
-          footnotes div3
-          comments div3
+          footnotes docxml, div3
+          comments docxml, div3
         end
       end
 

data/lib/metanorma/ieee/basicdoc.rng

@@ -382,33 +382,7 @@ in a document (e.g. sourcecode annotations)</a:documentation>
     <a:documentation>Block intended to capture reviewer comments about some text in the document</a:documentation>
     <element name="review">
       <ref name="RequiredId"/>
-      <attribute name="reviewer">
-        <a:documentation>The party who has offered the comment</a:documentation>
-      </attribute>
-      <optional>
-        <attribute name="type">
-          <a:documentation>The type of reviewer comment</a:documentation>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="date">
-          <a:documentation>The date when the comment was made</a:documentation>
-          <data type="dateTime"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="from">
-          <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
-If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="to">
-          <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
+      <ref name="ReviewAttributes"/>
       <oneOrMore>
         <ref name="paragraph">
           <a:documentation>Reviewer comments content</a:documentation>
@@ -416,6 +390,35 @@ If not provided, the comment applies in the vicinity of the place it has been in
       </oneOrMore>
     </element>
   </define>
+  <define name="ReviewAttributes">
+    <attribute name="reviewer">
+      <a:documentation>The party who has offered the comment</a:documentation>
+    </attribute>
+    <optional>
+      <attribute name="type">
+        <a:documentation>The type of reviewer comment</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="date">
+        <a:documentation>The date when the comment was made</a:documentation>
+        <data type="dateTime"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="from">
+        <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
+If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="to">
+        <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes">
     <optional>
       <attribute name="unnumbered">
@@ -599,17 +602,9 @@ It is included for convenience, in case processing the citation to extract the a
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -628,17 +623,9 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -651,6 +638,20 @@ and is intended to be referenced by a callout within the source code</a:document
       </ref>
     </zeroOrMore>
   </define>
+  <define name="sourcecodebody">
+    <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+    <element name="body">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="callout">
+            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+          </ref>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="pre">
     <a:documentation>Pre-formatted block. Wrapper for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. 
 They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some 
@@ -859,6 +860,7 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
   <define name="tr">
     <a:documentation>Sequence of cells to be displayed as a row in a table</a:documentation>
     <element name="tr">
+      <ref name="TrAttributes"/>
       <oneOrMore>
         <choice>
           <ref name="td">
@@ -871,6 +873,9 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="TrAttributes">
+    <empty/>
+  </define>
   <define name="tr-no-id">
     <a:documentation>Sequence of cells to be displayed as a row in a table: optional ID attributes recursively (for use in Relaton, metadata)</a:documentation>
     <element name="tr">
@@ -1672,18 +1677,25 @@ which can be bookmarks as well as block or section references</a:documentation>
     </optional>
   </define>
   <define name="XrefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="ErefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement">
+            <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="fn">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.

data/lib/metanorma/ieee/converter.rb

@@ -20,8 +20,9 @@ module Metanorma
         @hierarchical_assets = node.attr("hierarchical-object-numbering")
       end
 
-      PREFACE_CLAUSE_NAMES = %w(abstract foreword introduction
-                                acknowledgements participants).freeze
+      PREFACE_CLAUSE_NAMES =
+        %w(abstract foreword introduction acknowledgements participants
+           metanorma-extension misc-container).freeze
 
       def sectiontype_streamline(ret)
         case ret

data/lib/metanorma/ieee/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v2.0.0 -->
+<!-- VERSION v2.0.2 -->
 <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">
@@ -33,6 +33,15 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="fn" combine="interleave">
+      <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"/>
+        </attribute>
+      </optional>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -245,23 +254,9 @@
           <a:documentation>The caption of the block</a:documentation>
         </ref>
       </optional>
-      <oneOrMore>
-        <choice>
-          <text>
-            <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-          </text>
-          <ref name="callout">
-            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-          </ref>
-          <ref name="xref">
-            <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
-          </ref>
-          <ref name="eref">
-            <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
-          </ref>
-        </choice>
-      </oneOrMore>
+      <ref name="sourcecodebody">
+        <a:documentation>The sourcecode content</a:documentation>
+      </ref>
       <zeroOrMore>
         <ref name="annotation">
           <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -277,6 +272,26 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="sourcecodebody">
+      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+      <element name="body">
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout">
+              <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+            </ref>
+            <ref name="xref">
+              <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
+            </ref>
+            <ref name="eref">
+              <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
+            </ref>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="sections">
       <element name="sections">
         <oneOrMore>
@@ -408,6 +423,21 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </choice>
     </define>
+    <define name="TdAttributes" combine="interleave">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
+    <define name="ThAttributes" combine="interleave">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
+    <define name="TrAttributes">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
     <define name="table-note">
       <element name="note">
         <ref name="OptionalId"/>
@@ -1257,6 +1287,11 @@ numbers</a:documentation>
           <a:documentation>Colophon or postface material</a:documentation>
         </ref>
       </optional>
+      <optional>
+        <ref name="review-container">
+          <a:documentation>Annotations to the document</a:documentation>
+        </ref>
+      </optional>
     </element>
   </define>
   <define name="misccontainer">
@@ -1267,6 +1302,13 @@ numbers</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="review-container">
+    <element name="review-container">
+      <oneOrMore>
+        <ref name="review"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ieee
-    VERSION = "1.4.1".freeze
+    VERSION = "1.4.3".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc