metanorma-iso 3.0.7 → 3.0.9

data/lib/isodoc/iso/metadata.rb

@@ -11,8 +11,7 @@ module IsoDoc
       end
 
       def status_abbrev(stage, _substage, iter, draft, doctype)
-        return "" unless stage
-
+        stage or return ""
         if %w(technical-report technical-specification).include?(doctype)
           stage = "DTS" if stage == "DIS"
           stage = "FDTS" if stage == "FDIS"
@@ -103,16 +102,16 @@ module IsoDoc
       end
 
       def compose_title(tparts, tnums, lang)
-        main = ""
-        tparts[:main].nil? or
-          main = tparts[:main].children.to_xml
+        t = tparts[:main].nil? ? "" :  tparts[:main].children.to_xml
         tparts[:intro] and
-          main = "#{tparts[:intro].children.to_xml} — #{main}"
+          t = "#{tparts[:intro].children.to_xml} — #{t}"
+        tparts[:complementary] and
+          t = "#{t} — #{tparts[:complementary].children.to_xml}"
         if tparts[:part]
           suffix = part_title(tparts[:part], tnums, lang)
-          main = "#{main} — #{suffix}"
+          t = "#{t} — #{suffix}"
         end
-        main
+        t
       end
 
       def title_nums(isoxml)
@@ -125,16 +124,10 @@ module IsoDoc
       end
 
       def title_parts(isoxml, lang)
-        { intro: isoxml.at(ns("//bibdata/title[@type='title-intro' and " \
-                              "@language='#{lang}']")),
-          main: isoxml.at(ns("//bibdata/title[@type='title-main' and " \
-                             "@language='#{lang}']")),
-          part: isoxml.at(ns("//bibdata/title[@type='title-part' and " \
-                             "@language='#{lang}']")),
-          amd: isoxml.at(ns("//bibdata/title[@type='title-amd' and " \
-                            "@language='#{lang}']")),
-          add: isoxml.at(ns("//bibdata/title[@type='title-add' and " \
-                            "@language='#{lang}']")) }
+        %w(intro main complementary part amd add).each_with_object({}) do |w, m|
+          m[w.to_sym] = isoxml.at(ns("//bibdata/title[@type='title-#{w}' and " \
+                              "@language='#{lang}']"))
+        end
       end
 
       def title(isoxml, _out)
@@ -142,13 +135,15 @@ module IsoDoc
                when "fr", "ru" then @lang
                else "en"
                end
-        # intro, main, part, amd = title_parts(isoxml, lang)
+        # intro, main, complementary, part, amd = title_parts(isoxml, lang)
         tp = title_parts(isoxml, lang)
         tn = title_nums(isoxml)
         set(:doctitlemain, tp[:main] ? tp[:main].children.to_xml : "")
         main = compose_title(tp, tn, lang)
         set(:doctitle, main)
         tp[:intro] and set(:doctitleintro, tp[:intro].children.to_xml)
+        tp[:complementary] and
+          set(:doctitlecomplementary, tp[:complementary].children.to_xml)
         set(:doctitlepartlabel, part_prefix(tn, lang))
         set(:doctitlepart, tp[:part].children.to_xml) if tp[:part]
         set(:doctitleamdlabel, amd_prefix(tn, lang)) if tn[:amd]
@@ -167,6 +162,8 @@ module IsoDoc
         main = compose_title(tp, tn, lang)
         set(:docsubtitle, main)
         tp[:intro] and set(:docsubtitleintro, tp[:intro].children.to_xml)
+        tp[:complementary] and
+          set(:docsubtitlecomplementary, tp[:complementary].children.to_xml)
         set(:docsubtitlepartlabel, part_prefix(tn, lang))
         tp[:part] and set(:docsubtitlepart, tp[:part].children.to_xml)
         set(:docsubtitleamdlabel, amd_prefix(tn, lang)) if tn[:amd]

data/lib/isodoc/iso/presentation_section.rb

@@ -28,9 +28,8 @@ module IsoDoc
 
       def warning_for_missing_metadata_post(docxml, ret)
         from = docxml.at(ns("//sections/*/@id"))&.text or return
-        id = UUIDTools::UUID.random_create
         ret = <<~REVIEW
