metanorma-iso 3.0.1 → 3.0.3

data/lib/isodoc/iso/presentation_bibdata.rb

@@ -69,8 +69,16 @@ module IsoDoc
         i18n.get.dig("stage_dict", stage.text).is_a?(Hash) or
           return hash_translate(bib, i18n.get["stage_dict"],
                                 "./status/stage", lang)
-        stagetype = i18n.get.dig("stage_dict", stage.text, type&.text) and
-          tag_translate(stage, lang, stagetype)
+        bibdata_i18n_stage1(stage, type, lang, i18n)
+      end
+
+      def bibdata_i18n_stage1(stage, type, lang, i18n)
+        stagetype = i18n.get.dig("stage_dict", stage.text, type&.text) or return
+        h = i18n.get.dig("stage_draft_variants", stagetype) and h.each do |k, v|
+          tag_translate(stage, lang, v)
+          stage.next["type"] = k
+        end
+        tag_translate(stage, lang, stagetype)
       end
     end
   end

data/lib/isodoc/iso/presentation_section.rb

@@ -0,0 +1,138 @@
+module IsoDoc
+  module Iso
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def comments(docxml)
+        warning_for_missing_metadata(docxml)
+        super
+      end
+
+      def warning_for_missing_metadata(docxml)
+        @meta.get[:unpublished] or return
+        ret = warning_for_missing_metadata_create(docxml)
+        ret.empty? and return
+        warning_for_missing_metadata_post(docxml, ret)
+      end
+
+      def warning_for_missing_metadata_create(docxml)
+        ret = ""
+        docxml.at(ns("//bibdata/ext//secretariat")) or
+          ret += "<p>Secretariat is missing.</p>"
+        docxml.at(ns("//bibdata/ext//editorialgroup")) or
+          ret += "<p>Editorial groups are missing.</p>"
+        docxml.at(ns("//bibdata/date[@type = 'published' or @type = 'issued' " \
+                     "or @type = 'created']")) ||
+          docxml.at(ns("//bibdata/version/revision-date")) or
+          ret += "<p>Document date is missing.</p>"
+        ret
+      end
+
+      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}'>
+          <p><strong>Metadata warnings:</strong></p> #{ret}
+          </review>
+        REVIEW
+        unless ins = docxml.at(ns("//review-container"))
+          docxml.root << "<review-container></review-container>"
+          ins = docxml.at(ns("//review-container"))
+        end
+        ins.add_first_child ret
+      end
+
+      # Redo Amendment annex titles as numbered
+      def annex(isoxml)
+        amd?(isoxml) and @suppressheadingnumbers = @oldsuppressheadingnumbers
+        super
+        amd?(isoxml) and @suppressheadingnumbers = true
+      end
+
+      # Redo Amendment annex subclause titles as numbered
+      def clause(docxml)
+        super
+        docxml.xpath(ns("//annex//appendix")).each { |f| clause1(f) }
+        amd?(docxml) or return
+        @suppressheadingnumbers = @oldsuppressheadingnumbers
+        docxml.xpath(ns("//annex//clause | //annex//appendix")).each do |f|
+          f.xpath(ns("./fmt-title | ./fmt-xref-label")).each(&:remove)
+          clause1(f)
+        end
+        @suppressheadingnumbers = true
+      end
+
+      def clause1(node)
+        !node.at(ns("./title")) &&
+          !%w(sections preface bibliography).include?(node.parent.name) and
+          node["inline-header"] = "true"
+        super
+        clause1_section_prefix(node)
+      end
+
+      def clause1_section_prefix(node)
+        if node["type"] == "section" &&
+            c = node.at(ns("./fmt-title//span[@class = 'fmt-caption-delim']"))
+          c.add_first_child(":")
+          t = node.at(ns("./fmt-title"))
+          # French l10n needs tab to be treated as space
+          t.replace @i18n.l10n(to_xml(t).gsub("<tab/>", "<tab> </tab>"))
+            .gsub(%r{<tab>[^<]+</tab>}, "<tab/>")
+        end
+      end
+
+      def toc_title(docxml)
+        %w(amendment technical-corrigendum).include?(@doctype) and return
+        super
+      end
+
+      def middle_title(docxml)
+        @meta.get[:doctitlemain].nil? || @meta.get[:doctitlemain].empty? and
+          return
+        s = docxml.at(ns("//sections")) or return
+        ret = "#{middle_title_main}#{middle_title_amd}"
+        s.add_first_child ret
+      end
+
+      def middle_title_main
+        ret = "<span class='boldtitle'>#{@meta.get[:doctitleintro]}"
+        @meta.get[:doctitleintro] && @meta.get[:doctitlemain] and
+          ret += " &#x2014; "
+        ret += @meta.get[:doctitlemain]
+        @meta.get[:doctitlemain] && @meta.get[:doctitlepart] and
+          ret += " &#x2014; "
+        ret += "</span>#{middle_title_part}"
+        "<p class='zzSTDTitle1'>#{ret}</p>"
+      end
+
+      def middle_title_part
+        ret = ""
+        if a = @meta.get[:doctitlepart]
+          b = @meta.get[:doctitlepartlabel] and
+            ret += "<span class='nonboldtitle'>#{b}:</span> "
+          ret += "<span class='boldtitle'>#{a}</span>"
+        end
+        ret
+      end
+
+      def middle_title_amd
+        ret = ""
+        if a = @meta.get[:doctitleamdlabel]
+          ret += "<p class='zzSTDTitle2'>#{a}"
+          a = @meta.get[:doctitleamd] and ret += ": #{a}"
+          ret += "</p>"
+        end
+        a = @meta.get[:doctitlecorrlabel] and
+          ret += "<p class='zzSTDTitle2'>#{a}</p>"
+        ret
+      end
+
+      def move_norm_ref_to_sections(docxml)
+        amd?(docxml) or super
+      end
+
+      def enable_indexsect
+        true
+      end
+    end
+  end
+end

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -2,6 +2,7 @@ require_relative "init"
 require "isodoc"
 require_relative "presentation_xref"
 require_relative "presentation_bibdata"
