metanorma-iso 3.0.6 → 3.0.8

data/lib/metanorma/iso/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.4 -->
+<!-- VERSION v2.0.6 -->
 
   <!--
     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,32 @@ 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>
+    <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>
+      <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>
+    <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>
     <choice>
@@ -832,6 +966,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>
@@ -1081,7 +1216,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"/>
@@ -2121,7 +2256,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"/>
@@ -2503,6 +2638,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/iso/validate.rb

@@ -29,36 +29,61 @@ module Metanorma
       # does not deal with preceding text marked up
       def see_xrefs_validate(root)
         @lang == "en" or return
+        anchors = extract_anchor_norm(root)
         root.xpath("//xref").each do |t|
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? &&
-            /\b(see| refer to)\p{Zs}*\Z/mi.match(preceding)
-
-          (target = root.at("//*[@id = '#{t['target']}']")) || next
-          target.at("./ancestor-or-self::*[@obligation = 'normative']") &&
-            !target.at("./ancestor::sections") and
+          !preceding.nil? &&
+            /\b(see| refer to)\p{Zs}*\Z/mi.match(preceding) or next
+          anchors[t["target"]] and
             @log.add("Style", t,
                      "'see #{t['target']}' is pointing to a normative section")
         end
       end
 
+      def extract_anchor_norm(root)
+        nodes = root.xpath("//annex[@obligation = 'normative'] | " \
+          "//references[@obligation = 'normative']")
+        ret = nodes.each_with_object({}) do |n, m|
+          n["anchor"] and m[n["anchor"]] = true
+        end
+        nodes.each do |n|
+          n.xpath(".//*[@anchor]").each { |n1| ret[n1["anchor"]] = true }
+        end
+        ret
+      end
+
       # ISO/IEC DIR 2, 15.5.3
       def see_erefs_validate(root)
         @lang == "en" or return
+        bibitemids = extract_bibitem_anchors(root)
         root.xpath("//eref").each do |t|
           prec = t.at("./preceding-sibling::text()[last()]")
           !prec.nil? && /\b(see|refer to)\p{Zs}*\Z/mi.match(prec) or next
-          unless target = root.at("//*[@id = '#{t['bibitemid']}']")
+          unless target = bibitemids[t["bibitemid"]]
+            #unless target = root.at("//bibitem[@anchor = '#{t['bibitemid']}']")
             @log.add("Bibliography", t,
                      "'#{t} is not pointing to a real reference")
             next
           end
-          target.at("./ancestor::references[@normative = 'true']") and
+          #target.at("./ancestor::references[@normative = 'true']") and
+          target[:norm] and
             @log.add("Style", t,
                      "'see #{t}' is pointing to a normative reference")
         end
       end
 
+      def extract_bibitem_anchors(root)
+        ret = root.xpath("//references[@normative = 'true']//bibitem")
+          .each_with_object({}) do |b, m|
+          m[b["anchor"]] = { bib: b, norm: true }
+        end
+        root.xpath("//references[not(@normative = 'true')]//bibitem")
+          .each do |b|
+          ret[b["anchor"]] = { bib: b, norm: false }
+        end
+        ret
+      end
+
       # ISO/IEC DIR 2, 10.4
       def locality_erefs_validate(root)
         root.xpath("//eref[descendant::locality]").each do |t|
@@ -80,8 +105,9 @@ module Metanorma
         termids = xmldoc
           .xpath("//sections/terms | //sections/clause[.//terms] | " \
                  "//annex[.//terms]").each_with_object({}) do |t, m|
+          t.xpath(".//*/@anchor").each { |a| m[a.text] = true }
           t.xpath(".//*/@id").each { |a| m[a.text] = true }
-          t.name == "terms" and m[t["id"]] = true
+          t.name == "terms" and m[t["anchor"] || t["id"]] = true
         end
         xmldoc.xpath(".//xref").each do |x|
           term_xrefs_validate1(x, termids)
