metanorma-ieee 1.4.4 → 1.4.6

data/lib/metanorma/ieee/basicdoc.rng

@@ -267,6 +267,10 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <value>justified</value>
     </choice>
   </define>
+  <define name="IdRefType">
+    <a:documentation>Type of cross-references to elements. In BasicDoc, these always point to id { xsd:ID } </a:documentation>
+    <data type="IDREF"/>
+  </define>
   <define name="RequiredId">
     <a:documentation>Mandatory anchor of element, to be used for cross-references within the document</a:documentation>
     <attribute name="id">
@@ -409,13 +413,13 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <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"/>
+        <ref name="IdRefType"/>
       </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"/>
+        <ref name="IdRefType"/>
       </attribute>
     </optional>
   </define>
@@ -1504,7 +1508,7 @@ Restricted recursively to contain only other such inline elements with no identi
         <attribute name="to">
           <a:documentation>A reference to an anchor element (typically a bookmark), 
 to indicate that the index range covers a range of locations between the current index element and the `to` anchor</a:documentation>
-          <data type="IDREF"/>
+          <ref name="IdRefType"/>
         </attribute>
       </optional>
       <ref name="index-primary">
@@ -1662,7 +1666,7 @@ which can be bookmarks as well as block or section references</a:documentation>
   <define name="XrefAttributes">
     <attribute name="target">
       <a:documentation>The identifier of a section, block or inlined element being referenced</a:documentation>
-      <data type="IDREF"/>
+      <ref name="IdRefType"/>
     </attribute>
     <optional>
       <attribute name="type">
@@ -1723,7 +1727,7 @@ The target of a footnote is the location it is embedded in within the text</a:do
       <attribute name="target">
         <a:documentation>The target of the callout is understood to be the location of the callout within the source code; 
 the extent of the target is not expressed overtly</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <text>
         <a:documentation>The label of the callout, used to identify its target within the source code</a:documentation>

data/lib/metanorma/ieee/cleanup.rb

@@ -30,7 +30,7 @@ module Metanorma
       end
 
       def initial_note(xml)
-        n = xml.at("//boilerplate//note[@id = 'boilerplate_front']")
+        n = xml.at("//boilerplate//note[@anchor = 'boilerplate_front']")
         s = xml.at("//sections")
         (n && s) or return
         s.children.empty? and s << " "
@@ -39,7 +39,7 @@ module Metanorma
 
       def word_usage(xml)
         @document_scheme == "ieee-sa-2021" or return
-        n = xml.at("//boilerplate//clause[@id = 'boilerplate_word_usage']")
+        n = xml.at("//boilerplate//clause[@anchor = 'boilerplate_word_usage']")
           &.remove
         s = xml.at("//clause[@type = 'overview']")
         (n && s) or return
@@ -155,13 +155,13 @@ module Metanorma
           populate_participants(xml, k.to_s, v)
         end
         p = xml.at(".//p[@type = 'emeritus_sign']")
-        ul = xml.at("//clause[@id = 'boilerplate-participants-sb']//ul")
+        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[@id = '#{target}']/membership") or return
+        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

data/lib/metanorma/ieee/cleanup_ref.rb

@@ -31,23 +31,25 @@ module Metanorma
 
       # Alphabetic by rendering: author surname or designation, followed by title
       def sort_biblio_key(bib)
-        name = designator_or_name(bib)
+        name, docid = designator_or_name(bib)
         title = bib.at("./title[@type = 'main']")&.text ||
           bib.at("./title")&.text || bib.at("./formattedref")&.text
         title.gsub!(/[[:punct:]]/, "")
-        @c.decode("#{name} #{title}").strip.downcase
+        @c.decode("#{name} #{title} #{docid}").strip.downcase
       end
 
       def designator_or_name(bib)
-        case bib["type"]
-        when "standard", "techreport" then designator_docid(bib)
-        else
-          bib1 = bib.dup
-          bib1.add_namespace(nil, self.class::XML_NAMESPACE)
-          n = @i.creatornames(bib1)
-          n.nil? && bib["type"].nil? and n = designator_docid(bib)
-          n
-        end
+        id = designator_docid(bib)
+        ret = case bib["type"]
+              when "standard", "techreport" then id
+              else
+                bib1 = bib.dup
+                bib1.add_namespace(nil, self.class::XML_NAMESPACE)
+                n = @i.creatornames(bib1)
+                n.nil? && bib["type"].nil? and n = id
+                n
+              end
+        [ret, id]
       end
 
       def designator_docid(bib)
@@ -66,7 +68,7 @@ module Metanorma
       def normref_no_ordinals(xmldoc)
         xmldoc.xpath("//references[@normative = 'true']/bibitem/" \
                     "docidentifier[@type = 'metanorma']").each do |d|
-                      /^\[?\d+\]?$/.match?(d.text) and d.remove
+          /^\[?\d+\]?$/.match?(d.text) and d.remove
         end
       end
 
@@ -89,7 +91,7 @@ module Metanorma
         ieee = xmldoc.xpath("//references/bibitem")
           .each_with_object({}) do |b, m|
           bib_pubs(b).include?(IEEE) and
-            m[b["id"]] = b.at("./docidentifier[@scope = 'trademark']")&.text
+            m[b["anchor"]] = b.at("./docidentifier[@scope = 'trademark']")&.text
         end
         trademark_ieee_erefs1(xmldoc, "//preface//eref", ieee)
         trademark_ieee_erefs1(xmldoc, "//sections//eref | //annex//eref", ieee)
@@ -221,7 +223,7 @@ module Metanorma
         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)
+            !has_itu_t && !itu_t || (has_itu_t && itu_t)
         end
         insert_availability_note(ret, note)
       end

data/lib/metanorma/ieee/converter.rb

@@ -33,13 +33,13 @@ module Metanorma
         end
       end
 
-      def clause_parse(attrs, xml, node)
-        case node.title
-        when "Purpose" then attrs[:type] = "purpose"
-        when "Overview" then attrs[:type] = "overview"
-        when "Scope" then attrs[:type] = "scope"
-        when "Word Usage" then attrs[:type] = "word-usage"
-        when "Participants" then attrs[:type] = "participants"
+      def clause_attrs_preprocess(attrs, node)
+        case node.title.downcase
+        when "purpose" then attrs[:type] = "purpose"
+        when "overview" then attrs[:type] = "overview"
+        when "scope" then attrs[:type] = "scope"
+        when "word usage" then attrs[:type] = "word-usage"
+        when "participants" then attrs[:type] = "participants"
         end
         super
       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.0.3 -->
+<!-- VERSION v2.0.5 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -36,6 +36,12 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="IdRefType">
+      <a:documentation>Cross-references are not normalised to xsd:IDREF in Semantic XML: that is deferred to Presentation XML.
+All IdRefType instances point not to `@id` in Semantic XML, which is the Content GUID for an element,
+but to `@anchor`, the user-supplied cross-reference</a:documentation>
+      <text/>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -238,7 +244,7 @@
           <a:documentation>Notes specific to this block</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="BlockSource">
         <a:documentation>A source for the table</a:documentation>
       </ref>
     </define>
@@ -262,10 +268,112 @@ and is intended to be referenced by a callout within the source code</a:document
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
-      <ref name="TermSource">
+      <ref name="BlockSource">
+        <a:documentation>A source for the block</a:documentation>
+      </ref>
+    </define>
+    <define name="FigureBody">
+      <optional>
+        <ref name="tname">
+          <a:documentation>The caption of the block</a:documentation>
+        </ref>
+      </optional>
+      <choice>
+        <a:documentation>Content of the figure</a:documentation>
+        <ref name="image"/>
+        <ref name="video"/>
+        <ref name="audio"/>
+        <ref name="pre"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="figure"/>
+        </zeroOrMore>
+      </choice>
+      <zeroOrMore>
+        <ref name="fn">
+          <a:documentation>Footnotes specific to the figure</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <optional>
+        <ref name="dl">
+          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="BlockSource">
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="FigureNoIdBody">
+      <optional>
+        <ref name="source">
+          <a:documentation>A URI or other reference intended to link to an externally hosted image (or equivalent)</a:documentation>
+        </ref>
+      </optional>
+      <optional>
+        <ref name="tname">
+          <a:documentation>The caption of the block</a:documentation>
+        </ref>
+      </optional>
+      <choice>
+        <a:documentation>Content of the figure</a:documentation>
+        <ref name="image-no-id"/>
+        <ref name="video-no-id"/>
+        <ref name="audio-no-id"/>
+        <ref name="pre-no-id"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote-no-id"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="figure-no-id"/>
+        </zeroOrMore>
+      </choice>
+      <zeroOrMore>
+        <ref name="fn">
+          <a:documentation>Footnotes specific to the figure</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <optional>
+        <ref name="dl-no-id">
+          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note-no-id">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>A source for the block</a:documentation>
+      </ref>
+    </define>
+    <define name="source">
+      <element name="source">
+        <attribute name="status">
+          <a:documentation>The status of the term as it is used in this document, relative to its definition in the original document</a:documentation>
+          <ref name="SourceStatusType"/>
+        </attribute>
+        <attribute name="type">
+          <a:documentation>The type of the managed term in the present context</a:documentation>
+          <ref name="SourceTypeType"/>
+        </attribute>
+        <ref name="origin">
+          <a:documentation>The original document and location where the term definition has been obtained from</a:documentation>
+        </ref>
+        <optional>
+          <ref name="modification">
+            <a:documentation>Any changes that the definition of the term has undergone relative to the original document,
+in order to be applicable in this standardisation document</a:documentation>
+          </ref>
+        </optional>
+      </element>
+    </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>
@@ -687,6 +795,20 @@ titlecase, or lowercase</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="RequiredId" combine="interleave">
+    <optional>
+      <attribute name="anchor">
+        <a:documentation>User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
+      </attribute>
+    </optional>
+  </define>
+  <define name="OptionalId" combine="interleave">
+    <optional>
+      <attribute name="anchor">
+        <a:documentation> User-supplied anchor of element; replaced by content-based id, with all references to the anchor updated accordingly</a:documentation>
+      </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>
     <choice>
