metanorma-standoc 2.0.7 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e678173d52fd8197d0127f397b7f65349b72d26242d62c3cee8005e3057068b
-  data.tar.gz: 4a5548452c906db7df68ead74453f49d484fe601791a35aeb22360e9abb0b2ea
+  metadata.gz: 1e7285f74dd3b2b9ab155b8bf7e334aeb45f453a20f1d4eaf94f39f42b9251d3
+  data.tar.gz: fdbad7c4cd96de56faacf360fdedaa0a0a5d24313c34b68ec2ab8e152db6a7c2
 SHA512:
-  metadata.gz: 3b28ce6e459d29a0b457179ad2f97282ccf26109358ed8ab933d42e080d8ad1e4511d68c1470d16437c8dd71338ed8951f2a021335f135cf0d3d467d432e715a
-  data.tar.gz: d54fc63c669aa31fc728d35f3761c4a853d1ef345d9010988157550073ff2e38feb6ad123be562ee323219d812fa3f414da17102d0c462801bd31aa0be50405d
+  metadata.gz: ce9033847b44804a9ba150db5e4840e1d3dafef077a9c5af52defd74321333c66a3053abc589ae02ee3c28d6fe42afbd568cdef8b1a529e5b2a97ea46ec95ae0
+  data.tar.gz: 6f498786e8222646f72fe88193797b0b0a23c30d1478cf78fad27862f19ece9c054ebe72c891ad671f5c03b4c8f06a659195cc77f359f517b1ffea02203ad22b

data/lib/metanorma/standoc/biblio.rng

@@ -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"/>

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_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_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/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>
@@ -851,6 +888,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 +1225,7 @@
       <ref name="concept"/>
       <ref name="add"/>
       <ref name="del"/>
+      <ref name="span"/>
     </choice>
   </define>
   <define name="add">
@@ -1204,6 +1252,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>

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.0.7".freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 2.0.0"
+  spec.add_dependency "isodoc", "~> 2.1.0"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"

data/spec/metanorma/blocks_spec.rb

@@ -658,7 +658,7 @@ RSpec.describe Metanorma::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       [[ABC]]
-      [CAUTION,type=Safety Precautions,keep-with-next="true",keep-lines-together="true",tag=X,multilingual-rendering=common]
+      [CAUTION,type=Safety Precautions,keep-with-next="true",keep-lines-together="true",tag=X,multilingual-rendering=common,notag=true]
       .Precautions
       ====
       While werewolves are hardy community members, keep in mind the following dietary concerns:
@@ -671,7 +671,7 @@ RSpec.describe Metanorma::Standoc do
     output = <<~OUTPUT
       #{BLANK_HDR}
       <sections>
-         <admonition id="ABC" type="safety precautions" keep-with-next="true" keep-lines-together="true" tag='X' multilingual-rendering='common'>
+         <admonition id="ABC" type="safety precautions" keep-with-next="true" keep-lines-together="true" tag='X' multilingual-rendering='common' notag="true" unnumbered="true">
         <name>Precautions</name><p id="_">While werewolves are hardy community members, keep in mind the following dietary concerns:</p>
        <ol id="_" type="arabic">
          <li>
@@ -907,6 +907,29 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "does not create subfigures if there is only one nested figure" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      [[figureC-2]]
+      [.figure]
+      .Stages of gelatinization
+      ====
+      image::spec/examples/rice_images/rice_image3_1.png[]
+      ====
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+             <sections>
+        <figure id="figureC-2"><name>Stages of gelatinization</name>
+        <image src="spec/examples/rice_images/rice_image3_1.png" id="_" mimetype="image/png" height="auto" width="auto"/>
+      </figure>
+      </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes figures within examples" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/metanorma/cleanup_blocks_spec.rb

@@ -985,6 +985,12 @@ RSpec.describe Metanorma::Standoc do
       ====
       Notice which is very important
       ====
+
+      [IMPORTANT,coverpage=true]
+      ====
+      Notice which is also very important
+      ====
+
     INPUT
     output = <<~OUTPUT
         #{BLANK_HDR}
