metanorma-standoc 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe69b54cc4d7ab2744446c02c80d3e4bcfd5af8b098ab4f709f71269bfeed28e
-  data.tar.gz: d16ff11d49036801eb8d7a14b277d6d57b6079435682f4b4a07bf5b0140702d7
+  metadata.gz: 0b781bd30313479321cf23297d77787c8500bda06c74a76028853f9b28d30510
+  data.tar.gz: bbdf82ad80d7a6b9f1f21582d7ab6eeb58b365d4aea706a49046d74b4e6309ad
 SHA512:
-  metadata.gz: f6f68dceb7b3ab96e34b1b09f91b616b2b53e627ee6383cab0246ca1d429b975dee17f90118bae28a60ece153310c0fb78697c1ea863731c965d556b81fcab0f
-  data.tar.gz: 2613d30ba2e9bef9812787c5fc247205ca2c14929e5f50ba83138049c9cae7c1f0835bcc104127016516db61dc1477c911fb55f8161b9271c18251290f5684e2
+  metadata.gz: 398ae3eaa49e8d22a4612adecf703cc4d3d7ae1b4a056f29289e5e9517be690253a1fadabf67ef1d030763992c5d97b405cc8296275df5a98eb5fc40386b93da
+  data.tar.gz: 994a1d4820b1a68e2768ca5c189788f89a7487c1e9dd63f09178aed9c1dfd558f416a1c8521834c5e8d39b294f9a488a61778f3490e5e3aad04b10d7b5bcc386

data/README.adoc

@@ -2,7 +2,7 @@
 
 image:https://img.shields.io/gem/v/metanorma-standoc.svg["Gem Version", link="https://rubygems.org/gems/metanorma-standoc"]
 image:https://github.com/metanorma/metanorma-standoc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-standoc/actions?workflow=rake"]
-image:https://codeclimate.com/github/metanorma/metanorma-standoc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-standoc"]
+// image:https://codeclimate.com/github/metanorma/metanorma-standoc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-standoc"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-standoc.svg["Pull Requests", link="https://github.com/metanorma/metanorma-standoc/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-standoc/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-standoc/releases"]
 

data/lib/metanorma/standoc/base.rb

@@ -139,7 +139,7 @@ module Metanorma
           %w(presentation semantic).each do |t|
             /^#{t}-metadata-/.match?(k) or next
             k = k.sub(/^#{t}-metadata-/, "")
-            quoted_csv_split(v)&.each do |c|
+            quoted_csv_split(v.gsub("&#", "&#"))&.each do |c|
               ret << "<#{t}-metadata><#{k}>#{c}</#{k}></#{t}-metadata>"
             end
           end

data/lib/metanorma/standoc/basicdoc.rng

@@ -1291,13 +1291,13 @@ Restricted recursively to contain only other such inline elements with no identi
       <ref name="pure_strike"/>
       <ref name="pure_smallcap"/>
       <ref name="br"/>
+      <ref name="stem"/>
     </choice>
   </define>
   <define name="NestedTextElement">
     <a:documentation>Contents of TextElement tags: leaves out tags that should occur only at top level of block: bookmark image hr pagebreak</a:documentation>
     <choice>
       <ref name="PureTextElement"/>
-      <ref name="stem"/>
       <ref name="eref"/>
       <ref name="xref"/>
       <ref name="hyperlink"/>

data/lib/metanorma/standoc/blocks.rb

@@ -161,12 +161,15 @@ module Metanorma
                  type: node.attr("type"))))
       end
 
-      # term sources occasionally turning up as "source source"?
+      # TODO: term sources occasionally turning up as "source source"?
       def paragraph(node)
         node.role&.sub(/ .*$/, "") == "source" and return termsource(node)
+        content = node.content
+        content.start_with?("TODO: ") and return todo_prefixed_para(node)
+        content.start_with?("EDITOR: ") and return editor_prefixed_para(node)
         noko do |xml|
           xml.p **para_attrs(node) do |xml_t|
-            xml_t << node.content
+            xml_t << content
           end
         end
       end

data/lib/metanorma/standoc/blocks_notes.rb

@@ -46,6 +46,20 @@ module Metanorma
         end
       end
 
+      # -TO-DO :
+      def todo_prefixed_para(node)
+        node.lines[0].sub!(/^TODO: /, "")
+        todo(node)
+      end
+
+      # EDITOR:
+      def editor_prefixed_para(node)
+        node.lines[0].sub!(/^EDITOR: /, "")
+        node.set_attr("type", "editorial")
+        node.assign_caption "EDITOR"
+        admonition(node)
+      end
+
       def termnote(node)
         noko do |xml|
           xml.termnote **termnote_attrs(node) do |ex|

data/lib/metanorma/standoc/cleanup_bibitem.rb

@@ -6,6 +6,9 @@ module Metanorma
           ret = new_bibitem_from_formattedref_spans(b)
           merge_bibitem_from_formattedref_spans(b, ret)
         end
+        xmldoc.xpath("//bibitem[@amend]").each do |b|
+          b.delete("amend")
+        end
       end
 
       def new_bibitem_from_formattedref_spans(bib)
@@ -18,9 +21,12 @@ module Metanorma
 
       def merge_bibitem_from_formattedref_spans(bib, new)
         new["type"] and bib["type"] = new["type"]
-        if bib.at("./title") # there already is a fetched record here: merge
+        if bib.at("./title") && bib["amend"]
+          # there already is a fetched record here: merge
           bib.children = MergeBibitems
             .new(bib.to_xml, new.to_xml).merge.to_noko.children
+        elsif bib.at("./title") # replace record
+          bib.children = new.children.to_xml
         else bib << new.children.to_xml
         end
       end

data/lib/metanorma/standoc/cleanup_maths.rb

@@ -179,6 +179,7 @@ module Metanorma
       end
 
       def mathml_cleanup(xmldoc)
+        mathml_number_to_mathml(xmldoc)
         xmldoc.xpath("//stem[@type = 'MathML'][not(@validate = 'false')]")
           .each do |x|
           mathml_xml_cleanup(x)
@@ -189,6 +190,15 @@ module Metanorma
         mathml_unitsml(xmldoc)
       end
 
+      def mathml_number_to_mathml(xmldoc)
+        xmldoc.xpath("//mathml-number").each do |n|
+          n.name = "stem"
+          n["type"] = "MathML"
+          n.children =
+            "<math xmlns='#{MATHML_NS}'><mn>#{n.children.to_xml}</mn></math>"
+        end
+      end
+
       include ::Metanorma::Standoc::Regex
     end
   end

data/lib/metanorma/standoc/converter.rb

@@ -80,8 +80,6 @@ module Metanorma
         inline_macro Metanorma::Standoc::SourceIncludeInlineMacro
         block Metanorma::Standoc::ToDoAdmonitionBlock
         block Metanorma::Standoc::EditorAdmonitionBlock
-        treeprocessor Metanorma::Standoc::EditorInlineAdmonitionBlock
-        treeprocessor Metanorma::Standoc::ToDoInlineAdmonitionBlock
         block Metanorma::Standoc::PlantUMLBlockMacro
         block Metanorma::Standoc::PseudocodeBlockMacro
         block_macro Metanorma::Standoc::ColumnBreakBlockMacro

data/lib/metanorma/standoc/isodoc.rng

@@ -42,36 +42,6 @@ All IdRefType instances point not to `@id` in Semantic XML, which is the Content
 but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <text/>
     </define>
-    <define name="index-primary">
-      <element name="primary">
-        <oneOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </oneOrMore>
-      </element>
-    </define>
-    <define name="index-secondary">
-      <element name="secondary">
-        <oneOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </oneOrMore>
-      </element>
-    </define>
-    <define name="index-tertiary">
-      <element name="tertiary">
-        <oneOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </oneOrMore>
-      </element>
-    </define>
     <define name="review">
       <a:documentation>Generalise BasicDoc element from just review comments, to general annotations;
 the type attribute defaults to `review` for reviews</a:documentation>
@@ -592,28 +562,6 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </element>
     </define>
-    <define name="sub">
-      <a:documentation>Subscript text. Corresponds to HTML `sub</a:documentation>
-      <element name="sub">
-        <zeroOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </zeroOrMore>
-      </element>
-    </define>
-    <define name="sup">
-      <a:documentation>Superscript text. Corresponds to HTML `sup`</a:documentation>
-      <element name="sup">
-        <zeroOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </zeroOrMore>
-      </element>
-    </define>
     <define name="pagebreak">
       <a:documentation>Page break. Only applicable in paged layouts (e.g. PDF, Word), and not flow layouts (e.g. HTML)</a:documentation>
       <element name="pagebreak">
@@ -1094,7 +1042,6 @@ That concept may be defined as a term within the current document, or it may be
           <zeroOrMore>
             <choice>
               <ref name="PureTextElement"/>
-              <ref name="stem"/>
               <ref name="index"/>
               <ref name="index-xref"/>
             </choice>
@@ -1107,7 +1054,6 @@ That concept may be defined as a term within the current document, or it may be
           <zeroOrMore>
             <choice>
               <ref name="PureTextElement"/>
-              <ref name="stem"/>
               <ref name="index"/>
               <ref name="index-xref"/>
             </choice>
@@ -2025,10 +1971,7 @@ used in document amendments</a:documentation>
       <element name="name">
         <a:documentation>The symbolic form of the designation</a:documentation>
         <oneOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
+          <ref name="PureTextElement"/>
         </oneOrMore>
       </element>
     </element>
@@ -2081,7 +2024,6 @@ used in document amendments</a:documentation>
         <zeroOrMore>
           <choice>
             <ref name="PureTextElement"/>
-            <ref name="stem"/>
             <ref name="index"/>
             <ref name="index-xref"/>
           </choice>

data/lib/metanorma/standoc/macros_inline.rb

@@ -233,9 +233,7 @@ module Metanorma
         fmt = format(out, target)
         fmt.empty? and fmt = "default"
         fmt = %( number-format="#{fmt}")
-        <<~OUTPUT.strip
-          <stem type="MathML"#{fmt}><math xmlns='#{MATHML_NS}'><mn>#{number(target)}</mn></math></stem>
-        OUTPUT
+        "<mathml-number#{fmt}>#{number(target)}</mathml-number>"
       end
     end
   end

data/lib/metanorma/standoc/macros_note.rb

@@ -14,20 +14,6 @@ module Metanorma
       end
     end
 
-    class ToDoInlineAdmonitionBlock < Asciidoctor::Extensions::Treeprocessor
-      def process(document)
-        (document.find_by context: :paragraph).each do |para|
-          next unless /^TODO: /.match? para.lines[0]
-
-          para.set_attr("name", "todo")
-          para.set_attr("caption", "TODO")
-          para.lines[0].sub!(/^TODO: /, "")
-          # these will be converted from admonition to annotation downstream
-          para.context = :admonition
-        end
-      end
-    end
-
     class FootnoteBlockInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :footnoteblock

data/lib/metanorma/standoc/ref.rb

@@ -130,10 +130,7 @@ module Metanorma
       end
 
       def refitem_render(xml, match, code)
-        xml.bibitem **attr_code(
-          anchor: match[:anchor], suppress_identifier: code[:dropid],
-          hidden: code[:hidden], id: "_#{UUIDTools::UUID.random_create}"
-        ) do |t|
+        xml.bibitem **refitem_render_attrs(match, code) do |t|
           refitem_render_formattedref(t, match[:text])
           yr_match = refitem1yr(code[:id])
           refitem_render1(match, code, t)
@@ -143,6 +140,12 @@ module Metanorma
         end
       end
 
+      def refitem_render_attrs(match, code)
+        attr_code(anchor: match[:anchor], suppress_identifier: code[:dropid],
+                  amend: code[:amend], hidden: code[:hidden],
+                  id: "_#{UUIDTools::UUID.random_create}")
+      end
+
       def refitem_render_formattedref(bibitem, title)
         (title.nil? || title.empty?) and title = @i18n.no_information_available
         bibitem.formattedref format: "application/x-isodoc+xml" do |i|

data/lib/metanorma/standoc/ref_queue.rb

@@ -42,8 +42,9 @@ module Metanorma
           ref, i, doc = results.pop
           m[i.to_i] = { ref: }
           if doc.is_a?(RelatonBib::RequestError)
-            @log.add("Bibliography", nil, "Could not retrieve #{ref[:code]}: " \
-                                          "no access to online site", severity: 1)
+            @log.add("Bibliography", nil,
+                     "Could not retrieve #{ref[:code]}: " \
+                     "no access to online site", severity: 1)
           else m[i.to_i][:doc] = doc end
         end
       end
@@ -206,6 +207,7 @@ module Metanorma
         xml.parent.add_child(smart_render_xml(item[:doc], item[:ref][:code],
                                               item[:ref]))
         use_my_anchor(xml, item[:ref][:match][:anchor],
+                      amend: item.dig(:ref, :analyse_code, :amend),
                       hidden: item.dig(:ref, :analyse_code, :hidden),
                       dropid: item.dig(:ref, :analyse_code, :dropid))
       end

data/lib/metanorma/standoc/ref_utility.rb

@@ -32,11 +32,12 @@ module Metanorma
       end
 
       def use_my_anchor(ref, id, opt)
-        ref.parent.elements.last["anchor"] = id
-        add_id(ref.parent.elements.last)
-        a = opt[:hidden] and ref.parent.elements.last["hidden"] = a
-        a = opt[:dropid] and
-          ref.parent.elements.last["suppress_identifier"] = a
+        elem = ref.parent.elements.last
+        elem["anchor"] = id
+        add_id(elem)
+        a = opt[:hidden] and elem["hidden"] = a
+        a = opt[:amend] and elem["amend"] = a
+        a = opt[:dropid] and elem["suppress_identifier"] = a
         ref
       end
 
@@ -66,40 +67,20 @@ module Metanorma
           .sub(/^hidden\((.+)\)$/, "\\1")
           .sub(/^nofetch\((.+)\)$/, "\\1")
           .sub(/^local-file\((.+)\)$/, "\\1")
-      end
-
-      def analyse_ref_localfile(ret)
-        m = /^local-file\((?:(?<source>[^,)]+),\s*)?(?<id>[^)]+)\)$/
-          .match(ret[:id])
-        m or return ret
-        ret.merge(id: m[:id], localfile: m[:source] || "default")
-      end
-
-      def analyse_ref_nofetch(ret)
-        m = /^nofetch\((?<id>.+)\)$/.match(ret[:id]) or return ret
-        ret.merge(id: m[:id], nofetch: true)
-      end
-
-      def analyse_ref_hidden(ret)
-        m = /^hidden\((?<id>.+)\)$/.match(ret[:id]) or return ret
-        ret.merge(id: m[:id], hidden: true)
-      end
-
-      def analyse_ref_dropid(ret)
-        m = /^dropid\((?<id>.+)\)$/.match(ret[:id]) or return ret
-        ret.merge(id: m[:id], dropid: true)
+          .sub(/^amend\((.+)\)$/, "\\1")
       end
 
       def analyse_ref_repo_path(ret)
-        m = /^(?<type>repo|path|attachment):\((?<key>[^,)]+),?(?<id>[^)]*)\)$/
-          .match(ret[:id]) or return ret
-        id = if m[:id].empty?
-               if m[:type] == "attachment"
-                 "(#{m[:key]})"
-               else m[:key].sub(%r{^[^/]+/}, "")
-               end
-             else m[:id] end
-        ret.merge(id:, type: m[:type], key: m[:key], nofetch: true)
+        %i(repo path attachment).each do |type|
+          ret[type] or next
+          id = if ret[:id].empty?
+                 if type == :attachment then "(#{ret[type]})"
+                 else ret[type].sub(%r{^[^/]+/}, "")
+                 end
+               else ret[:id] end
+          ret.merge!(id: id, type: type.to_s, key: ret[type], nofetch: true)
+        end
+        ret
       end
 
       def analyse_ref_numeric(ret)
@@ -107,16 +88,6 @@ module Metanorma
         ret.merge(numeric: true)
       end
 
-      def analyse_ref_dual(ret)
-        m = /^(?<type>merge|dual)\((?<keys>.+)\)$/.match(ret[:id]) or
-          return ret
-        line = CSV.parse_line(m[:keys], liberal_parsing: true) or return ret
-        line.size > 1 or return ret
-        ret[:id] = line.first
-        ret[m[:type].to_sym] = line[1..].map(&:strip)
-        ret
-      end
-
       def analyse_ref_code(code)
         ret = { id: code }
         code.nil? || code.empty? and return ret
@@ -166,23 +137,49 @@ module Metanorma
         end
       end
 
+      def analyse_ref_code_nested(ret)
+        opts, id = parse_ref_code_nested({}, ret[:id])
+        ret[:id] = id
+        ret.merge!(opts)
+        analyse_ref_numeric(ret)
+        analyse_ref_repo_path(ret)
+        ret
+      end
+
       # ref id = (usrlbl)code[:-]year
       # code = \[? number \]? | ident | nofetch(code) | hidden(code) |
-      # dropid(code) | # (repo|path|attachment):(key,code) |
+      # dropid(code) | amend(code) | (repo|path|attachment):(key,code) |
       # local-file(source,? key) |
       # merge(code, code) | dual(code, code)
-      def analyse_ref_code_nested(ret)
-        analyse_ref_dual(
-          analyse_ref_numeric(
-            analyse_ref_repo_path(
-              analyse_ref_dropid(
-                analyse_ref_hidden(
-                  analyse_ref_nofetch(analyse_ref_localfile(ret)),
-                ),
-              ),
-            ),
-          ),
-        )
+      def parse_ref_code_nested(ret, ident)
+        keys = %w(nofetch hidden dropid local-file repo path attachment merge
+                  dual amend)
+        if (m = /^(?<key>[a-z-]+):?\((?<val>.*)\)$/.match(ident)) &&
+            keys.include?(m[:key])
+          case m[:key]
+          when "nofetch", "hidden", "dropid", "amend"
+            ret[m[:key].to_sym] = true
+            parse_ref_code_nested(ret, m[:val])
+          when "repo", "path", "attachment"
+            kv = m[:val].split(",", 2).map(&:strip)
+            ret[m[:key].to_sym] = kv[0]
+            parse_ref_code_nested(ret, kv.size == 1 ? "" : kv[1])
+          when "local-file"
+            kv = m[:val].split(",", 2).map(&:strip)
+            source = kv.size == 1 ? "default" : kv[0]
+            ret[:localfile] = source
+            parse_ref_code_nested(ret, kv[-1])
+          when "merge", "dual"
+            line = CSV.parse_line(m[:val],
+                                  liberal_parsing: true) or return [ret, ident]
+            line.size > 1 or return [ret, ident]
+            ret[:id] = line.first
+            ret[m[:key].to_sym] = line[1..].map(&:strip)
+            [ret, ret[:id]]
+          end
+
+        else [ret, ident]
+        end
       end
 
       # if no year is supplied, interpret as no_year reference

data/lib/metanorma/standoc/utils.rb

@@ -87,8 +87,10 @@ module Metanorma
         conv = presentation_xml_converter(EmptyAttr.new)
         i18n = conv.i18n_init(lang, script, locale, i18nyaml)
         conv.metadata_init(lang, script, locale, i18n)
+        conv.meta.localdir = @localdir
         conv.xref_init(lang, script, nil, i18n, {})
         conv.xrefs.klass.meta = conv.meta
+        conv.xrefs.klass.localdir = @localdir
         conv
       end
 

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.1.2".freeze
+    VERSION = "3.1.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -57,6 +57,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "xml-c14n"
+  spec.add_development_dependency "canon"
   # spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -389,7 +389,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: xml-c14n
+  name: canon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="