metanorma-standoc 3.0.0 → 3.0.3

data/lib/isodoc/html/htmlstyle.scss

@@ -29,7 +29,7 @@ $docstage-colors-list: (
   retired: #2E382E
 );
 
-@import 'base_style/all';
+@use 'base_style/all' as *;
 
 /*
     1. HTML & Body
@@ -92,24 +92,6 @@ nav {
   @include sidebarNavToggle(white, #C70039)
 }
 
-@media screen and (min-width: 768px) {
-  .container {
-    padding-left: 360px;
-  }
-
-  .rule.toc {
-    display: none;
-  }
-
-  h1.toc-contents {
-    margin-top: 1em;
-  }
-
-  ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
-    padding: 0;
-    margin: 0;
-  }
-}
 
 div.figure {
   @include figureBlock();
@@ -643,6 +625,27 @@ To top button
   margin: 2cm 1cm;
 }
 
+
+@media screen and (min-width: 768px) {
+  .container {
+    padding-left: 360px;
+  }
+
+  .rule.toc {
+    display: none;
+  }
+
+  h1.toc-contents {
+    margin-top: 1em;
+  }
+
+  ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
+    padding: 0;
+    margin: 0;
+  }
+}
+
+
 @media print {
   .document-info,  nav, .copyright {
       page-break-before: always;

data/lib/metanorma/standoc/base.rb

@@ -11,6 +11,14 @@ require_relative "localbib"
 require_relative "init"
 require "mn-requirements"
 
+require 'set'
+
+module Asciidoctor
+  module Compliance
+    ADMONITION_STYLES.add('EDITOR') unless ADMONITION_STYLES.include?('EDITOR')
+  end
+end
+
 module Metanorma
   module Standoc
     module Base

data/lib/metanorma/standoc/basicdoc.rng

@@ -599,17 +599,9 @@ It is included for convenience, in case processing the citation to extract the a
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -628,17 +620,9 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -651,6 +635,20 @@ and is intended to be referenced by a callout within the source code</a:document
       </ref>
     </zeroOrMore>
   </define>
+  <define name="sourcecodebody">
+    <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+    <element name="body">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="callout">
+            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+          </ref>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="pre">
     <a:documentation>Pre-formatted block. Wrapper for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. 
 They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some 
@@ -1672,18 +1670,25 @@ which can be bookmarks as well as block or section references</a:documentation>
     </optional>
   </define>
   <define name="XrefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="ErefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement">
+            <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="fn">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.

data/lib/metanorma/standoc/blocks.rb

@@ -201,7 +201,9 @@ module Metanorma
         fragment = ::Nokogiri::XML::Builder.new do |xml|
           xml.sourcecode **listing_attrs(node) do |s|
             figure_title(node, s)
-            s << node.content
+            s.body do |b|
+              b << node.content
+            end
           end
         end
         fragment.to_xml(encoding: "US-ASCII", save_with:

data/lib/metanorma/standoc/blocks_notes.rb

@@ -90,8 +90,10 @@ module Metanorma
       end
 
       def admonition_name(node)
-        ret = node.attr("type") || node.attr("name")
-        ret&.downcase
+        ret = node.attr("type") || node.attr("name") or return
+        ret = ret.downcase
+        ret == "editor" and ret = "editorial"
+        ret
       end
 
       def admonition(node)

data/lib/metanorma/standoc/cleanup_block.rb

@@ -119,8 +119,8 @@ module Metanorma
 
       def align_callouts_to_annotations(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
+          callouts = x.xpath("./body/callout")
+          annotations = x.xpath("./annotation")
           callouts.size == annotations.size and
             link_callouts_to_annotations(callouts, annotations)
         end
@@ -163,7 +163,7 @@ module Metanorma
           acc << safe_noko(a[0], node.document)
           a.size == 4 or next
           acc << Asciidoctor.convert(
-            a[2], doctype: :inline, backend: self&.backend&.to_sym || :standoc
+            a[2], doctype: :inline, backend: backend&.to_sym || :standoc
           )
         end.join
       end

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -118,9 +118,21 @@ module Metanorma
         fnote.children = "[ERROR]"
       end
 
+      def process_hidden_footnotes(xmldoc)
+        xmldoc.xpath("//fn").each do |fn|
+          first_text = fn.xpath(".//text()")
+            .find { |node| !node.text.strip.empty? } or return
+          if first_text.text.strip.start_with?("hiddenref%")
+            first_text.content = first_text.text.sub(/^hiddenref%/, "")
+            fn["hiddenref"] = true
+          end
+        end
+      end
+
       def footnote_cleanup(xmldoc)
         footnote_block_cleanup(xmldoc)
         title_footnote_move(xmldoc)
+        process_hidden_footnotes(xmldoc)
         table_footnote_renumber(xmldoc)
         other_footnote_renumber(xmldoc)
         xmldoc.xpath("//fn").each do |fn|

data/lib/metanorma/standoc/cleanup_maths.rb

@@ -1,4 +1,3 @@
-require "asciimath2unitsml"
 require_relative "cleanup_mathvariant"
 
 module Metanorma
@@ -39,9 +38,12 @@ module Metanorma
             <math xmlns='#{MATHML_NS}'><mstyle displaystyle='false'><mn>#{expr}</mn></mstyle></math>
           MATH
         else
+          unitsml = if expr.include?("unitsml")
+                      { unitsml: { xml: true,
+                                   multiplier: :space } }
+                    else {} end
           Plurimath::Math.parse(expr, "asciimath")
-            .to_mathml(display_style: elem["block"],
-                       unitsml_xml: expr.include?("unitsml"))
+            .to_mathml(**{ display_style: elem["block"] }.merge(unitsml))
         end
       end
 
@@ -115,7 +117,7 @@ module Metanorma
       def gather_unitsml(unitsml, xmldoc, tag)
         tags = xmldoc.xpath(".//m:#{tag}", "m" => UNITSML_NS)
           .each_with_object({}) do |x, m|
-          m[x["xml:id"]] = x.remove
+          m[x["id"]] = x.remove
         end
         tags.empty? and return
         set = unitsml.add_child("<#{tag}Set/>").first
@@ -180,11 +182,9 @@ module Metanorma
       end
 
       def mathml_cleanup(xmldoc)
-        a2u = Asciimath2UnitsML::Conv.new(asciimath2unitsml_options)
         xmldoc.xpath("//stem[@type = 'MathML'][not(@validate = 'false')]")
           .each do |x|
           mathml_xml_cleanup(x)
-          a2u.MathML2UnitsML(x)
           mathml_mathvariant(x)
         end
         xmldoc.xpath("//stem[@type = 'MathML']")

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -144,12 +144,8 @@ module Metanorma
         sym and m[sym] += 1
       end
 
-      SECTION_CONTAINERS = %w(foreword introduction acknowledgements abstract
-                              clause clause references terms definitions annex
-                              appendix).freeze
-
       def sections_variant_title_cleanup(xml)
-        path = SECTION_CONTAINERS.map { |x| "./ancestor::#{x}" }.join(" | ")
+        path = section_containers.map { |x| "./ancestor::#{x}" }.join(" | ")
         xml.xpath("//p[@variant_title]").each do |p|
           p.name = "variant-title"
           p.delete("id")

data/lib/metanorma/standoc/front.rb

@@ -217,9 +217,9 @@ module Metanorma
         ["en"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at) do |t|
-            title = Metanorma::Utils::asciidoc_sub(node.attr("title") ||
-                                                 node.attr("title-en"))
-            t << (title || node.title)
+            title = Metanorma::Utils::asciidoc_sub(
+              node.attr("title") || node.attr("title-en") || node.attr("doctitle"))
+            t << title
           end
         end
       end

data/lib/metanorma/standoc/inline.rb

@@ -1,4 +1,3 @@
-require "unicode2latex"
 require "mime/types"
 require "base64"
 require "English"
@@ -27,7 +26,8 @@ module Metanorma
       end
 
       def latex_parse1(text, block)
-        lxm_input = Unicode2LaTeX.unicode2latex(@c.decode(text))
+        #lxm_input = Unicode2LaTeX.unicode2latex(@c.decode(text))
+        lxm_input = @c.decode(text)
         results = Plurimath::Math.parse(lxm_input, "latex")
           .to_mathml(display_style: block)
         if results.nil?

data/lib/metanorma/standoc/isodoc.rng

@@ -33,6 +33,15 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="fn" combine="interleave">
+      <optional>
+        <attribute name="hiddenref">
+          <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
+This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -245,23 +254,9 @@
           <a:documentation>The caption of the block</a:documentation>
         </ref>
       </optional>
-      <oneOrMore>
-        <choice>
-          <text>
-            <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-          </text>
-          <ref name="callout">
-            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-          </ref>
-          <ref name="xref">
-            <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
-          </ref>
-          <ref name="eref">
-            <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
-          </ref>
-        </choice>
-      </oneOrMore>
+      <ref name="sourcecodebody">
+        <a:documentation>The sourcecode content</a:documentation>
+      </ref>
       <zeroOrMore>
         <ref name="annotation">
           <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -277,6 +272,26 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="sourcecodebody">
+      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+      <element name="body">
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout">
+              <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+            </ref>
+            <ref name="xref">
+              <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
+            </ref>
+            <ref name="eref">
+              <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
+            </ref>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="sections">
       <element name="sections">
         <oneOrMore>

data/lib/metanorma/standoc/macros_note.rb

@@ -44,6 +44,7 @@ module Metanorma
       on_contexts :example, :paragraph
 
       def process(parent, reader, attrs)
+        require "debug"; binding.b
         attrs["name"] = "editorial"
         attrs["caption"] = "EDITOR"
         create_block(parent, :admonition, reader.lines, attrs,

data/lib/metanorma/standoc/macros_plantuml.rb

@@ -34,24 +34,27 @@ module Metanorma
       # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
       # This is why we need to copy and then unlink.
       def self.generate_file(parent, reader)
-        localdir = Metanorma::Utils::localdir(parent.document)
+        ldir = localdir(parent)
         imagesdir = parent.document.attr("imagesdir")
-        umlfile, outfile = save_plantuml parent, reader, localdir
+        umlfile, outfile = save_plantuml parent, reader, ldir
         run(umlfile, outfile) or
           raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
         umlfile.unlink
-
-        path = path_prep(localdir, imagesdir)
+        path = path_prep(ldir, imagesdir)
         filename = File.basename(outfile.to_s)
         FileUtils.cp(outfile, path) and outfile.unlink
-
         imagesdir ? filename : File.join(path, filename)
       end
 
+      def self.localdir(parent)
+        ret = Metanorma::Utils::localdir(parent.document)
+        File.writable?(ret) or
+          raise "Destination directory #{ret} not writable for PlantUML!"
+        ret
+      end
+
       def self.path_prep(localdir, imagesdir)
         path = Pathname.new(localdir) + (imagesdir || "plantuml")
-        File.writable?(localdir) or
-          raise "Destination path #{path} not writable for PlantUML!"
         path.mkpath
         File.writable?(path) or
           raise "Destination path #{path} not writable for PlantUML!"

data/lib/metanorma/standoc/utils.rb

@@ -108,6 +108,15 @@ module Metanorma
           .gsub("'", "'")
       end
 
+      SECTION_CONTAINERS =
+        %w(foreword introduction acknowledgements abstract
+           clause references terms definitions annex appendix indexsect 
+           executivesummary).freeze
+
+      def section_containers
+        SECTION_CONTAINERS
+      end
+
       # wrapped in <sections>
       def adoc2xml(text, flavour)
         Nokogiri::XML(text).root and return text

data/lib/metanorma/standoc/validate.rb

@@ -21,13 +21,14 @@ module Metanorma
         concept_validate(doc, "concept", "refterm")
         concept_validate(doc, "related", "preferred//name")
         preferred_validate(doc)
+        termsect_validate(doc)
         table_validate(doc)
         requirement_validate(doc)
         image_validate(doc)
         math_validate(doc)
         fatalerrors = @log.abort_messages
         fatalerrors.empty? or
-          clean_abort(fatalerrors.join("\n"), doc)
+          clean_abort("\n\nFATAL ERRROS:\n\n#{fatalerrors.join("\n\n")}", doc)
       end
 
       MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze

data/lib/metanorma/standoc/validate_section.rb

@@ -11,8 +11,8 @@ module Metanorma
 
       def sourcecode_style(root)
         root.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
+          callouts = x.xpath("./body/callout")
+          annotations = x.xpath("./annotation")
           callouts_error(x, callouts, annotations)
         end
       end

data/lib/metanorma/standoc/validate_term.rb

@@ -1,3 +1,5 @@
+require "iev"
+
 module Metanorma
   module Standoc
     module Validate
@@ -7,7 +9,7 @@ module Metanorma
       def init_iev
         @no_isobib and return nil
         @iev and return @iev
-        @iev = Iev::Db.new(@iev_globalname, @iev_localname) unless @no_isobib
+        @iev = ::Iev::Db.new(@iev_globalname, @iev_localname) unless @no_isobib
         @iev
       end
 
@@ -82,6 +84,36 @@ module Metanorma
           @log.add("Terms", v.first, err, severity: 1)
         end
       end
+
+      def find_illegal_designations(xmldoc)
+        xmldoc.xpath("//preferred | //admitted | //deprecates")
+          .each_with_object({}) do |d, m|
+          d.ancestors.detect { |x| x.name == "terms" } and next
+          c = d.ancestors.detect do |x|
+            section_containers.include?(x.name)
+          end
+          c["id"] ||= "_#{UUIDTools::UUID.random_create}"
+          m[c["id"]] ||= { clause: c, designations: [] }
+          m[c["id"]][:designations] << d
+        end
+      end
+
+      def termsect_validate(xmldoc)
+        errors = find_illegal_designations(xmldoc)
+        errors.each_value do |v|
+          desgns = v[:designations].map do |x|
+            @c.encode(x.text.strip,  :basic, :hexadecimal)
+          end.join(", ")
+          err = <<~ERROR
+            Clause not recognised as a term clause, but contains designation markup
+             (preferred:[], admitted:[], alt:[], deprecated:[]):<br/>
+            #{desgns}</br>
+            Ensure the parent clause is recognised as a terms clause by inserting <code>[heading=terms and definitions]</code> above the title,
+            in case the heading is not automatically recognised. See also <a href="https://www.metanorma.org/author/topics/sections/concepts/#clause-title">Metanorma documentation</a>.
+          ERROR
+          @log.add("Terms", v[:clause], err, severity: 0)
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.0.0".freeze
+    VERSION = "3.0.3".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.0.0"
+  spec.add_dependency "isodoc", "~> 3.1.0"
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.3.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.0"
@@ -40,12 +40,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "metanorma-utils", "~> 1.10.0"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma
-  spec.add_dependency "asciimath2unitsml", "~> 0.4.0"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "pngcheck"
   spec.add_dependency "relaton-cli", "~> 1.20.0"
   spec.add_dependency "relaton-iev", "~> 1.2.0"
-  spec.add_dependency "unicode2latex", "~> 0.0.1"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
@@ -53,8 +51,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 1.5.2"
-  spec.add_development_dependency "sassc", "2.4.0"
+  spec.add_development_dependency "rubocop", "~> 1"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "sassc-embedded", "~> 1"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 6.1.0"