metanorma-standoc 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f802ef3bf91b1b1af85aa22ca72569b6a6d74b29ed4389373e6b42e7d364b016
-  data.tar.gz: 55bd7031c2f7a2623955c9d1778b48a5a1666d15a0fe160a8058b544ffe60f92
+  metadata.gz: f5a985aefd39dadc19549ad39c23e0849bac873ea5883e50762ca911c8bd3aad
+  data.tar.gz: b7560f906a1e50fc4032f3261a44d1edcb2e691872b3e85d14a0363d7668b575
 SHA512:
-  metadata.gz: 59462520c525758884fdeac23103756b75908daf58707c25ed1420c3e7184e6c3cfaaa7ecd3770619cb3f5d7d9eedc9778b96980b5a33fcdedbea015da9e2684
-  data.tar.gz: ad562abbf62b1217ab40c933a1f32fe7dbbc474561c47ff0ed91c7de9e9262e3b0612393d8354eccacf30b034316635f5c84aa80f24cc2d5e6e5650bd918e485
+  metadata.gz: 437c04558d97c828a200ca21668a0e74e7e9fe5b5581ab759955f9ada241a0a87ccfddf114b7bd616430107e5869ce785c547715d627a08b87e35a30237b0516
+  data.tar.gz: 11d70602d2bd7733e9daab869ec22e3bf58ff6397378b38734711d46cb8f6e04b25e5b5fbcd3b5cd1e36b8e58a1061c92a87502fab945ea8a8c573205e25b126

data/lib/asciidoctor/standoc/base.rb

@@ -3,7 +3,6 @@ require "nokogiri"
 require "htmlentities"
 require "json"
 require "pathname"
-require "open-uri"
 require "isodoc"
 require "relaton"
 require "fileutils"

data/lib/asciidoctor/standoc/blocks.rb

@@ -41,7 +41,7 @@ module Asciidoctor
       def form(node)
         noko do |xml|
           xml.form **attr_code(
-            id: Metanorma::Utils::anchor_or_uuid,
+            id: Metanorma::Utils::anchor_or_uuid, class: node.attr("class"),
             name: node.attr("name"), action: node.attr("action")
           ) do |f|
             f << node.content

data/lib/asciidoctor/standoc/cleanup.rb

@@ -1,6 +1,5 @@
 require "nokogiri"
 require "pathname"
-require "open-uri"
 require "html2doc"
 require_relative "./cleanup_block"
 require_relative "./cleanup_footnotes"
@@ -48,6 +47,7 @@ module Asciidoctor
         xref_cleanup(xmldoc)
         concept_cleanup(xmldoc)
         origin_cleanup(xmldoc)
+        bookmark_cleanup(xmldoc)
         termdef_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
@@ -58,7 +58,6 @@ module Asciidoctor
         mathml_cleanup(xmldoc)
         script_cleanup(xmldoc)
         docidentifier_cleanup(xmldoc)
-        bookmark_cleanup(xmldoc)
         requirement_cleanup(xmldoc)
         bibdata_cleanup(xmldoc)
         svgmap_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -1,6 +1,5 @@
 require "date"
 require "htmlentities"
-require "open-uri"
 
 module Asciidoctor
   module Standoc

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -158,11 +158,11 @@ module Asciidoctor
           xmldoc.root << "<bibliography/>" and ins = xmldoc.at("bibliography")
         ins = ins.add_child("<references hidden='true' normative='false'/>").first
         refs.each do |x|
-          ins << <<~END
+          ins << <<~BIB
             <bibitem id="#{x}" type="internal">
             <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
             </bibitem>
-          END
+          BIB
         end
       end
 

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -1,7 +1,6 @@
 require "date"
 require "htmlentities"
 require "json"
-require "open-uri"
 
 module Asciidoctor
   module Standoc

data/lib/asciidoctor/standoc/cleanup_maths.rb

@@ -1,6 +1,5 @@
 require "nokogiri"
 require "pathname"
-require "open-uri"
 require "html2doc"
 require "asciimath2unitsml"
 require_relative "./cleanup_block"

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -1,7 +1,6 @@
 require "date"
 require "htmlentities"
 require "json"
-require "open-uri"
 require "mathml2asciimath"
 require_relative "cleanup_section_names"
 

data/lib/asciidoctor/standoc/converter.rb

@@ -37,6 +37,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::VariantInlineMacro
         inline_macro Asciidoctor::Standoc::FootnoteBlockInlineMacro
         inline_macro Asciidoctor::Standoc::TermRefInlineMacro
+        inline_macro Asciidoctor::Standoc::SymbolRefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
         inline_macro Asciidoctor::Standoc::AddMacro

data/lib/asciidoctor/standoc/front.rb

@@ -2,7 +2,6 @@ require "date"
 require "nokogiri"
 require "htmlentities"
 require "pathname"
-require "open-uri"
 require_relative "./front_contributor"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -2,7 +2,6 @@ require "date"
 require "nokogiri"
 require "htmlentities"
 require "pathname"
-require "open-uri"
 require "csv"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/isodoc.rng

@@ -204,6 +204,18 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="dt">
+      <element name="dt">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="TextElement"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="example">
       <element name="example">
         <attribute name="id">
@@ -899,7 +911,7 @@
   </include>
   <!-- end overrides -->
   <define name="docsubtype">
-    <element name="docsubtype">
+    <element name="subdoctype">
       <ref name="DocumentSubtype"/>
     </element>
   </define>
@@ -954,6 +966,16 @@
   </define>
   <define name="concept">
     <element name="concept">
+      <optional>
+        <attribute name="ital">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="ref">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <element name="refterm">
           <zeroOrMore>
@@ -998,6 +1020,9 @@
       </attribute>
       <attribute name="name"/>
       <attribute name="action"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
       <zeroOrMore>
         <choice>
           <ref name="TextElement"/>
@@ -1490,26 +1515,26 @@
     <optional>
       <ref name="section-title"/>
     </optional>
-    <group>
+    <choice>
       <choice>
         <group>
-          <zeroOrMore>
+          <oneOrMore>
             <ref name="BasicBlock"/>
-          </zeroOrMore>
+          </oneOrMore>
           <zeroOrMore>
             <ref name="note"/>
           </zeroOrMore>
         </group>
         <ref name="amend"/>
       </choice>
-      <zeroOrMore>
+      <oneOrMore>
         <choice>
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
         </choice>
-      </zeroOrMore>
-    </group>
+      </oneOrMore>
+    </choice>
   </define>
   <define name="Annex-Section">
     <optional>

data/lib/asciidoctor/standoc/macros.rb

@@ -75,7 +75,7 @@ module Asciidoctor
       def supply_br(lines)
         ignore = false
         lines.each_with_index do |l, i|
-          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/
+          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|````+|____\+)$/
             .match(l) && (ignore = !ignore)
           next if l.empty? || l.match(/ \+$/) || /^\[.*\]$/.match?(l) || ignore
           next if i == lines.size - 1 ||
@@ -107,7 +107,7 @@ module Asciidoctor
         if (attributes.size == 1) && attributes.key?("text")
           rt = attributes["text"]
         elsif (attributes.size == 2) && attributes.key?(1) &&
-          attributes.key?("rpbegin")
+            attributes.key?("rpbegin")
           rt = attributes[1] || ""
         else
           rpbegin = attributes["rpbegin"]
@@ -143,7 +143,7 @@ module Asciidoctor
           para.set_attr("caption", "TODO")
           para.lines[0].sub!(/^TODO: /, "")
           todo = Block.new(parent, :admonition, attributes: para.attributes,
-                           source: para.lines, content_model: :compound)
+                                                source: para.lines, content_model: :compound)
           parent.blocks[parent.blocks.index(para)] = todo
         end
       end
@@ -168,9 +168,11 @@ module Asciidoctor
       def process(parent, target, attrs)
         /^(?<lang>[^-]*)(-(?<script>.*))?$/ =~ target
         out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        script ?
-          %{<variant lang=#{lang} script=#{script}>#{out}</variant>} :
+        if script
+          %{<variant lang=#{lang} script=#{script}>#{out}</variant>}
+        else
           %{<variant lang=#{lang}>#{out}</variant>}
+        end
       end
     end
 

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -12,7 +12,6 @@ module Asciidoctor
           end
         end
         raise "PlantUML not installed"
-        nil
       end
 
       def self.run(umlfile, outfile)
@@ -59,7 +58,7 @@ module Asciidoctor
         Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
           f.write(src)
           [f, File.join(File.dirname(f.path),
-                        (fn || File.basename(f.path, ".pml")) + ".png")]
+                        "#{fn || File.basename(f.path, '.pml')}.png")]
         end
       end
 
@@ -81,7 +80,8 @@ module Asciidoctor
       def abort(parent, reader, attrs, msg)
         warn msg
         attrs["language"] = "plantuml"
-        create_listing_block parent, reader.source, attrs.reject { |k, _v| k == 1 }
+        create_listing_block parent, reader.source,
+                             (attrs.reject { |k, _v| k == 1 })
       end
 
       def process(parent, reader, attrs)

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -46,7 +46,20 @@ module Asciidoctor
 
       def process(_parent, _target, attrs)
         termref = attrs["termxref"] || attrs["name"]
-        "<concept><termxref>#{attrs['name']}</termxref>"\
+        "<concept type='term'><termxref>#{attrs['name']}</termxref>"\
+          "<renderterm>#{termref}</renderterm><xrefrender/></concept>"
+      end
+    end
+
+    class SymbolRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :symbol
+      name_positional_attributes "name", "termxref"
+      using_format :short
+
+      def process(_parent, _target, attrs)
+        termref = attrs["termxref"] || attrs["name"]
+        "<concept type='symbol'><termxref>#{attrs['name']}</termxref>"\
           "<renderterm>#{termref}</renderterm><xrefrender/></concept>"
       end
     end
@@ -68,24 +81,38 @@ module Asciidoctor
       def preprocess_attrs(target)
         m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/.match(target)
         ret = { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;$/, "") }
-        m2 = /^(?<rest>.*)(?<opt>,option=.+)?$/.match(m[:rest].sub(/^,/, ""))
-        ret[:opt] = m2[:opt]&.sub(/^,option=/, "")
-        attrs = CSV.parse_line(m2[:rest]) || []
+        if m2 = /^(?<rest>.*?)(?<opt>,option=.+)$/.match(m[:rest].sub(/^,/, ""))
+          ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,option=/, "")
+            .sub(/^"(.+)"$/, "\\1").sub(/^'(.+)'$/, "\\1"))
+          attrs = CSV.parse_line(m2[:rest]) || []
+        else
+          attrs = CSV.parse_line(m[:rest].sub(/^,/, "")) || []
+        end
         ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
                   xrefrender: attrs[2])
       end
 
+      def generate_attrs(opts)
+        ret = ""
+        opts.include?("noital") and ret += " ital='false'"
+        opts.include?("noref") and ret += " ref='false'"
+        opts.include?("ital") and ret += " ital='true'"
+        opts.include?("ref") and ret += " ref='true'"
+        ret
+      end
+
       def process(parent, target, _attrs)
         attrs = preprocess_attrs(target)
         termout = Asciidoctor::Inline.new(parent, :quoted, attrs[:term]).convert
         wordout = Asciidoctor::Inline.new(parent, :quoted, attrs[:word]).convert
         xrefout = Asciidoctor::Inline.new(parent, :quoted,
                                           attrs[:xrefrender]).convert
-        attrs[:id] and return "<concept key='#{attrs[:id]}'><refterm>"\
+        optout = generate_attrs(attrs[:opt] || [])
+        attrs[:id] and return "<concept#{optout} key='#{attrs[:id]}'><refterm>"\
           "#{termout}</refterm><renderterm>#{wordout}</renderterm>"\
           "<xrefrender>#{xrefout}</xrefrender></concept>"
-        "<concept><termxref>#{termout}</termxref><renderterm>#{wordout}"\
-          "</renderterm><xrefrender>#{xrefout}</xrefrender></concept>"
+        "<concept#{optout}><termxref>#{termout}</termxref><renderterm>"\
+          "#{wordout}</renderterm><xrefrender>#{xrefout}</xrefrender></concept>"
       end
     end
   end

data/lib/asciidoctor/standoc/section.rb

@@ -12,7 +12,7 @@ module Asciidoctor
       def sectiontype1(node)
         node&.attr("heading")&.downcase ||
           node.title.gsub(%r{<index>.*?</index>}m, "").gsub(/<[^>]+>/, "")
-          .strip.downcase
+            .strip.downcase
       end
 
       def sectiontype(node, level = true)
@@ -21,6 +21,7 @@ module Asciidoctor
         return ret1 if "symbols and abbreviated terms" == ret1
         return nil unless !level || node.level == 1
         return nil if @seen_headers.include? ret
+
         @seen_headers << ret
         ret1
       end
@@ -48,11 +49,14 @@ module Asciidoctor
                 script: node.attributes["script"],
                 number: node.attributes["number"],
                 type: node.attributes["type"],
-                annex: ( ((node.attr("style") == "appendix" || node.role == "appendix") && 
-                          node.level == 1) ? true : nil),
-                         preface: (
-                           (node.role == "preface" || node.attr("style") == "preface") ?  true : nil) }
+                annex: (if (node.attr("style") == "appendix" || node.role == "appendix") &&
+                          node.level == 1
+                          true
+                        end),
+                preface: (
+                           node.role == "preface" || node.attr("style") == "preface" ? true : nil) }
         return ret unless node.attributes["change"]
