metanorma-standoc 2.0.7 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e678173d52fd8197d0127f397b7f65349b72d26242d62c3cee8005e3057068b
-  data.tar.gz: 4a5548452c906db7df68ead74453f49d484fe601791a35aeb22360e9abb0b2ea
+  metadata.gz: 56e2b9105572c28858ffc12d075b16615ec8195836ad4bf7d7d2122fbf81dc05
+  data.tar.gz: 2594f703aeba2f78a5bf3df715709f78b3b6da1a751cb52fedd3ebce299eaf2d
 SHA512:
-  metadata.gz: 3b28ce6e459d29a0b457179ad2f97282ccf26109358ed8ab933d42e080d8ad1e4511d68c1470d16437c8dd71338ed8951f2a021335f135cf0d3d467d432e715a
-  data.tar.gz: d54fc63c669aa31fc728d35f3761c4a853d1ef345d9010988157550073ff2e38feb6ad123be562ee323219d812fa3f414da17102d0c462801bd31aa0be50405d
+  metadata.gz: eeef127fe3ea160b49aa62cbb1aa665fb4e0cdb6d1712f646667394a41633c89864a294900c444abc1fceb7fbe2649bdfb2f539d1ccc66d3df89cd247ea31655
+  data.tar.gz: 2d1ded28e889db67a42275a5890a8e942b2b966e342e7bb7bc2b21129875394dff03ce1c1cd634b409ce72a68de0e4fd4eff518731cb3b8809c70d5c0c5f0449

data/lib/metanorma/standoc/base.rb

@@ -171,7 +171,9 @@ module Metanorma
       end
 
       def doctype(node)
-        node.attr("doctype")&.gsub(/\s+/, "-")&.downcase
+        ret = node.attr("doctype")&.gsub(/\s+/, "-")&.downcase || "standard"
+        ret = "standard" if ret == "article"
+        ret
       end
 
       def front(node, xml)

data/lib/metanorma/standoc/biblio.rng

@@ -614,12 +614,12 @@
     <optional>
       <ref name="fetched"/>
     </optional>
-    <choice>
-      <oneOrMore>
-        <ref name="btitle"/>
-      </oneOrMore>
+    <optional>
       <ref name="formattedref"/>
-    </choice>
+    </optional>
+    <oneOrMore>
+      <ref name="btitle"/>
+    </oneOrMore>
     <zeroOrMore>
       <ref name="bsource"/>
     </zeroOrMore>
@@ -851,17 +851,46 @@
   </define>
   <define name="bplace">
     <element name="place">
-      <optional>
-        <attribute name="uri">
-          <data type="anyURI"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="region"/>
-      </optional>
+      <choice>
+        <text/>
+        <group>
+          <ref name="bibliocity"/>
+          <zeroOrMore>
+            <ref name="biblioregion"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="bibliocountry"/>
+          </zeroOrMore>
+        </group>
+      </choice>
+    </element>
+  </define>
+  <define name="bibliocity">
+    <element name="city">
       <text/>
     </element>
   </define>
+  <define name="biblioregion">
+    <element name="region">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="bibliocountry">
+    <element name="country">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="RegionType">
+    <optional>
+      <attribute name="iso"/>
+    </optional>
+    <optional>
+      <attribute name="recommended">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <text/>
+  </define>
   <define name="bprice">
     <element name="price">
       <attribute name="currency"/>
@@ -957,36 +986,34 @@
           <ref name="SeriesType"/>
         </attribute>
       </optional>
-      <choice>
+      <optional>
         <ref name="formattedref"/>
