metanorma-iso 3.4.5 → 3.4.7

data/lib/isodoc/iso/metadata.rb

@@ -92,11 +92,13 @@ module IsoDoc
           subpart: isoxml.at(ns("#{prefix}/@subpart")),
           amd: isoxml.at(ns("#{prefix}/@amendment")),
           add: isoxml.at(ns("#{prefix}/@addendum")),
+          sup: isoxml.at(ns("#{prefix}/@supplement")),
+          ext: isoxml.at(ns("#{prefix}/@extract")),
           corr: isoxml.at(ns("#{prefix}/@corrigendum")) }
       end
 
       def title_parts(isoxml, lang)
-        %w(intro main complementary part amd add).each_with_object({}) do |w, m|
+        %w(intro main complementary part amd add sup ext).each_with_object({}) do |w, m|
           m[w.to_sym] = isoxml.at(ns("//bibdata/title[@type='title-#{w}' and " \
                                      "@language='#{lang}']"))
         end
@@ -123,6 +125,12 @@ module IsoDoc
         tn[:add] and set(:doctitleaddlabel,
                          title_part_prefix(isoxml, "addendum", lang))
         tp[:add] and set(:doctitleadd, to_xml(tp[:add].children))
+        tn[:sup] and set(:doctitlesuplabel,
+                         title_part_prefix(isoxml, "supplement", lang))
+        tp[:sup] and set(:doctitlesup, to_xml(tp[:sup].children))
+        tn[:ext] and set(:doctitleextlabel,
+                         title_part_prefix(isoxml, "extract", lang))
+        tp[:ext] and set(:doctitleext, to_xml(tp[:ext].children))
         main = compose_title(tp, tn, lang)
         set(:doctitle, main)
       end
@@ -144,6 +152,12 @@ module IsoDoc
         tn[:add] and set(:docsubtitleaddlabel,
                          title_part_prefix(isoxml, "addendum", lang))
         tp[:add] and set(:docsubtitleadd, to_xml(tp[:add].children))
+        tn[:sup] and set(:docsubtitlesuplabel,
+                         title_part_prefix(isoxml, "supplement", lang))
+        tp[:sup] and set(:docsubtitlesup, to_xml(tp[:sup].children))
+        tn[:ext] and set(:docsubtitleextlabel,
+                         title_part_prefix(isoxml, "extract", lang))
+        tp[:ext] and set(:docsubtitleext, to_xml(tp[:ext].children))
         tn[:corr] and set(:docsubtitlecorrlabel,
                           title_part_prefix(isoxml, "corrigendum", lang))
         main = compose_title(tp, tn, lang)

data/lib/isodoc/iso/presentation_origin.rb

@@ -84,15 +84,11 @@ module IsoDoc
         insert_biblio_callout(elem)
       end
 
-      # TODO share with metanorma dir
-      ISO_PUBLISHER_XPATH = <<~XPATH.freeze
-        ./contributor[role/@type = 'publisher']/organization[abbreviation = 'ISO' or abbreviation = 'IEC' or name = 'International Organization for Standardization' or name = 'International Electrotechnical Commission']
-      XPATH
-
       def insert_biblio_callout(elem)
         semx = elem.document.at("//*[@id = '#{elem['source']}']") or return
         if ref = @bibitem_lookup[semx["bibitemid"]]
-          ref.at(ns(ISO_PUBLISHER_XPATH)) and return
+          Metanorma::Iso::PublisherIdentity
+            .iso_iec_publisher?(ref, ns: method(:ns)) and return
           # is this reference cited with a [n],
           # even if it has its own SDO identifier?
           citeas = ref.at(ns("./docidentifier[@type = 'metanorma-ordinal']")) ||

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -16,7 +16,11 @@ module IsoDoc
       end
 
       def convert1(docxml, filename, dir)