-          <review date='#{Date.today}' reviewer='Metanorma' id='_#{id}' from='#{from}' to='#{from}'>
+          <review date='#{Date.today}' reviewer='Metanorma' #{add_id_text} from='#{from}' to='#{from}'>
           <p><strong>Metadata warnings:</strong></p> #{ret}
           </review>
         REVIEW
@@ -98,7 +97,8 @@ module IsoDoc
         @meta.get[:doctitleintro] && @meta.get[:doctitlemain] and
           ret += " &#x2014; "
         ret += @meta.get[:doctitlemain]
-        @meta.get[:doctitlemain] && @meta.get[:doctitlepart] and
+        @meta.get[:doctitlemain] &&
+          (@meta.get[:doctitlepart] || @meta.get[:doctitlecomplementary]) and
           ret += " &#x2014; "
         ret += "</span>#{middle_title_part}"
         "<p class='zzSTDTitle1'>#{ret}</p>"
@@ -106,7 +106,9 @@ module IsoDoc
 
       def middle_title_part
         ret = ""
-        if a = @meta.get[:doctitlepart]
+        if a = @meta.get[:doctitlecomplementary]
+          ret += "<span class='boldtitle'>#{a}</span>"
+        elsif a = @meta.get[:doctitlepart]
           b = @meta.get[:doctitlepartlabel] and
             ret += "<span class='nonboldtitle'>#{b}:</span> "
           ret += "<span class='boldtitle'>#{a}</span>"

data/lib/isodoc/iso/xref.rb

@@ -160,7 +160,7 @@ module IsoDoc
             s.xpath(ns(".//appendix//ol")) - s.xpath(ns(".//ol//ol"))
           c = Counter.new
           notes.noblank.each do |n|
-            n["id"] ||= "_#{UUIDTools::UUID.random_create}"
+            #n["id"] ||= "_#{UUIDTools::UUID.random_create}"
             @anchors[n["id"]] = anchor_struct(increment_label(notes, n, c), n,
                                               @labels["list"], "list",
                                               { unnumb: false, container: true })

data/lib/metanorma/iso/cleanup.rb

@@ -73,6 +73,7 @@ module Metanorma
           fn = n.children.to_xml
           n.elements&.first&.name == "p" or fn = "<p>#{fn}</p>"
           e.next = "<fn>#{fn}</fn>"
+          add_id(e.next)
         end
       end
 

data/lib/metanorma/iso/front.rb

@@ -71,6 +71,13 @@ module Metanorma
         @log.add("Document Attributes", nil, err)
       end
 
+      def title_component(node, xml, lang, attr, comp)
+        t = node.attr("title-#{comp[:name]}-#{lang}") or return
+        xml.title(**attr_code(attr.merge(type: "title-#{comp[:abbr]}"))) do |t1|
+          t1 << Metanorma::Utils::asciidoc_sub(t)
+        end
+      end
+
       def title_intro(node, xml, lang, at)
         t = node.attr("title-intro-#{lang}") or return
         xml.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
@@ -106,30 +113,44 @@ module Metanorma
       end
 
       def title_full(node, xml, lang, at)
-        title = node.attr("title-main-#{lang}")
-        intro = node.attr("title-intro-#{lang}")
-        part = node.attr("title-part-#{lang}")
-        amd = node.attr("title-amendment-#{lang}")
-        add = node.attr("title-addendum-#{lang}")
+        title, intro, part, amd, add = title_full_prep(node, lang)
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
-        title = "#{title} -- #{amd}" if amd && @amd
-        title = "#{title} -- #{add}" if amd && node.attr("addendum-number")
+        title = "#{title} -- #{amd}" if amd
+        title = "#{title} -- #{add}" if add
         xml.title **attr_code(at.merge(type: "main")) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(title)
         end
       end
 
+      def title_full_prep(node, lang)
+        title = node.attr("title-main-#{lang}")
+        intro = node.attr("title-intro-#{lang}")
+        part = node.attr("title-part-#{lang}") ||
+          node.attr("title-complementary-#{lang}")
+        @amd and amd = node.attr("title-amendment-#{lang}")
+        node.attr("addendum-number") and
+          add = node.attr("title-addendum-#{lang}")
+        [title, intro, part, amd, add].map { |x| x&.empty? ? nil : x }
+      end
+
       def title(node, xml)
         %w(en ru fr).each do |lang|
           at = { language: lang, format: "text/plain" }