@@ -114,8 +140,8 @@ module Metanorma
           .join(" | ")
         (xmldoc.xpath(xpath) - xmldoc.xpath(exc)).each do |x|
           x["unnumbered"] == "true" and next
-          @doc_xrefs[x["id"]] or
-            @log.add("Style", x, "#{name} #{x['id']} has not been " \
+          @doc_xrefs[x["anchor"]] or
+            @log.add("Style", x, "#{name} #{x['anchor']} has not been " \
                                  "cross-referenced within document",
                      severity: xpath == "//formula" ? 2 : 1)
         end
@@ -186,7 +212,7 @@ module Metanorma
         xmldoc.xpath("//bibitem[date/on = '–']").each do |b|
           b.at("./note[@type = 'Unpublished-Status']") or
             @log.add("Style", b,
-                     "Reference #{b&.at('./@id')&.text} does not have an " \
+                     "Reference does not have an " \
                      "associated footnote indicating unpublished status")
         end
       end

data/lib/metanorma/iso/validate_section.rb

@@ -118,17 +118,17 @@ module Metanorma
         if elem.nil? || elem.name != "clause"
           @log.add("Style", elem, "Document must contain at least one clause")
         end
-        elem&.at("./self::clause") ||
+        elem&.at("./self::clause") or
           @log.add("Style", elem, "Document must contain clause after " \
                                   "Terms and Definitions")
-        elem&.at("./self::clause[@type = 'scope']") &&
+        elem&.at("./self::clause[@type = 'scope']") and
           @log.add("Style", elem,
-                   "Scope must occur before Terms and Definitions")
+                   "Scope must not occur after Terms and Definitions")
         elem = names.shift
         while elem&.name == "clause"
-          elem&.at("./self::clause[@type = 'scope']")
-          @log.add("Style", elem,
-                   "Scope must occur before Terms and Definitions")
+          elem&.at("./self::clause[@type = 'scope']") and
+            @log.add("Style", elem,
+                     "Scope must not occur after Terms and Definitions")
           elem = names.shift
         end
         %w(annex references).include? elem&.name or
@@ -216,12 +216,8 @@ module Metanorma
       # ISO/IEC DIR 2, 22.3.2
       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/iso/validate_style.rb

@@ -8,8 +8,8 @@ module Metanorma
       def extract_text(node)
         node.nil? and return ""
         node1 = Nokogiri::XML.fragment(node.to_s)
-        node1.xpath(".//link | .//locality | .//localityStack | .//stem")
-          .each(&:remove)
+        node1.xpath(".//link | .//locality | .//localityStack | " \
+          ".//stem | .//sourcecode").each(&:remove)
         ret = ""
         node1.traverse { |x| ret += x.text if x.text? }
         HTMLEntities.new.decode(ret)
@@ -218,7 +218,7 @@ module Metanorma
       end
 
       ASSETS_TO_STYLE =
-        "//termsource | //formula | //termnote | " \
+        "//term//source | //formula | //termnote | " \
         "//p[not(ancestor::boilerplate)] | //li[not(p)] | //dt | " \
         "//dd[not(p)] | //td[not(p)] | //th[not(p)]".freeze
 

data/lib/metanorma/iso/validate_title.rb

@@ -82,7 +82,7 @@ module Metanorma
         withtitle = false
         xpath.each do |s|
           title_all_siblings(s.xpath("./clause | ./terms | ./references"),
-                             s&.at("./title")&.text || s["id"])
+                             s&.at("./title")&.text || s["anchor"])
           subtitle = s.at("./title")
           notitle = notitle || (!subtitle || subtitle.text.empty?)
           withtitle = withtitle || (subtitle && !subtitle.text.empty?)

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Iso
-    VERSION = "3.0.6".freeze
+    VERSION = "3.0.8".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iso
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-29 00:00:00.000000000 Z
+date: 2025-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc