metanorma-standoc 2.1.1 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c3089664934dc34b5f41b7e03a7bc2d2b1060e17decafb29dfc1f36fb7bed0
-  data.tar.gz: 7ecc333b2847252e7965be128c701f4cb2241d148179cd43b66a9f5cd2a2e108
+  metadata.gz: d55c699cf84e05288a133b4e0b9305cfb14809780ec379b8d617a928338f1fca
+  data.tar.gz: 772eaa9e0e09e9ad7c40b70ade1825d437ba079673767b31c3c5b493cf29af4f
 SHA512:
-  metadata.gz: 5308c4354dc5fd14e1d5d18dc32e7b52d81ba492e53381771e7dfecea4c83af0bd73387af2bfb6c913687352eaad85c44ded592e1c95179d5d41b3974bc923ff
-  data.tar.gz: ba8122c376d231eb6f1f4f4ea235b608b4dd1769394a899fe9fcd6f5bee011f2384cf1455fae0d86d32648e37aee080c0db18755d4a761e793ad5164b500ce61
+  metadata.gz: fba5328a1ebbc7d236174893d3e98ece5768c3d8935c326506692023d1254c1a2bda95f842956b4830d18c949ba817d4ca4f00548c569999ae38381c1406f02f
+  data.tar.gz: d3aed7321347c856c5f8ff600118773094ffc948a5f7b3be6655dff48749c4780a5a4048baf1a04d4aad94e22b650648c91c7ca9bc159680beb48ec4275a8904

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,103 @@
     <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>
+    <oneOrMore>
+      <ref name="docidentifier"/>
+    </oneOrMore>
+    <optional>
+      <ref name="docnumber"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bdate"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="edition"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="version"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="biblionote"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="language"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="script"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bibabstract"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="status"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="copyright"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="docrelation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="series"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="medium"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bplace"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bprice"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="extent"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="accesslocation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="license"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bclassification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bkeyword"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="validity"/>
+    </optional>
+  </define>
+  <define name="ReducedBibliographicItem">
+    <optional>
+      <attribute name="type">
+        <ref name="BibItemType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <ref name="fetched"/>
+    </optional>
+    <optional>
+      <ref name="formattedref"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="btitle"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="bsource"/>
     </zeroOrMore>
@@ -638,9 +729,9 @@
     <optional>
       <ref name="edition"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="version"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="biblionote"/>
     </zeroOrMore>
@@ -833,6 +924,12 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
       <text/>
     </element>
   </define>
@@ -986,36 +1083,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">
@@ -1174,7 +1269,7 @@
         </element>
       </optional>
       <element name="bibitem">
-        <ref name="BibliographicItem"/>
+        <ref name="ReducedBibliographicItem"/>
       </element>
       <choice>
         <zeroOrMore>
@@ -1199,9 +1294,9 @@
       <optional>
         <ref name="revision-date"/>
       </optional>
-      <zeroOrMore>
+      <optional>
         <ref name="draft"/>
-      </zeroOrMore>
+      </optional>
     </element>
   </define>
   <define name="vedition">

data/lib/metanorma/standoc/blocks.rb

@@ -38,9 +38,7 @@ module Metanorma
         role == "form" and return form(node)
         role == "definition" and return termdefinition(node)
         result = []
-        node.blocks.each do |b|
-          result << send(b.context, b)
-        end
+        node.blocks.each { |b| result << send(b.context, b) }
         result
       end
 
@@ -80,14 +78,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") || 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 +238,11 @@ 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,6 +8,7 @@ module Metanorma
             number: node.attr("number"),
             subsequence: node.attr("subsequence"),
             "keep-separate": node.attr("keep-separate"),
+            keepasterm: node.option?("termnote") ? "true" : nil,
           )))
       end
 
@@ -61,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)
@@ -91,7 +94,7 @@ module Metanorma
       end
 
       def admonition(node)
-        return termnote(node) if in_terms?
+        return termnote(node) if in_terms? && node.attr("name") == "note"
         return note(node) if node.attr("name") == "note"
         return todo(node) if node.attr("name") == "todo"
 

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_footnotes.rb

@@ -5,20 +5,27 @@ 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 
+      FIGURE_FN_XPATH =
+        "//figure/following-sibling::*[1][self::p and *[1][self::fn]]".freeze
+
+      # include footnotes inside figure if they are the only content
       # of the paras following
       def figure_footnote_cleanup(xmldoc)
         nomatches = false
         until nomatches
-          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?
+          xmldoc.xpath(FIGURE_FN_XPATH).each do |s|
+            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,17 +34,17 @@ module Metanorma
         end
       end
 
-      def table_footnote_renumber1(fn, i, seen)
-        content = footnote_content(fn)
+      def table_footnote_renumber1(fnote, idx, seen)
+        content = footnote_content(fnote)
         if seen[content] then outnum = seen[content]
         else
-          i += 1
-          outnum = i
+          idx += 1
+          outnum = idx
           seen[content] = outnum
         end
-        fn["reference"] = (outnum - 1 + "a".ord).chr
-        fn["table"] = true
-        [i, seen]
+        fnote["reference"] = (outnum - 1 + "a".ord).chr
+        fnote["table"] = true
+        [idx, seen]
       end
 
       def table_footnote_renumber(xmldoc)