-          title_full(node, xml, lang, at)
-          title_intro(node, xml, lang, at)
-          title_main(node, xml, lang, at)
-          title_part(node, xml, lang, at)
-          title_amd(node, xml, lang, at) if @amd
-          title_add(node, xml, lang, at) if node.attr("addendum-number")
+          title1(node, xml, lang, at)
+        end
+      end
+
+      def title1(node, xml, lang, at)
+        title_full(node, xml, lang, at)
+        %w(intro main part complementary).each do |w|
+          title_component(node, xml, lang, at, { name: w, abbr: w })
         end
+        @amd and title_component(node, xml, lang, at,
+                                 { name: "amendment", abbr: "amd" })
+        node.attr("addendum-number") and
+          title_component(node, xml, lang, at,
+                          { name: "addendum", abbr: "add" })
       end
 
       def relaton_relations

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.5 -->
+<!-- VERSION v2.0.7 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -76,6 +76,7 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
         <a:documentation>Title proper for a clause</a:documentation>
+        <ref name="RequiredId"/>
         <zeroOrMore>
           <ref name="TextElement"/>
         </zeroOrMore>
@@ -83,10 +84,19 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <zeroOrMore>
         <element name="variant-title">
           <a:documentation>Alternate title for a clause</a:documentation>
+          <ref name="RequiredId"/>
           <ref name="TypedTitleString"/>
         </element>
       </zeroOrMore>
     </define>
+    <define name="tname">
+      <element name="name">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="NestedTextElement"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="UlBody">
       <optional>
         <ref name="tname">
@@ -475,6 +485,7 @@ normative or informative references, some split references into sections organiz
     <!-- exclude figures? -->
     <define name="dd">
       <element name="dd">
+        <ref name="OptionalId"/>
         <zeroOrMore>
           <!-- exclude figures? -->
           <ref name="BasicBlock"/>
@@ -526,6 +537,7 @@ normative or informative references, some split references into sections organiz
       </choice>
     </define>
     <define name="TrAttributes">
+      <ref name="OptionalId"/>
       <optional>
         <attribute name="style">
           <a:documentation>CSS style: only background-color supported</a:documentation>
@@ -595,6 +607,7 @@ gives an explicit page orientation</a:documentation>
   </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.
@@ -604,6 +617,7 @@ This is done if the footnote reference is already presented in some other form,
     </optional>
   </define>
   <define name="TdAttributes" combine="interleave">
+    <ref name="RequiredId"/>
     <optional>
       <attribute name="style">
         <a:documentation>CSS style: only background-color supported</a:documentation>
@@ -801,6 +815,12 @@ titlecase, or lowercase</a:documentation>
         <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>
@@ -808,6 +828,12 @@ titlecase, or lowercase</a:documentation>
         <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>
@@ -954,6 +980,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>
@@ -1808,7 +1835,7 @@ used in document amendments</a:documentation>
     </element>
   </define>
   <define name="TermAttributes">
-    <ref name="OptionalId"/>
+    <ref name="RequiredId"/>
     <ref name="LocalizedStringAttributes"/>
     <ref name="BlockAttributes"/>
   </define>
@@ -2151,6 +2178,7 @@ used in document amendments</a:documentation>
   <define name="termdefinition">
     <a:documentation>The definition of a term applied in the current document</a:documentation>
     <element name="definition">
+      <ref name="RequiredId"/>
       <optional>
         <attribute name="type">
           <a:documentation>Type of definition, used to differentiate it from other definitions of the same term if present</a:documentation>
@@ -2172,6 +2200,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="verbaldefinition">
     <element name="verbal-definition">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the verbal representation of the term</a:documentation>
@@ -2192,6 +2221,7 @@ used in document amendments</a:documentation>
   <define name="nonverbalrep">
     <a:documentation>Non-verbal representation of the term</a:documentation>
     <element name="non-verbal-representation">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the non-verbal representation of the term</a:documentation>

data/lib/metanorma/iso/section.rb

@@ -5,27 +5,11 @@ module Metanorma
   module Iso
     class Converter < Standoc::Converter
 
-      # KILL
-      def clause_parsex(attrs, xml, node)
-        node.option? "appendix" and return appendix_parse(attrs, xml, node)
-        super
-      end
-
       def scope_parse(attrs, xml, node)
         attrs = attrs.merge(type: "scope") unless @amd
         clause_parse(attrs, xml, node)
       end
 
-      # KILL
-      def appendix_parsex(attrs, xml, node)
-        attrs[:"inline-header"] = node.option? "inline-header"
-        set_obligation(attrs, node)
-        xml.appendix **attr_code(attrs) do |xml_section|
-          xml_section.title { |name| name << node.title }
-          xml_section << node.content
-        end
-      end
-
       def support_appendix?(_node)
         true
       end

data/lib/metanorma/iso/validate.rb

@@ -25,22 +25,6 @@ module Metanorma
         end
       end
 
-      # KILL
-      def see_xrefs_validatex(root)
-        @lang == "en" or return
-        root.xpath("//xref").each do |t|
-          preceding = t.at("./preceding-sibling::text()[last()]")
-          !preceding.nil? &&
-            /\b(see| refer to)\p{Zs}*\Z/mi.match(preceding) or next
-
-          (target = root.at("//*[@anchor = '#{t['target']}']")) || next
-          target.at("./ancestor-or-self::*[@obligation = 'normative']") &&
-            !target.at("./ancestor::sections") and
-            @log.add("Style", t,
-                     "'see #{t['target']}' is pointing to a normative section")
-        end
-      end
-
       # ISO/IEC DIR 2, 15.5.3, 20.2
       # does not deal with preceding text marked up
       def see_xrefs_validate(root)
@@ -122,7 +106,8 @@ module Metanorma
           .xpath("//sections/terms | //sections/clause[.//terms] | " \
                  "//annex[.//terms]").each_with_object({}) do |t, m|
           t.xpath(".//*/@anchor").each { |a| m[a.text] = true }
-          t.name == "terms" and m[t["anchor"]] = true
+          t.xpath(".//*/@id").each { |a| m[a.text] = true }
+          t.name == "terms" and m[t["anchor"] || t["id"]] = true
         end
         xmldoc.xpath(".//xref").each do |x|
           term_xrefs_validate1(x, termids)
@@ -130,12 +115,12 @@ module Metanorma
       end
 
       def term_xrefs_validate1(xref, termids)
-        closest_id = xref.xpath("./ancestor::*[@anchor]")&.last or return
-        termids[xref["target"]] && !termids[closest_id["anchor"]] and
+        closest_id = xref.xpath("./ancestor::*[@id]")&.last or return
+        termids[xref["target"]] && !termids[closest_id["id"]] and
           @log.add("Style", xref,
                    "only terms clauses can cross-reference terms clause " \
                    "(#{xref['target']})")
-        !termids[xref["target"]] && termids[closest_id["anchor"]] and
+        !termids[xref["target"]] && termids[closest_id["id"]] and
           @log.add("Style", xref,
                    "non-terms clauses cannot cross-reference terms clause " \
                    "(#{xref['target']})")

data/lib/metanorma/iso/validate_image.rb

@@ -77,8 +77,7 @@ module Metanorma
       def image_name_validate(xmldoc)
         prefix = image_name_prefix(xmldoc) or return
         xmldoc.xpath("//image").each do |i|
-          next if i["src"].start_with?("data:")
-
+          i["src"].start_with?("data:") and next
           case File.basename(i["src"])
           when /^ISO_\d+_/
           when /^(SL)?#{prefix}fig/ then image_name_validate1(i, prefix)

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
@@ -155,10 +155,12 @@ module Metanorma
                                    "Normative References")
           end
         end
+        elem.nil? and return
         elem&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) " \
                                  "Normative References")
         elem = names&.shift
+        elem.nil? and return
         elem&.at("./self::references[@normative = 'false']") ||
           @log.add("Style", elem,
                    "Final section must be (references) Bibliography")
@@ -167,7 +169,9 @@ module Metanorma
                    "There are sections after the final Bibliography")
       end
 
-      NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze
+      NORM_ISO_WARN = <<~WARN.freeze
+        non-ISO/IEC reference is allowed as normative only subject to the conditions in ISO/IEC DIR 2 10.2
+      WARN
       SCOPE_WARN = "Scope contains subclauses: should be succinct".freeze
 
       def section_style(root)

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)

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Iso
-    VERSION = "3.0.7".freeze
+    VERSION = "3.0.9".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iso
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.0.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc