metanorma-standoc 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c1ea7078b1b5abbb7f7db93972c6efd1d55e076faa631ae25e351dd5ce48fb5
-  data.tar.gz: 509b11d44c11d9facc4985bcff19b0333d863585af462fef0fdca80017235881
+  metadata.gz: d0a69974476cfd73fd74d1072ae10647b54c1c9f55d3cfb3d3cf9151a3f8be12
+  data.tar.gz: ed1cb04fdc539fafe18e87c4f7b173e9394644425b3791fa56bca4eb6935cd48
 SHA512:
-  metadata.gz: 5936e1fb18c00b4bb9201f77b7bc26c0ec213163710bbe542c659237abc2f9209209a2fa2445fd5fb9e8dc81f3dc7b8b84c7ff38ff2c4caa20ca6f75967a5e1d
-  data.tar.gz: e70ccf305e69b6af130afb0d903bfb509df06c659ed96d961a4204f22e7a265a64da19b1dd23336c434ac3df300028edb04e8175a2fa81876c25b678888b1960
+  metadata.gz: 2a2306e053d66020cfc017e973c30770eb00db604e12bcdccfdccd303fe2b8ddc2c87d7783067665b666e1db49c6c11044a29ae8420b5d72793c5363a9524d04
+  data.tar.gz: eda982b66f7f780b1d8ef7a7d48d5063154446792a5e5f50e5e3bd1470036896bba1d6f8060858a498f01d55a06c4d9f2b4c87fe8cbb67aec2bb1b6fffeee699

data/lib/metanorma/standoc/blocks_notes.rb

@@ -14,36 +14,33 @@ module Metanorma
           .merge(type: node.attr("type"))))
       end
 
-      def sidebar_attrs(node)
-        todo_attrs(node).merge(
-          attr_code(
-            from: node.attr("from"),
-            to: node.attr("to") || node.attr("from"),
-            type: node.attr("type") || nil,
-          ),
-        )
-      end
-
       def sidebar(node)
         noko do |xml|
-          xml.review **sidebar_attrs(node) do |r|
+          xml.annotation **sidebar_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
       end
 
-      def todo_attrs(node)
+      def sidebar_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
         date += "T00:00:00Z" unless date.include?("T")
         attr_code(id_attr(node)
           .merge(reviewer: node.attr("reviewer") || node.attr("source") ||
                  "(Unknown)",
-                 date:, type: "todo"))
+                 from: node.attr("from"),
+                 to: node.attr("to") || node.attr("from"),
+                 type: node.attr("type") || "review",
+                 date:))
+      end
+
+      def todo_attrs(node)
+        sidebar_attrs(node).merge(type: "todo")
       end
 
       def todo(node)
         noko do |xml|
-          xml.review **todo_attrs(node) do |r|
+          xml.annotation **todo_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end

data/lib/metanorma/standoc/cleanup.rb

@@ -160,33 +160,41 @@ module Metanorma
 
       def variant_cleanup(xmldoc)
         variant_space_cleanup(xmldoc)
-        xmldoc.xpath("//*[variant]").each do |c|
-          next unless c.children.any? do |n|
-            n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
+        xmldoc.xpath("//*[lang-variant]").each do |c|
+          if only_langvariant_children?(c)
+            duplicate_langvariants(c, c.xpath("./lang-variant"))
+          else
+            c.xpath(".//lang-variant").each { |x| x.name = "span" }
           end
+        end
+      end
 
-          variant_cleanup1(c)
+      def only_langvariant_children?(node)
+        node.children.none? do |n|
+          n.name != "lang-variant" && (!n.text? || !n.text.strip.empty?)
         end
-        xmldoc.xpath("//variantwrap").each { |n| n.name = "variant" }
       end
 