+
         ret.merge(change: node.attributes["change"],
                   path: node.attributes["path"],
                   path_end: node.attributes["path_end"],
@@ -75,7 +79,7 @@ module Asciidoctor
             symbols_parse(symbols_attrs(node, a), xml, node)
           when "acknowledgements"
             acknowledgements_parse(a, xml, node)
-          when "bibliography" 
+          when "bibliography"
             bibliography_parse(a, xml, node)
           else
             if @term_def then term_def_subclause_parse(a, xml, node)
@@ -88,9 +92,9 @@ module Asciidoctor
               bibliography_parse(a, xml, node)
             elsif node.attr("style") == "bibliography"
               bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "abstract" 
+            elsif node.attr("style") == "abstract"
               abstract_parse(a, xml, node)
-            elsif node.attr("style") == "index" 
+            elsif node.attr("style") == "index"
               indexsect_parse(a, xml, node)
             elsif node.attr("style") == "appendix" && node.level == 1
               annex_parse(a, xml, node)
@@ -102,10 +106,13 @@ module Asciidoctor
       end
 
       def set_obligation(attrs, node)
-        attrs[:obligation] = node.attributes.has_key?("obligation") ?
-          node.attr("obligation") :
-          node.parent.attributes.has_key?("obligation") ?
-          node.parent.attr("obligation") : "normative"
+        attrs[:obligation] = if node.attributes.has_key?("obligation")
+                               node.attr("obligation")
+                             elsif node.parent.attributes.has_key?("obligation")
+                               node.parent.attr("obligation")
+                             else
+                               "normative"
+                             end
       end
 
       def preamble(node)

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -6,13 +6,14 @@ module Asciidoctor
     class TermLookupCleanup
       AUTOMATIC_GENERATED_ID_REGEXP = /\A_/.freeze
       EXISTING_TERM_REGEXP = /\Aterm-/.freeze
+      EXISTING_SYMBOL_REGEXP = /\Asymbol-/.freeze
 
       attr_reader :xmldoc, :termlookup, :log
 
       def initialize(xmldoc, log)
         @xmldoc = xmldoc
         @log = log
-        @termlookup = {}
+        @termlookup = { term: {}, symbol: {} }
         @idhash = {}
       end
 
@@ -20,13 +21,20 @@ module Asciidoctor
         @idhash = populate_idhash
         @termlookup = replace_automatic_generated_ids_terms
         set_termxref_tags_target
+        concept_cleanup
       end
 
       private
 
+      def concept_cleanup
+        xmldoc.xpath("//concept").each do |n|
+          n.delete("type")
+        end
+      end
+
       def populate_idhash
         xmldoc.xpath("//*[@id]").each_with_object({}) do |n, mem|
-          next unless /^term-/.match?(n["id"])
+          next unless /^(term|symbol)-/.match?(n["id"])
 
           mem[n["id"]] = true
         end
@@ -35,7 +43,7 @@ module Asciidoctor
       def set_termxref_tags_target
         xmldoc.xpath("//termxref").each do |node|
           target = normalize_ref_id(node.text)
-          if termlookup[target].nil?
+          if termlookup[:term][target].nil? && termlookup[:symbol][target].nil?
             remove_missing_ref(node, target)
             next
           end
@@ -46,6 +54,14 @@ module Asciidoctor
       end
 
       def remove_missing_ref(node, target)
+        if node.at("../concept[@type = 'symbol']")
+          remove_missing_ref_symbol(node, target)
+        else
+          remove_missing_ref_term(node, target)
+        end
+      end
+
+      def remove_missing_ref_term(node, target)
         log.add("AsciiDoc Input", node,
                 %(Error: Term reference in `term[#{target}]` missing: \
                 "#{target}" is not defined in document))
@@ -58,39 +74,64 @@ module Asciidoctor
           "not resolved via ID <tt>#{target}</tt>"
       end
 
+      def remove_missing_ref_symbol(node, target)
+        log.add("AsciiDoc Input", node,
+                %(Error: Symbol reference in `symbol[#{target}]` missing: \
+                "#{target}" is not defined in document))
+        node.name = "strong"
+        node.at("../xrefrender").remove
+        display = node&.at("../renderterm")&.remove&.children
+        display = [] if display.nil? || display&.to_xml == node.text
+        d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
+        node.children = "symbol <tt>#{node.text}</tt>#{d} "\
+          "not resolved via ID <tt>#{target}</tt>"
+      end
+
       def modify_ref_node(node, target)
         node.name = "xref"
-        node["target"] = termlookup[target]
+        s = termlookup[:symbol][target]
+        t = termlookup[:term][target]
+        type = node.parent["type"]
+        if type == "term" || !type && t
+          node["target"] = t
+        elsif type == "symbol" || !type && s
+          node["target"] = s
+        end
       end
 
       def replace_automatic_generated_ids_terms
-        xmldoc.xpath("//term").each.with_object({}) do |term_node, res|
-          normalize_id_and_memorize(term_node, res, "./preferred")
+        r = xmldoc.xpath("//term").each.with_object({}) do |n, res|
+          normalize_id_and_memorize(n, res, "./preferred", "term")
+        end
+        s = xmldoc.xpath("//definitions//dt").each.with_object({}) do |n, res|
+          normalize_id_and_memorize(n, res, ".", "symbol")
         end
+        { term: r, symbol: s }
       end
 
-      def normalize_id_and_memorize(term_node, res_table, text_selector)
-        term_text = normalize_ref_id(term_node.at(text_selector).text)
-        unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node["id"]).nil?
-          id = unique_text_id(term_text)
-          term_node["id"] = id
+      def normalize_id_and_memorize(node, res_table, text_selector, prefix)
+        term_text = normalize_ref_id(node.at(text_selector).text)
+        unless AUTOMATIC_GENERATED_ID_REGEXP.match(node["id"]).nil? &&
+            !node["id"].nil?
+          id = unique_text_id(term_text, prefix)
+          node["id"] = id
           @idhash[id] = true
         end
-        res_table[term_text] = term_node["id"]
+        res_table[term_text] = node["id"]
       end
 
       def normalize_ref_id(text)
         text.downcase.gsub(/[[:space:]]/, "-")
       end
 
-      def unique_text_id(text)
-        unless @idhash["term-#{text}"]
-          return "term-#{text}"
+      def unique_text_id(text, prefix)
+        unless @idhash["#{prefix}-#{text}"]
+          return "#{prefix}-#{text}"
         end
 
         (1..Float::INFINITY).lazy.each do |index|
-          unless @idhash["term-#{text}-#{index}"]
-            break("term-#{text}-#{index}")
+          unless @idhash["#{prefix}-#{text}-#{index}"]
+            break("#{prefix}-#{text}-#{index}")
           end
         end
       end