-        <group>
-          <ref name="btitle"/>
-          <optional>
-            <ref name="bplace"/>
-          </optional>
-          <optional>
-            <ref name="seriesorganization"/>
-          </optional>
-          <optional>
-            <ref name="abbreviation"/>
-          </optional>
-          <optional>
-            <ref name="seriesfrom"/>
-          </optional>
-          <optional>
-            <ref name="seriesto"/>
-          </optional>
-          <optional>
-            <ref name="seriesnumber"/>
-          </optional>
-          <optional>
-            <ref name="seriespartnumber"/>
-          </optional>
-          <optional>
-            <ref name="seriesrun"/>
-          </optional>
-        </group>
-      </choice>
+      </optional>
+      <ref name="btitle"/>
+      <optional>
+        <ref name="bplace"/>
+      </optional>
+      <optional>
+        <ref name="seriesorganization"/>
+      </optional>
+      <optional>
+        <ref name="abbreviation"/>
+      </optional>
+      <optional>
+        <ref name="seriesfrom"/>
+      </optional>
+      <optional>
+        <ref name="seriesto"/>
+      </optional>
+      <optional>
+        <ref name="seriesnumber"/>
+      </optional>
+      <optional>
+        <ref name="seriespartnumber"/>
+      </optional>
+      <optional>
+        <ref name="seriesrun"/>
+      </optional>
     </element>
   </define>
   <define name="SeriesType">

data/lib/metanorma/standoc/blocks.rb

@@ -80,14 +80,17 @@ module Metanorma
 
       def term_example(node)
         noko do |xml|
-          xml.termexample **attr_code(id_attr(node)) do |ex|
+          xml.termexample **attr_code(id_attr(node)
+            .merge(
+              keepasterm: node.option?("termexample") ? "true" : nil,
+            )) do |ex|
             wrap_in_para(node, ex)
           end
         end.join("\n")
       end
 
       def example(node)
-        return term_example(node) if in_terms?
+        return term_example(node) if in_terms? || node.option?("termexample")
 
         role = node.role || node.attr("style")
         %w(recommendation requirement permission).include?(role) and
@@ -237,10 +240,12 @@ module Metanorma
       end
 
       def pass(node)
+        c = HTMLEntities.new
         noko do |xml|
           xml.passthrough **attr_code(formats:
                                       node.attr("format") || "metanorma") do |p|
-            p << HTMLEntities.new.encode(node.content, :basic, :hexadecimal)
+            p << c.encode(c.decode(node.content),
+                          :basic, :hexadecimal)
           end
         end
       end

data/lib/metanorma/standoc/blocks_notes.rb

@@ -8,16 +8,13 @@ module Metanorma
             number: node.attr("number"),
             subsequence: node.attr("subsequence"),
             "keep-separate": node.attr("keep-separate"),
+            keepasterm: node.option?("termnote") ? "true" : nil,
           )))
       end
 
       def note_attrs(node)
-        attr_code(
-          termnote_attrs(node).merge(
-            type: node.attr("type"),
-            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
-          ),
-        )
+        attr_code(termnote_attrs(node).merge(admonition_core_attrs(node)
+          .merge(type: node.attr("type"))))
       end
 
       def sidebar_attrs(node)
@@ -65,6 +62,8 @@ module Metanorma
       end
 
       def note(node)
+        return termnote(node) if node.option?("termnote")
+
         noko do |xml|
           xml.note **note_attrs(node) do |c|
             wrap_in_para(node, c)
@@ -73,15 +72,25 @@ module Metanorma
       end
 
       def admonition_attrs(node)
+        attr_code(keep_attrs(node).merge(id_attr(node)
+          .merge(admonition_core_attrs(node)
+          .merge(type: admonition_name(node)))))
+      end
+
+      def admonition_core_attrs(node)
+        { notag: node.attr("notag") == "true" ? "true" : nil,
+          coverpage: node.attr("coverpage") == "true" ? "true" : nil,
+          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
+          unnumbered: node.attr("unnumbered") ||
+            (node.attr("notag") == "true") || nil }
+      end
+
+      def admonition_name(node)
         name = node.attr("name")
         a = node.attr("type") and ["danger", "safety precautions"].each do |t|
           name = t if a.casecmp(t).zero?
         end
-        attr_code(keep_attrs(node).merge(id_attr(node)
-          .merge(
-            type: name,
-            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
-          )))
+        name
       end
 
       def admonition(node)

data/lib/metanorma/standoc/cleanup.rb

@@ -25,6 +25,7 @@ module Metanorma
     module Cleanup
       def cleanup(xmldoc)
         element_name_cleanup(xmldoc)