-        @iso_class = instance_of?(IsoDoc::Iso::PresentationXMLConvert)
+        # ISO-only (not inheriting flavours, and -- unlike instance_of? --
+        # not tastes that reuse this class): gate on the document publisher.
+        # metanorma/metanorma-oiml#13.
+        @iso_class = Metanorma::Iso::PublisherIdentity
+          .iso_publisher?(docxml.at(ns("//bibdata")), ns: method(:ns))
         if amd?(docxml)
           @oldsuppressheadingnumbers = @suppressheadingnumbers
           @suppressheadingnumbers = true
@@ -183,6 +187,17 @@ module IsoDoc
         ret
       end
 
+      # ISO mandates sequential bibliography numbering. A `.metanorma`
+      # docidentifier (e.g. `[ГОСТ 3295-73]`) must not suppress the
+      # autonumber the way it does for other flavours.
+      # https://github.com/metanorma/metanorma-iso/issues/1530
+      def bibliography_bibitem_number_skip(bibitem)
+        implicit_reference(bibitem) ||
+          bibitem.at(ns(".//docidentifier[@type = 'metanorma-ordinal']")) ||
+          bibitem["suppress_identifier"] == "true" ||
+          bibitem["hidden"] == "true" || bibitem.parent["hidden"] == "true"
+      end
+
       def admonition_delim(elem)
         if elem.at("./*[not(self::xmlns:name)]")&.name == "p"
           " — "

data/lib/isodoc/iso/word_cleanup.rb

@@ -181,8 +181,7 @@ module IsoDoc
       # do not use in IEC, BSI, where Word does not use list to generate
       # "Annex A"
       def annex_toc(annexid)
-        instance_of?(IsoDoc::Iso::WordConvert) ||
-          instance_of?(WordDISConvert) or return ""
+        @iso_publisher or return ""
         annexid += 1
         x = "#{@i18n.annex} #{('@'.ord + annexid).chr} "
         [x, annexid]

data/lib/isodoc/iso/word_convert.rb

@@ -58,6 +58,17 @@ module IsoDoc
         end
       end
 
+      # word_cleanup (make_WordToC / annex_toc) runs on the generated Word
+      # HTML, which no longer carries <bibdata>; capture the document's
+      # ISO-publisher identity here, off the source presentation XML, and
+      # propagate it via @iso_publisher. ISO-only (not IEC/BSI, and --
+      # unlike instance_of? -- not tastes reusing this class). oiml#13.
+      def convert1(docxml, filename, dir)
+        @iso_publisher = Metanorma::Iso::PublisherIdentity
+          .iso_publisher?(docxml.at(ns("//bibdata")), ns: method(:ns))
+        super
+      end
+
       def make_body(xml, docxml)
         body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
         xml.body(**body_attr) do |body|

data/lib/metanorma/iso/basicdoc.rng

@@ -1902,15 +1902,40 @@ or as the string "auto"</a:documentation>
     <a:documentation>Mathematically formatted text</a:documentation>
     <element name="stem">
       <ref name="StemAttributes"/>
-      <oneOrMore>
-        <choice>
+      <optional>
+        <text>
           <a:documentation>The content of the mathematically formatted text</a:documentation>
-          <text/>
-          <ref name="AnyElement"/>
-        </choice>
-      </oneOrMore>
+        </text>
+      </optional>
+      <optional>
+        <ref name="mathml"/>
+      </optional>
+      <optional>
+        <ref name="asciimath"/>
+      </optional>
+      <optional>
+        <ref name="latexmath"/>
+      </optional>
     </element>
   </define>
+  <define name="latexmath">
+    <a:documentation>Encoding of LatexMath</a:documentation>
+    <element name="latexmath">
+      <text/>
+    </element>
+  </define>
+  <define name="asciimath">
+    <a:documentation>Encoding of AsciiMath</a:documentation>
+    <element name="asciimath">
+      <text/>
+    </element>
+  </define>
+  <define name="mathml">
+    <a:documentation>Encoding of MathML: the official W3C MathML 3.0 grammar (namespace
+http://www.w3.org/1998/Math/MathML), via the metanorma wrapper in
+grammars/mathml/. See grammars/mathml/README.adoc and basicdoc-models#35.</a:documentation>
+    <externalRef href="metanorma-mathml.rng"/>
+  </define>
   <define name="StemAttributes">
     <attribute name="type">
       <a:documentation>The notation used to mathematically format the text</a:documentation>

data/lib/metanorma/iso/cleanup_biblio.rb

@@ -18,7 +18,8 @@ module Metanorma
       # ISO as a prefix goes first
       def docidentifier_cleanup(xml)
         prefix = get_id_prefix(xml)
-        amd = @amd || xml.at("//bibdata/ext/doctype")&.text == "addendum"
+        amd = @amd ||
+          %w(addendum supplement extract).include?(xml.at("//bibdata/ext/doctype")&.text)
         id = xml.at("//bibdata/ext/structuredidentifier/project-number") and
           id.content =
             id_prefix(prefix, id, amd:)
@@ -89,8 +90,34 @@ module Metanorma
 
       def bibitem_cleanup(xmldoc)
         super
-        unpublished_note(xmldoc)
-        withdrawn_note(xmldoc)
+        cutoff = biblio_cutoff_date(xmldoc)
+        unpublished_note(xmldoc, cutoff)
+        withdrawn_note(xmldoc, cutoff)
+      end
+
+      # The citing document's publication date: reference status annotations
+      # (withdrawn/replaced, under-preparation) are rewound to this date, so a
+      # reference is not shown with a status change that only happened *after*
+      # the citing document was published. metanorma/metanorma-standoc#941.
+      def biblio_cutoff_date(xmldoc)
+        bd = xmldoc.at("//bibdata") or return nil
+        dates = bd.xpath("./date[@type = 'published' or @type = 'issued' or " \
+                         "@type = 'circulated']/on").map { |d| iso_date(d.text) }
+        if (y = bd.at("./copyright/from")&.text)&.match?(/^\d{4}$/)
+          dates << Date.new(y.to_i, 12, 31)
+        end
+        dates.compact.max
+      end
+
+      # Complete a partial ISO date to the end of its period, so a status change
+      # anywhere within the citing document's publication year still counts as
+      # having occurred by publication.
+      def iso_date(str)
+        case str.to_s.strip
+        when /^(\d{4})$/ then Date.new($1.to_i, 12, 31)
+        when /^(\d{4})-(\d{2})/ then Date.new($1.to_i, $2.to_i, -1)
+        else Date.parse(str) rescue nil
+        end
       end
 
       def bibitem_note_types(bib)
@@ -99,21 +126,21 @@ module Metanorma
         end.flatten
       end
 
-      def unpublished_note(xmldoc)
+      def unpublished_note(xmldoc, cutoff = nil)
         xmldoc.xpath("//bibitem[not(./ancestor::bibitem)]").each do |b|
           n = bibitem_note_types(b)
-          n.include?("Unpublished-Status") or unpublished_note1(b)
+          n.include?("Unpublished-Status") or unpublished_note1(b, cutoff)
         end
       end
 
-      def unpublished_note1(bibitem)
+      def unpublished_note1(bibitem, cutoff = nil)
         unpublished_ref?(bibitem) and return
         docid = bibitem.at("./docidentifier[@primary = 'true']") ||
           bibitem.at("./docidentifier[@type = 'ISO' or @type = 'IEC']") ||
           bibitem.at("./docidentifier")
         base_pubid, orig = parse_draft_docid(docid, bibitem)
         insert_unpub_note(bibitem, @i18n.under_preparation
-          .sub("%", dated_draft_id(orig, base_pubid)))
+          .sub("%", dated_draft_id(orig, base_pubid, cutoff)))
         draft_biblio_docid(orig, base_pubid, docid)
       end
 
@@ -131,24 +158,24 @@ module Metanorma
         docid.children = new
       end
 
-      def dated_draft_id(orig, base_pubid)
+      def dated_draft_id(orig, base_pubid, cutoff = nil)
         ret = orig.dup
-        ret[:year] = Date.today.year
+        ret[:year] = cutoff&.year || Date.today.year
         base_pubid.create(**ret).to_s
       end
 
       def unpublished_ref?(bibitem)
-        pub_class(bibitem) > 2 and return true
+        PublisherIdentity.iso_iec_publisher?(bibitem) or return true
         ((s = bibitem.at("./status/stage")) && s.text.match?(/\d/) &&
          (s.text.to_i < 60)) or return true
         false
       end
 
-      def withdrawn_note(xmldoc)
+      def withdrawn_note(xmldoc, cutoff = nil)
         xmldoc.xpath("//bibitem").each do |b|
           n = bibitem_note_types(b)
           n.include?("Unpublished-Status") and next
-          withdrawn_ref?(b) or next
+          withdrawn_ref?(b, cutoff) or next
           if id = replacement_standard(b)
             insert_unpub_note(b, @i18n.cancelled_and_replaced.sub("%", id))
           else insert_unpub_note(b, @i18n.withdrawn)
@@ -156,10 +183,23 @@ module Metanorma
         end
       end
 
-      def withdrawn_ref?(bibitem)
-        pub_class(bibitem) > 2 and return false
+      def withdrawn_ref?(bibitem, cutoff = nil)
+        PublisherIdentity.iso_iec_publisher?(bibitem) or return false
         (s = bibitem.at("./status/stage")) && (s.text.to_i == 95) &&
-          (t = bibitem.at("./status/substage")) && (t.text.to_i == 99)
+          (t = bibitem.at("./status/substage")) && (t.text.to_i == 99) or
+          return false
+        # As-of-date: a withdrawal that only happened after the citing document
+        # was published did not apply then. metanorma/metanorma-standoc#941.
+        wd = withdrawal_date(bibitem)
+        !(cutoff && wd && wd > cutoff)
+      end
+
+      # Date the reference was superseded/withdrawn: the earliest published date
+      # of an obsoletedBy/updates successor.
+      def withdrawal_date(bibitem)
+        bibitem.xpath("./relation[@type = 'obsoletedBy' or @type = 'updates']" \
+                      "/bibitem/date[@type = 'published' or @type = 'circulated']" \
+                      "/on").map { |d| iso_date(d.text) }.compact.min
       end
 
       def replacement_standard(biblio)

data/lib/metanorma/iso/front.rb

@@ -79,11 +79,13 @@ module Metanorma
       end
 
       def title_full(node, xml, lang)
-        title, intro, part, amd, add = title_full_prep(node, lang)
+        title, intro, part, amd, add, sup, ext = title_full_prep(node, lang)
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
         title = "#{title} -- #{amd}" if amd
         title = "#{title} -- #{add}" if add
+        title = "#{title} -- #{sup}" if sup
+        title = "#{title} -- #{ext}" if ext
         add_title_xml(xml, title, lang, "main")
       end
 
@@ -95,7 +97,11 @@ module Metanorma
         @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 }
+        node.attr("supplement-number") and
+          sup = node.attr("title-supplement-#{lang}")
+        node.attr("extract-number") and
+          ext = node.attr("title-extract-#{lang}")
+        [title, intro, part, amd, add, sup, ext].map { |x| x&.empty? ? nil : x }
       end
 
       def title(node, xml)
@@ -115,6 +121,12 @@ module Metanorma
         node.attr("addendum-number") and
           title_component(node, xml, lang,
                           { name: "addendum", abbr: "add" })
+        node.attr("supplement-number") and
+          title_component(node, xml, lang,
+                          { name: "supplement", abbr: "sup" })
+        node.attr("extract-number") and
+          title_component(node, xml, lang,
+                          { name: "extract", abbr: "ext" })
         title_nums(node, xml, lang)
       end
 

data/lib/metanorma/iso/front_id.rb

@@ -28,6 +28,8 @@ module Metanorma
       def get_typeabbr(node, amd: false)
         node.attr("amendment-number") and return :amd
         node.attr("addendum-number") and return :add
+        node.attr("supplement-number") and return :sup
+        node.attr("extract-number") and return :ext
         node.attr("corrigendum-number") and return :cor
         DOCTYPE2HASHID[doctype(node).to_sym]
       end
@@ -103,7 +105,9 @@ module Metanorma
         stage = iso_id_stage(node)
         ret = { number: node.attr("amendment-number") ||
           node.attr("corrigendum-number") ||
-          node.attr("addendum-number"),
+          node.attr("addendum-number") ||
+          node.attr("supplement-number") ||
+          node.attr("extract-number"),
                 year: iso_id_year(node),
                 iteration: node.attr("iteration") }
         iso_id_stage_populate(ret, node, stage)
@@ -144,7 +148,9 @@ module Metanorma
       def iso_id_params_resolve(params, params2, node, orig_id)
         if orig_id && (node.attr("amendment-number") ||
             node.attr("corrigendum-number") ||
-                      node.attr("addendum-number"))
+                      node.attr("addendum-number") ||
+                      node.attr("supplement-number") ||
+                      node.attr("extract-number"))
           %i(unpublished part).each { |x| params.delete(x) }
           params2[:base] = orig_id
         elsif orig_id &&

data/lib/metanorma/iso/isodoc.rng

@@ -213,6 +213,12 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
     <define name="ExampleAttributes">
       <ref name="NumberingAttributes"/>
       <ref name="BlockAttributes"/>
+      <optional>
+        <attribute name="collapsible">
+          <a:documentation>Render the example as collapsible (HTML5 details/summary)</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
     </define>
     <define name="ExampleBody">
       <optional>
@@ -846,7 +852,7 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the figure block in rendering</a:documentation>
       </attribute>
     </optional>
-    <ref name="BlockAttributes"/>
+    <ref name="BlockAttributesCore"/>
   </define>
   <define name="SourceAttributes" combine="interleave">
     <ref name="BlockAttributes"/>
@@ -1277,7 +1283,11 @@ That concept may be defined as a term within the current document, or it may be
           <a:documentation>Class of input form</a:documentation>
         </attribute>
       </optional>
-      <ref name="BlockAttributes"/>
+      <ref name="BlockAttributesCore">
+        <a:documentation>form declares its own class above, so it uses BlockAttributesCore to
+avoid duplicating the custom-class slot in BlockAttributes. Treated like
+figure. See metanorma/metanorma-standoc#1197</a:documentation>
+      </ref>
       <zeroOrMore>
         <!-- Input form contents -->
         <choice>
@@ -2762,7 +2772,11 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
       </oneOrMore>
     </element>
   </define>
-  <define name="BlockAttributes">
+  <define name="BlockAttributesCore">
+    <a:documentation>Block attributes excluding the custom CSS class. Blocks that already carry
+their own `class` attribute (e.g. figure, via basicdoc FigureAttributes)
+include this directly, to avoid a duplicate-attribute collision with the
+`class` added in BlockAttributes. See metanorma/metanorma-standoc#1197</a:documentation>
     <optional>
       <attribute name="keep-with-next">
         <a:documentation>Keep this block on the same page as the following block in paged media</a:documentation>
@@ -2794,6 +2808,17 @@ to span across both columns</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="BlockAttributes">
+    <a:documentation>Universal block attributes, including a custom CSS class (space-separated,
+appended additively to the block's built-in HTML class, HTML output only).
+See metanorma/metanorma-standoc#1197</a:documentation>
+    <ref name="BlockAttributesCore"/>
+    <optional>
+      <attribute name="class">
+        <a:documentation>Custom CSS class(es) for the block in HTML output</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="DisplayDirective">
     <a:documentation>Directive on how to render a block in Presentation XML </a:documentation>
     <optional>