@@ -50,18 +57,18 @@ module Metanorma
         end
       end
 
-      def other_footnote_renumber1(fn, i, seen)
-        unless fn["table"]
-          content = footnote_content(fn)
-          if seen[content] then outnum = seen[content]
-          else
-            i += 1
-            outnum = i
-            seen[content] = outnum
-          end
-          fn["reference"] = outnum.to_s
+      def other_footnote_renumber1(fnote, idx, seen)
+        return [idx, seen] if fnote["table"]
+
+        content = footnote_content(fnote)
+        if seen[content] then outnum = seen[content]
+        else
+          idx += 1
+          outnum = idx
+          seen[content] = outnum
         end
-        [i, seen]
+        fnote["reference"] = outnum.to_s
+        [idx, seen]
       end
 
       def other_footnote_renumber(xmldoc)
@@ -84,7 +91,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_ref.rb

@@ -80,6 +80,7 @@ module Metanorma
 
       def biblio_cleanup(xmldoc)
         biblio_reorder(xmldoc)
+        biblio_annex(xmldoc)
         biblio_nested(xmldoc)
         biblio_renumber(xmldoc)
         biblio_linkonly(xmldoc)
@@ -119,6 +120,16 @@ module Metanorma
         xmldoc.xpath("//bibitem/ext").each(&:remove)
       end
 
+      def biblio_annex(xmldoc)
+        xmldoc.xpath("//annex[references/references]").each do |t|
+          next unless t.xpath("./clause | ./references | ./terms").size == 1
+
+          r = t.at("./references")
+          r.xpath("./references").each { |b| b["normative"] = r["normative"] }
+          r.replace(r.elements)
+        end
+      end
+
       def biblio_nested(xmldoc)
         xmldoc.xpath("//references[references]").each do |t|
           t.name = "clause"
@@ -143,6 +154,11 @@ module Metanorma
       def reference_names(xmldoc)
         xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
           docid = ref.at("./docidentifier[@type = 'metanorma']") ||
+            ref.at("./docidentifier[@primary = 'true'][@language = '#{@lang}']") ||
+            ref.at("./docidentifier[@primary = 'true'][not(@language)]") ||
+            ref.at("./docidentifier[@primary = 'true']") ||
+            ref.at("./docidentifier[not(@type = 'DOI')][@language = '#{@lang}']") ||
+            ref.at("./docidentifier[not(@type = 'DOI')][not(@language)]") ||
             ref.at("./docidentifier[not(@type = 'DOI')]") or next
           reference = format_ref(docid.children.to_xml, docid["type"])
           @anchors[ref["id"]] = { xref: reference }

data/lib/metanorma/standoc/cleanup_section.rb

@@ -118,6 +118,12 @@ module Metanorma
         change_clauses(xml)
       end
 
+      def single_clause_annex(xml)
+        xml.xpath("//annex").each do |a|
+          single_clause_annex1(a)
+        end
+      end
+
       def obligations_cleanup(xml)
         obligations_cleanup_info(xml)
         obligations_cleanup_norm(xml)

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/cleanup_xref.rb

@@ -68,9 +68,10 @@ module Metanorma
       end
 
       def xref_to_eref(elem)
+        c = HTMLEntities.new
         elem["bibitemid"] = elem["target"]
         if ref = @anchors&.dig(elem["target"], :xref)
-          elem["citeas"] = HTMLEntities.new.encode(ref, :hexadecimal)
+          elem["citeas"] = c.decode(ref)
         else
           elem["citeas"] = ""
           xref_to_eref1(elem)

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
@@ -58,11 +59,14 @@ module Metanorma
         inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
         block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Metanorma::Standoc::ToDoAdmonitionBlock
+        block Metanorma::Standoc::EditorAdmonitionBlock
+        treeprocessor Metanorma::Standoc::EditorInlineAdmonitionBlock
         treeprocessor Metanorma::Standoc::ToDoInlineAdmonitionBlock
         block Metanorma::Standoc::PlantUMLBlockMacro
         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/isodoc.rng

@@ -69,6 +69,17 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="AdmonitionType">
+      <choice>
+        <value>warning</value>
+        <value>note</value>
+        <value>tip</value>
+        <value>important</value>
+        <value>caution</value>
+        <value>statement</value>
+        <value>editorial</value>
+      </choice>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -116,6 +127,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="suppress_identifier">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <ref name="BibliographicItem"/>
       </element>
     </define>
@@ -282,6 +298,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="ul_li"/>
         </oneOrMore>
@@ -324,6 +343,9 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="li"/>
         </oneOrMore>
@@ -360,6 +382,9 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -694,6 +719,9 @@
       <optional>
         <attribute name="tag"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="multilingual-rendering">
           <ref name="MultilingualRenderingType"/>
@@ -729,6 +757,9 @@
         <optional>
           <attribute name="tag"/>
         </optional>
+        <optional>
+          <attribute name="type"/>
+        </optional>
         <optional>
           <attribute name="multilingual-rendering">
             <ref name="MultilingualRenderingType"/>
@@ -2050,6 +2081,7 @@
       <value>compare</value>
       <value>contrast</value>
       <value>see</value>
+      <value>seealso</value>
     </choice>
   </define>
   <define name="deprecates">