+        passthrough_cleanup(xmldoc)
         sections_cleanup(xmldoc)
         obligations_cleanup(xmldoc)
         table_cleanup(xmldoc)

data/lib/metanorma/standoc/cleanup_block.rb

@@ -73,11 +73,21 @@ module Metanorma
         end
       end
 
+      def single_subfigure_cleanup(xmldoc)
+        xmldoc.xpath("//figure[figure]").each do |e|
+          s = e.xpath("./figure")
+          return unless s.size == 1
+
+          s[0].replace(s[0].children)
+        end
+      end
+
       def figure_cleanup(xmldoc)
         figure_footnote_cleanup(xmldoc)
         figure_dl_cleanup1(xmldoc)
         figure_dl_cleanup2(xmldoc)
         subfigure_cleanup(xmldoc)
+        single_subfigure_cleanup(xmldoc)
       end
 
       ELEMS_ALLOW_NOTES = %w[p formula ul ol dl figure].freeze

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -5,12 +5,15 @@ require "json"
 module Metanorma
   module Standoc
     module Cleanup
-      def footnote_content(fn)
-        c = fn.children.respond_to?(:to_xml) ? fn.children.to_xml : fn.children
+      def footnote_content(fnote)
+        c = if fnote.children.respond_to?(:to_xml)
+              fnote.children.to_xml
+            else fn.children
+            end
         c.gsub(/ id="[^"]+"/, "")
       end
 
-      # include footnotes inside figure if they are the only content 
+      # include footnotes inside figure if they are the only content
       # of the paras following
       def figure_footnote_cleanup(xmldoc)
         nomatches = false
@@ -18,7 +21,9 @@ module Metanorma
           q = "//figure/following-sibling::*[1][self::p and *[1][self::fn]]"
           nomatches = true
           xmldoc.xpath(q).each do |s|
-            next if s.children.map { |c| c.text? && /[[:alpha:]]/.match(c.text) }.any?
+            next if s.children.map do |c|
+                      c.text? && /[[:alpha:]]/.match(c.text)
+                    end.any?
 
             s.previous_element << s.first_element_child.remove
             s.remove
@@ -27,16 +32,16 @@ module Metanorma
         end
       end
 
-      def table_footnote_renumber1(fn, i, seen)
-        content = footnote_content(fn)
+      def table_footnote_renumber1(fnote, i, seen)
+        content = footnote_content(fnote)
         if seen[content] then outnum = seen[content]
         else
           i += 1
           outnum = i
           seen[content] = outnum
         end
-        fn["reference"] = (outnum - 1 + "a".ord).chr
-        fn["table"] = true
+        fnote["reference"] = (outnum - 1 + "a".ord).chr
+        fnote["table"] = true
         [i, seen]
       end
 
@@ -84,7 +89,7 @@ module Metanorma
 
       def footnote_block_cleanup(xmldoc)
         xmldoc.xpath("//footnoteblock").each do |f|
-          f.name = 'fn'
+          f.name = "fn"
           if id = xmldoc.at("//*[@id = '#{f.text}']")
             f.children = id.remove.children
           else

data/lib/metanorma/standoc/cleanup_inline.rb

@@ -185,6 +185,23 @@ module Metanorma
         Digest::MD5.hexdigest("#{elem.path}////#{elem.text}")
           .sub(/^(.{8})(.{4})(.{4})(.{4})(.{12})$/, "_\\1-\\2-\\3-\\4-\\5")
       end
+
+      def passthrough_cleanup(doc)
+        doc.xpath("//passthrough-inline").each do |p|
+          p.name = "passthrough"
+          p.children = select_odd_chars(p.children.to_xml)
+        end
+        doc.xpath("//identifier").each do |p|
+          p.children = select_odd_chars(p.children.to_xml)
+        end
+      end
+
+      private
+
+      # skip ZWNJ inserted to prevent regexes operating in asciidoctor
+      def select_odd_chars(text)
+        text.gsub(/(?!&)([[:punct:]])\u200c/, "\\1")
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_maths.rb

@@ -20,8 +20,8 @@ module Metanorma
         text = text.gsub(%r{<stem type="AsciiMath">(.+?)</stem>}m) do
           "<amathstem>#{HTMLEntities.new.decode($1)}</amathstem>"
         end