@@ -992,6 +998,9 @@ RSpec.describe Metanorma::Standoc do
           <note id='_'>
             <p id='_'>Note which is very important</p>
           </note>
+          <admonition id='_' type='important' coverpage='true'>
+            <p id='_'>Notice which is also very important</p>
+          </admonition>
           <foreword id='_' obligation='informative'>
             <title>Foreword</title>
             <p id='_'>Foreword</p>

data/spec/metanorma/refs_dl_spec.rb

@@ -2,8 +2,8 @@ require "spec_helper"
 require "relaton_iso"
 
 RSpec.describe Metanorma::Standoc do
-    it "processes simple dl reference" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+  it "processes simple dl reference" do
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       [bibliography]
       == Normative References
@@ -36,6 +36,7 @@ RSpec.describe Metanorma::Standoc do
           completename::::: Jack
 
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR}
       <sections>
       </sections><bibliography><references id="_" obligation="informative" normative="true">
@@ -69,10 +70,12 @@ RSpec.describe Metanorma::Standoc do
       </bibliography>
       </standard-document>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes complex dl reference" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
       == Clause
@@ -292,6 +295,7 @@ RSpec.describe Metanorma::Standoc do
         script::: Latn
 
     INPUT
+    output = <<~OUTPUT
             #{BLANK_HDR}
             <sections>
         <clause id='_' inline-header='false' obligation='normative'>
@@ -455,10 +459,12 @@ RSpec.describe Metanorma::Standoc do
       </bibitem></references></bibliography>
       </standard-document>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes complex dl reference with dot path keys" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       [bibliography]
       == Normative References
@@ -621,6 +627,7 @@ RSpec.describe Metanorma::Standoc do
       series.formattedref.script:: Latn
 
     INPUT
+    output = <<~OUTPUT
             #{BLANK_HDR}
             <sections>
             </sections><bibliography><references id="_" obligation="informative" normative="true">
@@ -775,10 +782,12 @@ RSpec.describe Metanorma::Standoc do
       </bibitem></references></bibliography>
       </standard-document>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes mix of dl and default references" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
       == Section
@@ -818,6 +827,7 @@ RSpec.describe Metanorma::Standoc do
           completename::::: Jack
 
     INPUT
+    output = <<~OUTPUT
                 #{BLANK_HDR}
            <sections>
          <clause id='_' inline-header='false' obligation='normative'>
@@ -864,5 +874,7 @@ RSpec.describe Metanorma::Standoc do
        </sections>
       </standard-document>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 end

data/spec/metanorma/refs_spec.rb

@@ -1665,9 +1665,6 @@ RSpec.describe Metanorma::Standoc do
               <bibitem id='iso123' type='standard'>
                      <fetched/>
                      <title format='text/plain' language='en' script='Latn'>Network Configuration Access Control Model</title>
-                     <uri type='xml'>
-                       https://raw.githubusercontent.com/relaton/relaton-data-ietf/master/data/reference.RFC.8341.xml
-                     </uri>
                      <uri type='src'>https://www.rfc-editor.org/info/rfc8341</uri>
                      <docidentifier type='RFC' primary="true">RFC 8341</docidentifier>
                      <docidentifier type='RFC' scope='anchor'>RFC8341</docidentifier>
@@ -1725,9 +1722,6 @@ RSpec.describe Metanorma::Standoc do
                    <bibitem id='iso124' type='standard'>
                      <fetched/>
                      <title format='text/plain' language='en' script='Latn'>Network Configuration Access Control Model</title>
-                     <uri type='xml'>
-                       https://raw.githubusercontent.com/relaton/relaton-data-ietf/master/data/reference.RFC.8341.xml
-                     </uri>
                      <uri type='src'>https://www.rfc-editor.org/info/rfc8341</uri>
                      <docidentifier type='RFC' primary="true">RFC 8341</docidentifier>
                      <docidentifier type='metanorma'>[1]</docidentifier>