metanorma-standoc 2.0.6 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d902ad2befbbd472837eceebed5f29e138d9c10a6dd2a7dc4c465addc6e5bb14
-  data.tar.gz: e84f81d8e37fde67646aac29bfda98a48ed9d5e851318dfb3acfdefca0872d12
+  metadata.gz: d2c3089664934dc34b5f41b7e03a7bc2d2b1060e17decafb29dfc1f36fb7bed0
+  data.tar.gz: 7ecc333b2847252e7965be128c701f4cb2241d148179cd43b66a9f5cd2a2e108
 SHA512:
-  metadata.gz: 07d40940c3dac1176e80861e39b1fa527c9ae5c028cbde11624677c85f17645160c230725d1c010de16121a47031360c354a62db164534d6fba7d2d5456af8bf
-  data.tar.gz: 8f2220572c54be5e184d63fa694ce031be239a10d06888c92ac91f028ffa5bee9d2cf516e043df921dc5d932529d9686fadcb4b0547a5604717b14f261650310
+  metadata.gz: 5308c4354dc5fd14e1d5d18dc32e7b52d81ba492e53381771e7dfecea4c83af0bd73387af2bfb6c913687352eaad85c44ded592e1c95179d5d41b3974bc923ff
+  data.tar.gz: ba8122c376d231eb6f1f4f4ea235b608b4dd1769394a899fe9fcd6f5bee011f2384cf1455fae0d86d32648e37aee080c0db18755d4a761e793ad5164b500ce61

data/lib/asciidoctor/standoc/base.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/base"
-

data/lib/asciidoctor/standoc/blocks.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/blocks"
-

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/blocks_notes"
-

data/lib/asciidoctor/standoc/cleanup.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup"
-

data/lib/asciidoctor/standoc/cleanup_amend.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_amend"
-

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_block"
-

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_boilerplate"
-

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_footnotes"
-

data/lib/asciidoctor/standoc/cleanup_image.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_image"
-

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_inline"
-

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_maths"
-

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_ref"
-

data/lib/asciidoctor/standoc/cleanup_ref_dl.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_ref_dl"
-

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_reqt"
-

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_section"
-

data/lib/asciidoctor/standoc/cleanup_section_names.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_section_names"
-

data/lib/asciidoctor/standoc/cleanup_symbols.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_symbols"
-

data/lib/asciidoctor/standoc/cleanup_table.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_table"
-

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_terms"
-

data/lib/asciidoctor/standoc/cleanup_terms_designations.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_terms_designations"
-

data/lib/asciidoctor/standoc/cleanup_text.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_text"
-

data/lib/asciidoctor/standoc/cleanup_toc.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_toc"
-

data/lib/asciidoctor/standoc/cleanup_xref.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/cleanup_xref"
-

data/lib/asciidoctor/standoc/converter.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/converter"
-

data/lib/asciidoctor/standoc/deprecated.rb

@@ -1,5 +1,7 @@
-warn "Please replace your references to Asciidoctor::Standoc with Metanorma::Standoc and your instances of require 'asciidoctor/standoc' with require 'metanorma/standoc'"
+warn "Please replace your references to Asciidoctor::Standoc with "\
+     "Metanorma::Standoc and your instances of require 'asciidoctor/standoc' "\
+     "with require 'metanorma/standoc'"
 
-exit 127 if ENV['METANORMA_DEPRECATION_FAIL']
+exit 127 if ENV["METANORMA_DEPRECATION_FAIL"]
 
 Asciidoctor::Standoc = Metanorma::Standoc unless defined? Asciidoctor::Standoc

data/lib/asciidoctor/standoc/front.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/front"
-

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/front_contributor"
-

data/lib/asciidoctor/standoc/inline.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/inline"
-

data/lib/asciidoctor/standoc/lists.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/lists"
-

data/lib/asciidoctor/standoc/macros.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/macros"
-

data/lib/asciidoctor/standoc/macros_form.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/macros_form"
-

data/lib/asciidoctor/standoc/macros_note.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/macros_note"
-

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/macros_plantuml"
-

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/macros_terms"
-

data/lib/asciidoctor/standoc/render.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/render"
-

data/lib/asciidoctor/standoc/reqt.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/reqt"
-

data/lib/asciidoctor/standoc/section.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/section"
-

data/lib/asciidoctor/standoc/table.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/table"
-

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/term_lookup_cleanup"
-

data/lib/asciidoctor/standoc/terms.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/terms"
-

data/lib/asciidoctor/standoc/utils.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/utils"
-

data/lib/asciidoctor/standoc/validate.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/validate"
-

data/lib/asciidoctor/standoc/validate_section.rb

@@ -1,3 +1,2 @@
 require "asciidoctor/standoc/deprecated"
 require "metanorma/standoc/validate_section"
-

data/lib/isodoc/pdf_convert.rb

@@ -2,7 +2,6 @@ require "isodoc"
 
 module IsoDoc
   module Standoc
-
     # A {Converter} implementation that generates HTML output, and a document
     # schema encapsulation of the document for validation
     #
@@ -12,8 +11,8 @@ module IsoDoc
         super
       end
 