+require_relative "presentation_section"
 require_relative "presentation_terms"
 require_relative "../../relaton/render/general"
 
@@ -22,39 +23,6 @@ module IsoDoc
         super
       end
 
-      def section(docxml)
-        super
-        warning_for_missing_metadata(docxml)
-      end
-
-      def warning_for_missing_metadata(docxml)
-        @meta.get[:unpublished] or return
-        ret = warning_for_missing_metadata_create(docxml)
-        ret.empty? and return
-        warning_for_missing_metadata_post(docxml, ret)
-      end
-
-      def warning_for_missing_metadata_create(docxml)
-        ret = ""
-        docxml.at(ns("//bibdata/ext//secretariat")) or
-          ret += "<p>Secretariat is missing.</p>"
-        docxml.at(ns("//bibdata/ext//editorialgroup")) or
-          ret += "<p>Editorial groups are missing.</p>"
-        docxml.at(ns("//bibdata/date[@type = 'published' or @type = 'issued' " \
-                     "or @type = 'created']")) ||
-          docxml.at(ns("//bibdata/version/revision-date")) or
-          ret += "<p>Document date is missing.</p>"
-        ret
-      end
-
-      def warning_for_missing_metadata_post(docxml, ret)
-        id = UUIDTools::UUID.random_create
-        ret = "<review date='#{Date.today}' reviewer='Metanorma' id='_#{id}'>" \
-              "<p><strong>Metadata warnings:<strong></p> #{ret}</review>"
-        ins = docxml.at(ns("//sections//fmt-title")) or return
-        ins.add_first_child ret
-      end
-
       def block(docxml)
         amend docxml
         figure docxml
@@ -79,26 +47,6 @@ module IsoDoc
         note docxml
       end
 
-      # Redo Amendment annex titles as numbered
-      def annex(isoxml)
-        amd?(isoxml) and @suppressheadingnumbers = @oldsuppressheadingnumbers
-        super
-        amd?(isoxml) and @suppressheadingnumbers = true
-      end
-
-      # Redo Amendment annex subclause titles as numbered
-      def clause(docxml)
-        super
-        docxml.xpath(ns("//annex//appendix")).each { |f| clause1(f) }
-        amd?(docxml) or return
-        @suppressheadingnumbers = @oldsuppressheadingnumbers
-        docxml.xpath(ns("//annex//clause | //annex//appendix")).each do |f|
-          f.xpath(ns("./fmt-title | ./fmt-xref-label")).each(&:remove)
-          clause1(f)
-        end
-        @suppressheadingnumbers = true
-      end
-
       def subfigure_delim
         "<span class='fmt-label-delim'>)</span>"
       end
@@ -123,35 +71,6 @@ module IsoDoc
         end
       end
 