-        text = Html2Doc.asciimath_to_mathml(text,
-                                            ["<amathstem>", "</amathstem>"])
+        text = Html2Doc.new({})
+          .asciimath_to_mathml(text, ["<amathstem>", "</amathstem>"])
         x =  Nokogiri::XML(text)
         x.xpath("//*[local-name() = 'math'][not(parent::stem)]").each do |y|
           y.wrap("<stem type='MathML'></stem>")
@@ -68,10 +68,11 @@ module Metanorma
       def mi_italicise?(char)
         return false if char.length > 1
 
-        if /\p{Greek}/.match?(char)
+        case char
+        when /\p{Greek}/
           (/\p{Lower}/.match(char) && !mathml_mi_italics[:lowergreek]) ||
             (/\p{Upper}/.match(char) && !mathml_mi_italics[:uppergreek])
-        elsif /\p{Latin}/.match?(char)
+        when /\p{Latin}/
           (/\p{Lower}/.match(char) && !mathml_mi_italics[:lowerroman]) ||
             (/\p{Upper}/.match(char) && !mathml_mi_italics[:upperroman])
         else false

data/lib/metanorma/standoc/cleanup_reqt.rb

@@ -53,7 +53,7 @@ module Metanorma
                    permission).include?(text.name))) ||
           (text.text.strip.empty? && !text.at(".//xref | .//eref | .//link"))
 
-        t = Nokogiri::XML::Element.new("description", reqt)
+        t = Nokogiri::XML::Element.new("description", reqt.document)
         text.before(t)
         t.children = text.remove
       end

data/lib/metanorma/standoc/cleanup_section.rb

@@ -125,11 +125,8 @@ module Metanorma
       end
 
       def obligations_cleanup_info(xml)
-        s = xml.at("//foreword") and s["obligation"] = "informative"
-        s = xml.at("//introduction") and s["obligation"] = "informative"
-        s = xml.at("//acknowledgements") and s["obligation"] = "informative"
-        xml.xpath("//references").each { |r| r["obligation"] = "informative" }
-        xml.xpath("//preface//clause").each do |r|
+        xml.xpath("//foreword | //introduction | //acknowledgements | "\
+                  "//references | //preface//clause").each do |r|
           r["obligation"] = "informative"
         end
       end
@@ -158,29 +155,34 @@ module Metanorma
       def preface_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//preface")
 
-        unless ins = xmldoc.at("//preface").children.first
-          xmldoc.at("//preface") << " "
-          ins = xmldoc.at("//preface").children.first
-        end
+        ins = insert_before(xmldoc, "//preface")
         xmldoc.xpath("//preface//*[@beforeclauses = 'true']").each do |x|
           x.delete("beforeclauses")
           ins.previous = x.remove
         end
+        xmldoc.xpath("//*[@coverpage = 'true']").each do |x|
+          ins.previous = x.remove
+        end
       end
 
       def sections_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//sections")
 
-        unless ins = xmldoc.at("//sections").children.first
-          xmldoc.at("//sections") << " "
-          ins = xmldoc.at("//sections").children.first
-        end
+        ins = insert_before(xmldoc, "//sections")
         xmldoc.xpath("//sections//*[@beforeclauses = 'true']").each do |x|
           x.delete("beforeclauses")
           ins.previous = x.remove
         end
       end
 
+      def insert_before(xmldoc, xpath)
+        unless ins = xmldoc.at(xpath).children.first
+          xmldoc.at(xpath) << " "
+          ins = xmldoc.at(xpath).children.first
+        end
+        ins
+      end
+
       def floatingtitle_cleanup(xmldoc)
         pop_floating_title(xmldoc)
         floating_title_preface2sections(xmldoc)

data/lib/metanorma/standoc/cleanup_terms.rb

@@ -93,7 +93,9 @@ module Metanorma
       def termnote_example_cleanup(xmldoc)
         %w(note example).each do |w|
           xmldoc.xpath("//term#{w}[not(ancestor::term)]").each do |x|
-            x.name = w
+            if x["keepasterm"] then x.delete("keepasterm")
+            else x.name = w
+            end
           end
         end
       end

data/lib/metanorma/standoc/cleanup_text.rb

@@ -5,8 +5,11 @@ module Metanorma
         text = result.flatten.map { |l| l.sub(/\s*\Z/, "") } * "\n"
         !@keepasciimath and text = asciimath2mathml(text)
         text = text.gsub(/\s+<fn /, "<fn ")
-        text.gsub(%r{<passthrough\s+formats="metanorma">([^<]*)
-                  </passthrough>}mx) { HTMLEntities.new.decode($1) }
+        %w(passthrough passthrough-inline).each do |v|
+          text.gsub!(%r{<#{v}\s+formats="metanorma">([^<]*)
+                    </#{v}>}mx) { HTMLEntities.new.decode($1) }
+        end
+        text
       end
 
       def smartquotes_cleanup(xmldoc)
@@ -33,7 +36,8 @@ module Metanorma
 
       def uninterrupt_quotes_around_xml_skip(elem)
         !(/\A['"]/.match?(elem.text) &&
-          elem.previous.ancestors("pre, tt, sourcecode, stem, figure, bibdata")
+          elem.previous.ancestors("pre, tt, sourcecode, stem, figure, bibdata,
+                                  passthrough, identifer")
           .empty? &&
           ((elem.previous.text.strip.empty? &&
             !empty_tag_with_text_content?(elem.previous)) ||
@@ -70,7 +74,8 @@ module Metanorma
           empty_tag_with_text_content?(x) and prev = "dummy"
           next unless x.text?
 
-          x.ancestors("pre, tt, sourcecode, stem, figure, bibdata").empty? and
+          x.ancestors("pre, tt, sourcecode, stem, figure, bibdata, passthrough,
+                      identifier").empty? and
             dumb2smart_quotes1(x, prev)
           prev = x.text if x.ancestors("index").empty?
         end

data/lib/metanorma/standoc/converter.rb

@@ -36,6 +36,7 @@ module Metanorma
         inline_macro Metanorma::Standoc::DomainTermInlineMacro
         inline_macro Metanorma::Standoc::InheritInlineMacro
         inline_macro Metanorma::Standoc::HTML5RubyMacro
+        inline_macro Metanorma::Standoc::IdentifierInlineMacro
         inline_macro Metanorma::Standoc::ConceptInlineMacro
         inline_macro Metanorma::Standoc::AutonumberInlineMacro
         inline_macro Metanorma::Standoc::VariantInlineMacro
@@ -63,6 +64,7 @@ module Metanorma
         block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
         block Metanorma::Standoc::PseudocodeBlockMacro
         preprocessor Metanorma::Standoc::EmbedIncludeProcessor
+        preprocessor Metanorma::Standoc::NamedEscapePreprocessor
       end
 
       include ::Asciidoctor::Converter

data/lib/metanorma/standoc/inline.rb

@@ -79,7 +79,8 @@ module Metanorma
       end
 
       def inline_anchor_bibref(node)
-        eref_contents = (node.text || node.target || node.id)
+        eref_contents = HTMLEntities.new
+          .decode(node.text || node.target || node.id)
           &.sub(/^\[?([^\[\]]+?)\]?$/, "[\\1]")
         @refids << (node.target || node.id)
         noko do |xml|

data/lib/metanorma/standoc/isodoc.rng

@@ -32,6 +32,43 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="admonition">
+      <element name="admonition">
+        <attribute name="type">
+          <ref name="AdmonitionType"/>
+        </attribute>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -245,6 +282,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="ul_li"/>
         </oneOrMore>
@@ -287,6 +327,9 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -323,6 +366,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -851,6 +897,16 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -1178,6 +1234,7 @@
       <ref name="concept"/>
       <ref name="add"/>
       <ref name="del"/>
+      <ref name="span"/>
     </choice>
   </define>
   <define name="add">
@@ -1204,6 +1261,14 @@
       </choice>
     </element>
   </define>
+  <define name="span">
+    <element name="span">
+      <attribute name="class"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="concept">
     <element name="concept">
       <optional>