-      def pdf_stylesheet(docxml)
-          "base.standard.xsl"
+      def pdf_stylesheet(_docxml)
+        "base.standard.xsl"
       end
     end
   end

data/lib/metanorma/standoc/biblio.rng

@@ -527,7 +527,7 @@
   </define>
   <define name="LocalityType">
     <data type="string">
-      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
+      <param name="pattern">section|clause|part|paragraph|chapter|page|title|line|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
     </data>
   </define>
   <define name="referenceFrom">
@@ -677,6 +677,9 @@
     <zeroOrMore>
       <ref name="extent"/>
     </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
     <zeroOrMore>
       <ref name="accesslocation"/>
     </zeroOrMore>
@@ -848,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"/>
@@ -922,9 +954,29 @@
       <text/>
     </element>
   </define>
+  <define name="sizevalue">
+    <element name="value">
+      <attribute name="type"/>
+      <text/>
+    </element>
+  </define>
+  <define name="bibliographic_size">
+    <element name="size">
+      <oneOrMore>
+        <ref name="sizevalue"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="extent">
     <element name="extent">
-      <ref name="BibItemLocality"/>
+      <choice>
+        <zeroOrMore>
+          <ref name="locality"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="localityStack"/>
+        </zeroOrMore>
+      </choice>
     </element>
   </define>
   <define name="series">

data/lib/metanorma/standoc/blocks.rb

@@ -96,6 +96,7 @@ module Metanorma
         return svgmap_example(node) if role == "svgmap"
         return form(node) if role == "form"
         return termdefinition(node) if role == "definition"
+        return figure_example(node) if role == "figure"
 
         reqt_subpart(role) and return requirement_subpart(node)
         example_proper(node)
@@ -145,6 +146,15 @@ module Metanorma
         end.join("\n")
       end
 
+      def figure_example(node)
+        noko do |xml|
+          xml.figure **figure_attrs(node) do |ex|
+            node.title.nil? or ex.name { |name| name << node.title }
+            wrap_in_para(node, ex)
+          end
+        end.join("\n")
+      end
+
       def figure_title(node, out)
         return if node.title.nil?
 

data/lib/metanorma/standoc/blocks_notes.rb

@@ -12,12 +12,8 @@ module Metanorma
       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)
@@ -73,15 +69,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_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_boilerplate.rb

@@ -111,7 +111,7 @@ module Metanorma
         return if xml.at("//boilerplate")
 
         preface = xml.at("//preface") || xml.at("//sections") ||
-          xml.at("//annex") || xml.at("//references") || return
+          xml.at("//annex") || xml.at("//references") or return
         b = boilerplate(xml, isodoc) or return
         preface.previous = b
       end
@@ -162,11 +162,11 @@ module Metanorma
       end
 
       def insert_indirect_biblio(xmldoc, refs, prefix)
-        ins = xmldoc.at("bibliography") or
-          xmldoc.root << "<bibliography/>" and ins = xmldoc.at("bibliography")
-        ins = ins.add_child("<references hidden='true' normative='false'/>").first
+        i = xmldoc.at("bibliography") or
+          xmldoc.root << "<bibliography/>" and i = xmldoc.at("bibliography")
+        i = i.add_child("<references hidden='true' normative='false'/>").first
         refs.each do |x|
-          ins << <<~BIB
+          i << <<~BIB
             <bibitem id="#{x}" type="internal">
             <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
             </bibitem>
@@ -213,12 +213,13 @@ module Metanorma
       def bibdata_embed_hdr_cleanup(xmldoc)
         return if @embed_hdr.nil? || @embed_hdr.empty?
 
-        embed_recurse(xmldoc.at("//bibdata"), @embed_hdr.first)
+        xmldoc.at("//bibdata") << "<relation type='derivedFrom'>"\
+                                  "#{hdr2bibitem(@embed_hdr.first)}</relation>"
       end
 
       def hdr2bibitem(hdr)
         xml = Asciidoctor
-          .convert(hdr[:text], backend: Processor.new.asciidoctor_backend,
+          .convert(hdr[:text], backend: hdr2bibitem_type(hdr),
                                header_footer: true)
         b = Nokogiri::XML(xml).at("//xmlns:bibdata")
         b.name = "bibitem"
@@ -227,6 +228,13 @@ module Metanorma
         b.to_xml
       end
 
+      def hdr2bibitem_type(hdr)
+        m = /:mn-document-class: (\S+)/.match(hdr[:text])
+        if m then m[1].to_sym
+        else Processor.new.asciidoctor_backend
+        end
+      end
+
       def embed_recurse(bibitem, node)
         node[:child].map { |x| hdr2bibitem(x) }.each do |x|
           bibitem << "<relation type='derivedFrom'>#{x}</relation>"

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

@@ -50,10 +50,8 @@ module Metanorma
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
         i = 0
-        xmldoc.xpath("//bibliography//references | //clause//references | "\
-                     "//annex//references").each do |r|
-          next if r["normative"] == "true"
-
+        xmldoc.xpath("//references[not(@normative = 'true')]"\
+                     "[not(@hidden = 'true')]").each do |r|
           r.xpath("./bibitem[not(@hidden = 'true')]").each do |b|
             i += 1
             next unless docid = b.at("./docidentifier[@type = 'metanorma']")

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)