-      def variant_cleanup1(elem)
-        elem.xpath("./variant").each do |n|
-          if n.at_xpath("preceding-sibling::node()" \
-                        "[not(self::text()[not(normalize-space())])][1]" \
-                        "[self::variantwrap]")
-            n.previous_element << n
-          else
-            n.replace("<variantwrap/>").first << n
-          end
+      def duplicate_langvariants(container, variants)
+        lang_variant_to_node(variants.first, container)
+        variants[1..].reverse.each do |node|
+          new = container.dup
+          lang_variant_to_node(node, new)
+          container.next = new
         end
       end
 
-      def variant_space_cleanup(xmldoc)
-        xmldoc.xpath("//*[variant]").each do |c|
-          next if c.next.nil? || c.next.next.nil?
+      def lang_variant_to_node(variant, node)
+        node.children = variant.children
+        node["lang"] = variant["lang"]
+        node.delete("script")
+        variant["script"] and node["script"] = variant["script"]
+      end
 
-          if c.next.text? && c.next.next.name == "variant"
+      def variant_space_cleanup(xmldoc)
+        xmldoc.xpath("//*[lang-variant]").each do |c|
+          c.next.nil? || c.next.next.nil? and next
+          if c.next.text? && c.next.next.name == "lang-variant"
             c.next.text.gsub(/\s/, "").empty? and
               c.next.remove
           end

data/lib/metanorma/standoc/cleanup_block.rb