@@ -1081,7 +1203,7 @@ That concept may be defined as a term within the current document, or it may be
     <element name="label">
       <!-- Identifier of form input element that this element is a label of -->
       <attribute name="for">
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <zeroOrMore>
         <ref name="PureTextElement"/>
@@ -1328,6 +1450,7 @@ numbers</a:documentation>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
+          <ref name="executivesummary"/>
         </choice>
       </oneOrMore>
     </element>
@@ -1351,6 +1474,11 @@ numbers</a:documentation>
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="executivesummary">
+    <element name="executivesummary">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="indexsect">
     <element name="indexsect">
       <ref name="Content-Section"/>
@@ -1576,6 +1704,15 @@ used in document amendments</a:documentation>
   <define name="annex">
     <element name="annex">
       <ref name="Annex-Section"/>
+      <zeroOrMore>
+        <ref name="annex-appendix"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="annex-appendix">
+    <a:documentation>Appendix, distinct subclause type for annexes (annex to annex, rather than subclause to annex)</a:documentation>
+    <element name="appendix">
+      <ref name="Clause-Section"/>
     </element>
   </define>
   <define name="terms">
@@ -2106,7 +2243,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="termsource">
     <a:documentation>The bibliographic source where a term is defined in the sense applicable in this standardisation document</a:documentation>
-    <element name="termsource">
+    <element name="source">
       <attribute name="status">
         <a:documentation>The status of the term as it is used in this document, relative to its definition in the original document</a:documentation>
         <ref name="SourceStatusType"/>
@@ -2488,6 +2625,11 @@ Normative References contents contain normative references, but as a clause in t
       <ref name="termsource"/>
     </zeroOrMore>
   </define>
+  <define name="BlockSource">
+    <zeroOrMore>
+      <ref name="source"/>
+    </zeroOrMore>
+  </define>
   <start>
     <ref name="standard-document"/>
   </start>

data/lib/metanorma/ieee/term_lookup_cleanup.rb

@@ -4,8 +4,6 @@ module Metanorma
       def remove_missing_ref_term(node, _target, type)
         type == "symbol" and return super
         node.at("../xrefrender")&.remove
-        #node.replace("<preferred><expression><name>#{node.children.to_xml}"\
-        #             "</name></expression></preferred>")
         node.replace("<refterm>#{node.children.to_xml}</refterm>")
       end
     end

data/lib/metanorma/ieee/validate.rb

@@ -77,7 +77,7 @@ module Metanorma
         root.xpath("//references[@normative = 'true']/bibitem").each do |b|
           b.at(".//date") or
             @log.add("Style", b,
-                     "Normative reference #{b&.at('./@id')&.text} is not dated.")
+                     "Normative reference #{b.at('./@anchor')&.text} is not dated.")
         end
       end
 

data/lib/metanorma/ieee/validate_section.rb

@@ -99,12 +99,8 @@ module Metanorma
       # Style manual 13.1
       def onlychild_clause_validate(root)
         root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
-          next unless c.xpath("../clause").size == 1
-
-          title = c.at("./title")
-          location = c["id"] || "#{c.text[0..60]}..."
-          location += ":#{title.text}" if c["id"] && !title.nil?
-          @log.add("Style", nil, "#{location}: subclause is only child")
+          c.xpath("../clause").size == 1 or next
+          @log.add("Style", c, "subclause is only child")
         end
       end
 

data/lib/metanorma/ieee/validate_style.rb

@@ -2,7 +2,7 @@ module Metanorma
   module Ieee
     class Converter < Standoc::Converter
       ASSETS_TO_STYLE =
-        "//termsource | //formula | //termnote | " \
+        "//term//source | //formula | //termnote | " \
         "//p[not(ancestor::boilerplate)] | //li[not(p)] | //dt | " \
         "//dd[not(p)] | //td[not(p)][not(ancestor::boilerplate)] | " \
         "//th[not(p)][not(ancestor::boilerplate)] | //example".freeze

data/lib/metanorma/ieee/version.rb

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

metadata

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