-      def clause1(node)
-        !node.at(ns("./title")) &&
-          !%w(sections preface bibliography).include?(node.parent.name) and
-          node["inline-header"] = "true"
-        super
-        clause1_section_prefix(node)
-      end
-
-      def clause1_section_prefix(node)
-        if node["type"] == "section" &&
-            c = node.at(ns("./fmt-title//span[@class = 'fmt-caption-delim']"))
-          c.add_first_child(":")
-          t = node.at(ns("./fmt-title"))
-          # French l10n needs tab to be treated as space
-          t.replace @i18n.l10n(to_xml(t).gsub("<tab/>", "<tab> </tab>"))
-            .gsub(%r{<tab>[^<]+</tab>}, "<tab/>")
-        end
-      end
-
-      #       def clause(docxml)
-      #         docxml.xpath(ns("//clause[not(ancestor::annex)] | " \
-      #                         "//terms | //definitions | //references | " \
-      #                         "//preface/introduction[clause]")).each do |f|
-      #           f.parent.name == "annex" &&
-      #             @xrefs.klass.single_term_clause?(f.parent) and next
-      #           clause1(f)
-      #         end
-      #       end
-
       def admonition1(elem)
         super
         admonition_outside_clauses(elem)
@@ -209,7 +128,7 @@ module IsoDoc
         if elem["class"] == "modspec"
           if n = elem.at(ns(".//fmt-name"))
             n.remove.name = "name"
-          elem.add_first_child(n)
+            elem.add_first_child(n)
           end
           elem.at(ns("./thead"))&.remove
           super
@@ -241,56 +160,6 @@ module IsoDoc
         super
       end
 
-      def toc_title(docxml)
-        %w(amendment technical-corrigendum).include?(@doctype) and return
-        super
-      end
-
-      def middle_title(docxml)
-        @meta.get[:doctitlemain].nil? || @meta.get[:doctitlemain].empty? and
-          return
-        s = docxml.at(ns("//sections")) or return
-        ret = "#{middle_title_main}#{middle_title_amd}"
-        s.add_first_child ret
-      end
-
-      def middle_title_main
-        ret = "<span class='boldtitle'>#{@meta.get[:doctitleintro]}"
-        @meta.get[:doctitleintro] && @meta.get[:doctitlemain] and
-          ret += " &#x2014; "
-        ret += @meta.get[:doctitlemain]
-        @meta.get[:doctitlemain] && @meta.get[:doctitlepart] and
-          ret += " &#x2014; "
-        ret += "</span>#{middle_title_part}"
-        "<p class='zzSTDTitle1'>#{ret}</p>"
-      end
-
-      def middle_title_part
-        ret = ""
-        if a = @meta.get[:doctitlepart]
-          b = @meta.get[:doctitlepartlabel] and
-            ret += "<span class='nonboldtitle'>#{b}:</span> "
-          ret += "<span class='boldtitle'>#{a}</span>"
-        end
-        ret
-      end
-
-      def middle_title_amd
-        ret = ""
-        if a = @meta.get[:doctitleamdlabel]
-          ret += "<p class='zzSTDTitle2'>#{a}"
-          a = @meta.get[:doctitleamd] and ret += ": #{a}"
-          ret += "</p>"
-        end
-        a = @meta.get[:doctitlecorrlabel] and
-          ret += "<p class='zzSTDTitle2'>#{a}</p>"
-        ret
-      end
-
-      def move_norm_ref_to_sections(docxml)
-        amd?(docxml) or super
-      end
-
       def twitter_cldr_localiser_symbols
         { group: "&#xA0;", fraction_group: "&#xA0;",
           fraction_group_digits: 3 }
@@ -315,8 +184,14 @@ module IsoDoc
         end
       end
 
-      def enable_indexsect
-        true
+      def fn_ref_label(fnote)
+        if fnote.ancestors("table, figure").empty? ||
+            !fnote.ancestors("name, fmt-name").empty?
+          "<sup>#{fn_label(fnote)}" \
+            "<span class='fmt-label-delim'>)</span></sup>"
+        else
+          super
+        end
       end
 
       include Init

data/lib/isodoc/iso/word_convert.rb

@@ -21,9 +21,8 @@ module IsoDoc
       end
 
       def font_choice(options)
-        if options[:script] == "Hans" then '"Source Han Sans",serif'
-        else '"Cambria",serif'
-        end
+        options[:script] == "Hans" and return '"Source Han Sans",serif'
+        '"Cambria",serif'
       end
 
       def default_fonts(options)
@@ -55,8 +54,7 @@ module IsoDoc
         if @dis && use_dis?(input_filename, file)
           swap_renderer(self, @dis, file, input_filename, debug)
           @dis.convert(input_filename, file, debug, output_filename)
-        else
-          super
+        else super
         end
       end
 
@@ -90,17 +88,14 @@ module IsoDoc
 
       def colophon_section(_isoxml, out)
         stage = @meta.get[:stage_int]
-        return if !stage.nil? && stage < 60
-
+        !stage.nil? && stage < 60 and return
         br(out, "left")
         out.div class: "colophon" do |div|
         end
       end
 
       def indexsect_section(isoxml, out)
-        isoxml.xpath(ns("//indexsect")).each do |i|
-          indexsect(i, out)
-        end
+        isoxml.xpath(ns("//indexsect")).each { |i| indexsect(i, out) }
       end
 
       def indexsect(elem, out)
@@ -131,11 +126,6 @@ module IsoDoc
         TOC
       end
 
-      def footnote_reference_format(link)
-        link.children =
-          "<span class='MsoFootnoteReference'>#{to_xml(link.children)}</span>)"
-      end
-
       def bibliography_attrs
         { class: "BiblioTitle" }
       end
@@ -249,6 +239,8 @@ module IsoDoc
         node.xpath(ns("./source")).each { |n| parse(n, out) }
         node.xpath(ns("./note[not(@type = 'units')]"))
           .each { |n| parse(n, out) }
+        node.xpath(ns("./fmt-footnote-container/fmt-fn-body"))
+          .each { |n| parse(n, out) }
       end
 
       include BaseConvert

data/lib/isodoc/iso/xref.rb

@@ -247,12 +247,6 @@ module IsoDoc
                           { unnum: false, container: true })
         end
       end
-
-      # KILL
-      def sequential_permission_childrenx(elem, lbl, klass, container: false)
-        container = true
-        super
-      end
     end
   end
 end

data/lib/metanorma/iso/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">
@@ -857,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">
@@ -869,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">

data/lib/metanorma/iso/cleanup.rb

@@ -43,8 +43,8 @@ module Metanorma
 
       TERM_CLAUSE =
         "//sections/terms | " \
-        "//sections/clause//terms[not(preceding-sibling::clause)] | " \
-        "//sections//clause[descendant::terms][not(descendant::definitions)][@type = 'terms'] | " \
+        "//sections//terms[not(preceding-sibling::clause)] | " \
+        "//sections//clause[@type = 'terms'][not(descendant::definitions)] | " \
         "//sections/clause[not(@type = 'terms')][not(descendant::definitions)]//terms".freeze
 
       def sections_cleanup(xml)

data/lib/metanorma/iso/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>
@@ -414,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"/>
@@ -1263,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">
@@ -1273,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/iso/relaton-iso.rng

@@ -63,14 +63,6 @@
         </choice>
       </element>
     </define>
-    <define name="organization">
-      <element name="organization">
-        <choice>
-          <ref name="OrganizationType"/>
-          <ref name="IsoOrganizationType"/>
-        </choice>
-      </element>
-    </define>
     <define name="DocumentType">
       <choice>
         <value>international-standard</value>
@@ -219,18 +211,4 @@
       <text/>
     </element>
   </define>
-  <define name="IsoOrganizationType">
-    <optional>
-      <ref name="technical-committee"/>
-    </optional>
-    <optional>
-      <ref name="subcommittee"/>
-    </optional>
-    <optional>
-      <ref name="workgroup"/>
-    </optional>
-    <optional>
-      <ref name="secretariat"/>
-    </optional>
-  </define>
 </grammar>

data/lib/metanorma/iso/validate.rb

@@ -92,11 +92,11 @@ module Metanorma
 
       def term_xrefs_validate1(xref, termids)
         closest_id = xref.xpath("./ancestor::*[@id]")&.last or return
-        (termids[xref["target"]] && !termids[closest_id["id"]]) and
+        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["id"]]) 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/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Iso
-    VERSION = "3.0.1".freeze
+    VERSION = "3.0.3".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iso
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 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
@@ -352,6 +352,7 @@ files:
 - lib/isodoc/iso/metadata.rb
 - lib/isodoc/iso/pdf_convert.rb
 - lib/isodoc/iso/presentation_bibdata.rb
+- lib/isodoc/iso/presentation_section.rb
 - lib/isodoc/iso/presentation_terms.rb
 - lib/isodoc/iso/presentation_xml_convert.rb
 - lib/isodoc/iso/presentation_xref.rb