@@ -121,7 +121,7 @@ module Metanorma
       def align_callouts_to_annotations(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
           callouts = x.xpath("./body/callout")
-          annotations = x.xpath("./annotation")
+          annotations = x.xpath("./callout-annotation")
           callouts.size == annotations.size and
             link_callouts_to_annotations(callouts, annotations)
         end
@@ -129,7 +129,7 @@ module Metanorma
 
       def merge_annotations_into_sourcecode(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
-          while x.next_element&.name == "annotation"
+          while x.next_element&.name == "callout-annotation"
             x.next_element.parent = x
           end
         end

data/lib/metanorma/standoc/cleanup_review.rb

@@ -2,9 +2,9 @@ module Metanorma
   module Standoc
     module Cleanup
       def review_cleanup(xmldoc)
-        reviews = xmldoc.xpath("//review")
+        reviews = xmldoc.xpath("//annotation")
         reviews.empty? and return
-        ctr = xmldoc.root.add_child("<review-container/>").first
+        ctr = xmldoc.root.add_child("<annotation-container/>").first
         reviews.each do |r|
           review_set_location(r)
           ctr << r

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -123,28 +123,28 @@ module Metanorma
           end
       end
 
-      def terms_subclause_type_tally(node, m, parent)
-        sym = if (node.at(".//term") && !node.at(".//definitions")) ||
-            (node.name == "terms" && !node.at(".//term"))
-                unless m[:parent] == :term # don't count Term > Term twice
+      def terms_subclause_type_tally(node, acc, parent)
+        hasterm = node.at(".//term")
+        sym = if (hasterm && !node.at(".//definitions")) ||
+            (node.name == "terms" && !hasterm)
+                unless acc[:parent] == :term # don't count Term > Term twice
                   :term
                 end
-              elsif node.at(".//term") && node.at("./self::*#{SYMnoABBR}") then :tsna
-              elsif node.at(".//term") && node.at("./self::*#{ABBRnoSYM}") then :tans
-              elsif node.at(".//term") && node.at("./self::*#{SYMABBR}") then :tsa
-              elsif node.at(".//term") && node.at("./self::*#{NO_SYMABBR}") then :tnsa
+              elsif hasterm && node.at("./self::*#{SYMnoABBR}") then :tsna
+              elsif hasterm && node.at("./self::*#{ABBRnoSYM}") then :tans
+              elsif hasterm && node.at("./self::*#{SYMABBR}") then :tsa
+              elsif hasterm && node.at("./self::*#{NO_SYMABBR}") then :tnsa
               elsif node.at("./self::*#{SYMnoABBR}") then :sna
               elsif node.at("./self::*#{ABBRnoSYM}") then :ans
               elsif node.at("./self::*#{SYMABBR}") then :sa
               elsif node.at("./self::*#{NO_SYMABBR}") then :nsa
               elsif node.name == "definitions" # ignore
-              elsif node == parent && node.at(".//term") &&
-                  node.at(".//definitions")
+              elsif node == parent && hasterm && node.at(".//definitions")
                 :termdef
               else :other
               end
-        node == parent and m[:parent] = sym
-        sym and m[sym] += 1
+        node == parent and acc[:parent] = sym
+        sym and acc[sym] += 1
       end
 
       def sections_variant_title_cleanup(xml)

data/lib/metanorma/standoc/cleanup_text.rb

@@ -107,7 +107,7 @@ module Metanorma
         %w(pre sourcecode passthrough metanorma-extension stem).freeze
 
       STRIP_LINEBREAK_ELEMENTS =
-        %w(title name variant-title figure example review admonition
+        %w(title name variant-title figure example annotation admonition
            note li th td dt dd p quote label annotation
            preferred admitted related deprecates field-of-application
            usage-info expression pronunciation grammar-value domain
@@ -146,8 +146,8 @@ module Metanorma
            quote label abstract preferred admitted related deprecates
            field-of-application usage-info expression pronunciation
            grammar-value domain definition termnote termexample modification
-           description newcontent floating-title tab review admonition
-           annotation).include? elem.name
+           description newcontent floating-title tab annotation admonition
+           callout-annotation).include? elem.name
       end
 
       def empty_tag_with_text_content?(elem)

data/lib/metanorma/standoc/converter.rb

@@ -56,7 +56,7 @@ module Metanorma
         inline_macro Metanorma::Standoc::IdentifierInlineMacro
         inline_macro Metanorma::Standoc::ConceptInlineMacro
         inline_macro Metanorma::Standoc::AutonumberInlineMacro
-        inline_macro Metanorma::Standoc::VariantInlineMacro
+        inline_macro Metanorma::Standoc::LangVariantInlineMacro
         inline_macro Metanorma::Standoc::FootnoteBlockInlineMacro
         inline_macro Metanorma::Standoc::TermRefInlineMacro
         inline_macro Metanorma::Standoc::SymbolRefInlineMacro

data/lib/metanorma/standoc/front_organisation.rb

@@ -115,7 +115,7 @@ module Metanorma
 
       def org_logo(xml, logo)
         logo and xml.logo do |l|
-          l.image src: logo
+          l.image src: logo, mimetype: image_mimetype(logo)
         end
       end
 

data/lib/metanorma/standoc/inline.rb

@@ -134,29 +134,40 @@ module Metanorma
         end
       end
 
+      def image_mimetype(uri)
+        types = if /^data:/.match?(uri) then Vectory::Utils::datauri2mime(uri)
+                else MIME::Types.type_for(uri)
+                end
+        types.first.to_s
+      end
+
       def image_attributes(node)
+        sourceuri = image_src_uri(node)
+        uri = sourceuri
+        type = image_mimetype(uri)
+        uri = uri.sub(%r{^data:image/\*;}, "data:#{type};")
+        image_attributes1(node, uri, sourceuri, type)
+      end
+
+      def image_src_uri(node)
         nodetarget = node.attr("target") || node.target
         if Gem.win_platform? && /^[a-zA-Z]:/.match?(nodetarget)
           nodetarget.prepend("/")
         end
-        uri = node.image_uri (nodetarget)
+        uri = node.image_uri(nodetarget)
         if Gem.win_platform? && /^\/[a-zA-Z]:/.match?(uri)
           uri = uri[1..]
         end
-        types = if /^data:/.match?(uri) then Vectory::Utils::datauri2mime(uri)
-                else MIME::Types.type_for(uri)
-                end
-        type = types.first.to_s
-        uri = uri.sub(%r{^data:image/\*;}, "data:#{type};")
-        image_attributes1(node, uri, type)
+        uri
       end
 
-      def image_attributes1(node, uri, type)
+      def image_attributes1(node, uri, sourceuri, type)
+        /^data:/.match?(sourceuri) and sourceuri = nil
         attr_code(id_attr(node)
           .merge(src: uri, mimetype: type,
                  height: node.attr("height") || "auto",
                  width: node.attr("width") || "auto",
-                 filename: node.attr("filename"),
+                 filename: node.attr("filename") || sourceuri,
                  title: node.attr("titleattr"),
                  alt: node.alt == node.attr("default-alt") ? nil : node.alt))
       end

data/lib/metanorma/standoc/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.7 -->
+<!-- VERSION v2.0.8 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -72,6 +72,46 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
         </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>
+      <element name="annotation">
+        <ref name="RequiredId"/>
+        <ref name="ReviewAttributes"/>
+        <oneOrMore>
+          <ref name="paragraph">
+            <a:documentation>Reviewer comments content</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="ruby_pronunciation">
+      <a:documentation>Ruby annotation giving pronunciation of text: change tag from BasicDoc for disambiguation</a:documentation>
+      <element name="ruby-pronunciation">
+        <attribute name="value">
+          <a:documentation>Ruby annotation value</a:documentation>
+        </attribute>
+        <ref name="LocalizedStringAttributes"/>
+      </element>
+    </define>
+    <define name="ruby_annotation">
+      <a:documentation>Ruby annotation giving information other than pronunciation of text: change tag from BasicDoc for disambiguation</a:documentation>
+      <element name="ruby-annotation">
+        <attribute name="value">
+          <a:documentation>Ruby annotation value</a:documentation>
+        </attribute>
+        <ref name="LocalizedStringAttributes"/>
+      </element>
+    </define>
+    <define name="annotation">
+      <a:documentation>Source code annotation, corresponding to a callout</a:documentation>
+      <element name="callout-annotation">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="paragraph"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="section-title">
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
@@ -540,7 +580,7 @@ normative or informative references, some split references into sections organiz
       <ref name="OptionalId"/>
       <optional>
         <attribute name="style">
-          <a:documentation>CSS style: only background-color supported</a:documentation>
+          <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
         </attribute>
       </optional>
     </define>
@@ -620,7 +660,7 @@ This is done if the footnote reference is already presented in some other form,
     <ref name="RequiredId"/>
     <optional>
       <attribute name="style">
-        <a:documentation>CSS style: only background-color supported</a:documentation>
+        <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
       </attribute>
     </optional>
   </define>
@@ -700,6 +740,11 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the table block in rendering</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
+      </attribute>
+    </optional>
     <ref name="BlockAttributes"/>
   </define>
   <define name="FigureAttributes" combine="interleave">
@@ -1417,7 +1462,7 @@ numbers</a:documentation>
       </optional>
       <ref name="DocumentBody"/>
       <optional>
-        <ref name="review-container">
+        <ref name="annotation-container">
           <a:documentation>Annotations to the document</a:documentation>
         </ref>
       </optional>
@@ -1461,8 +1506,8 @@ numbers</a:documentation>
       </oneOrMore>
     </element>
   </define>
-  <define name="review-container">
-    <element name="review-container">
+  <define name="annotation-container">
+    <element name="annotation-container">
       <oneOrMore>
         <ref name="review"/>
       </oneOrMore>

data/lib/metanorma/standoc/lists.rb

@@ -59,6 +59,7 @@ module Metanorma
       def ol_attrs(node)
         attr_code(id_attr(node).merge(keep_attrs(node)
           .merge(type: olist_style(node.style),
+                 start: node.attr("start"),
                  "explicit-type": olist_style(node.attributes[1]))))
       end
 
@@ -114,7 +115,7 @@ module Metanorma
       def colist(node)
         noko do |xml|
           node.items.each_with_index do |item, i|
-            xml.annotation **attr_code(id: i + 1) do |xml_li|
+            xml.callout_annotation **attr_code(id: i + 1) do |xml_li|
               xml_li.p { |p| p << item.text }
             end
           end

data/lib/metanorma/standoc/macros.rb

@@ -221,14 +221,17 @@ module Metanorma
       # pass:[A] => pass-format:metanorma[++A++],
       # so long as A doesn't already start with ++
       # ditto pass-format:[A] => pass-format:[++A++]
+      # convert any \] in the ++...++ body to ]
       def pass_convert(text)
         text
-          .gsub(/pass-format:([^\[ ]*)\[(?!\+\+)(.+?)(?<!\\)\]/,
-                "pass-format:\\1[++\\2++]")
+          .gsub(/pass-format:([^\[ ]*)\[(?!\+\+)(.+?)(?<!\\)\]/) do |_m|
+          "pass-format:#{$1}[++#{$2.gsub(/\\\]/, ']')}++]"
+        end
           .gsub(/pass:\[(?=\+\+)(.+?)(?<!\\)\]/,
                 "pass-format:metanorma[\\1]")
-          .gsub(/pass:\[(?!\+\+)(.+?)(?<!\\)\]/,
-                "pass-format:metanorma[++\\1++]")
+          .gsub(/pass:\[(?!\+\+)(.+?)(?<!\\)\]/) do |_m|
+          "pass-format:metanorma[++#{$1.gsub(/\\\]/, ']')}++]"
+        end
       end
 
       def inlinelink(text)

data/lib/metanorma/standoc/macros_inline.rb

@@ -43,7 +43,7 @@ module Metanorma
         attrs = " value='#{target}'"
         x = args[:lang] and attrs += " lang='#{x}'"
         x = args[:script] and attrs += " script='#{x}'"
-        "<ruby><#{args[:type]} #{attrs}/>#{out}</ruby>"
+        "<ruby><ruby-#{args[:type]} #{attrs}/>#{out}</ruby>"
       end
     end
 
@@ -82,7 +82,7 @@ module Metanorma
       end
     end
 
-    class VariantInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class LangVariantInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :lang
       parse_content_as :text
@@ -91,9 +91,9 @@ module Metanorma
         /^(?<lang>[^-]*)(?:-(?<script>.*))?$/ =~ target
         out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
         if script
-          %{<variant lang='#{lang}' script='#{script}'>#{out}</variant>}
+          %{<lang-variant lang='#{lang}' script='#{script}'>#{out}</lang-variant>}
         else
-          %{<variant lang='#{lang}'>#{out}</variant>}
+          %{<lang-variant lang='#{lang}'>#{out}</lang-variant>}
         end
       end
     end

data/lib/metanorma/standoc/macros_note.rb

@@ -8,6 +8,7 @@ module Metanorma
       def process(parent, reader, attrs)
         attrs["name"] = "todo"
         attrs["caption"] = "TODO"
+        # these will be converted from admonition to annotation downstream
         create_block(parent, :admonition, reader.lines, attrs,
                      content_model: :compound)
       end
@@ -21,6 +22,7 @@ module Metanorma
           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

data/lib/metanorma/standoc/table.rb

@@ -6,6 +6,7 @@ module Metanorma
           .merge(id_unnum_attrs(node))
           .merge(headerrows: node.attr("headerrows"),
                  alt: node.attr("alt"),
+                 style: node.attr("css-style"),
                  summary: node.attr("summary"),
                  width: node.attr("width"))
       end

data/lib/metanorma/standoc/validate_section.rb

@@ -12,7 +12,7 @@ module Metanorma
       def sourcecode_style(root)
         root.xpath("//sourcecode").each do |x|
           callouts = x.xpath("./body/callout")
-          annotations = x.xpath("./annotation")
+          annotations = x.xpath("./callout-annotation")
           callouts_error(x, callouts, annotations)
         end
       end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.1.0".freeze
+    VERSION = "3.1.1".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "crass", "~> 1.0.0"
   spec.add_dependency "iev", "~> 0.3.5"
-  spec.add_dependency "isodoc", "~> 3.1.4"
+  spec.add_dependency "isodoc", "~> 3.2.0"
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.3"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.7.31"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement