metanorma-standoc 1.11.0 → 1.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c272a7b64955264d820737284d46d47a03d7baaf56d0a365396a5a2cb5455ac
-  data.tar.gz: b04e30dd2633c21853ff81aaa14ddff65ddca564e4878a1914507ba7f4d43294
+  metadata.gz: 7756f8b45a6897bf3a40e48df348a746bc75b30820597fa8ceadedcbbceb89d9
+  data.tar.gz: e62b62dd699df95d46bd13c18656bf3504c3a34936ff0a094d224d12a9f44987
 SHA512:
-  metadata.gz: 00117f839c229ac456a92d59ea8d7d17fbdb2dc680098126fc77c67696ae1c84cd70e3785a3b9e15c055588678a8d4a27fa1d2069431b38fa83c25fe20885d1d
-  data.tar.gz: 78bf3e8ef72cc04f40c3a98cfbf29e14176f04ff1cbade1f299c9a3c284e303d481574f7f1b07ba7fa8cd769a32f6d05b745f550c43ea648c0d354ef3ae8d5ad
+  metadata.gz: 9776d2bfd161b5500e5ac9e8ea47a9597befe1642880a18fdc86839ceee0688e879d37de0bd9000420294f6a0094f455c840643e091a11da0b65489434a44bf9
+  data.tar.gz: 4f4d5f119ce92541ee1a89320fdc094352f3ca2ac885f1d52438279e4f70b995d0f87b4f7d034bafc63f05e2192b9ae8b7f4063dd1972525d773ec2f66e27dd1

data/Gemfile

@@ -9,3 +9,5 @@ gemspec
 if File.exist? 'Gemfile.devel'
   eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
 end
+
+gem "reline", "~> 0.2.8.pre.11"

data/lib/asciidoctor/standoc/base.rb

@@ -8,6 +8,7 @@ require "relaton"
 require "fileutils"
 require "metanorma-utils"
 require "isodoc/xslfo_convert"
+require_relative "render"
 
 module Asciidoctor
   module Standoc
@@ -24,85 +25,6 @@ module Asciidoctor
         self.class::XML_NAMESPACE
       end
 
-      def html_extract_attributes(node)
-        {
-          script: node.attr("script"),
-          bodyfont: node.attr("body-font"),
-          headerfont: node.attr("header-font"),
-          monospacefont: node.attr("monospace-font"),
-          i18nyaml: node.attr("i18nyaml"),
-          scope: node.attr("scope"),
-          htmlstylesheet: node.attr("htmlstylesheet"),
-          htmlstylesheet_override: node.attr("htmlstylesheet-override"),
-          htmlcoverpage: node.attr("htmlcoverpage"),
-          htmlintropage: node.attr("htmlintropage"),
-          scripts: node.attr("scripts"),
-          scripts_override: node.attr("scripts-override"),
-          scripts_pdf: node.attr("scripts-pdf"),
-          datauriimage: node.attr("data-uri-image") != "false",
-          htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
-          doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
-          break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
-          suppressasciimathdup: node.attr("suppress-asciimath-dup"),
-          bare: node.attr("bare"),
-          sectionsplit: node.attr("sectionsplit"),
-          baseassetpath: node.attr("base-asset-path"),
-          aligncrosselements: node.attr("align-cross-elements"),
-        }
-      end
-
-      def html_converter(node)
-        IsoDoc::HtmlConvert.new(html_extract_attributes(node))
-      end
-
-      def pdf_converter(node)
-        return nil if node.attr("no-pdf")
-
-        IsoDoc::Standoc::PdfConvert.new(doc_extract_attributes(node))
-      end
-
-      def doc_extract_attributes(node)
-        attrs = {
-          script: node.attr("script"),
-          bodyfont: node.attr("body-font"),
-          headerfont: node.attr("header-font"),
-          monospacefont: node.attr("monospace-font"),
-          i18nyaml: node.attr("i18nyaml"),
-          scope: node.attr("scope"),
-          wordstylesheet: node.attr("wordstylesheet"),
-          wordstylesheet_override: node.attr("wordstylesheet-override"),
-          standardstylesheet: node.attr("standardstylesheet"),
-          header: node.attr("header"),
-          wordcoverpage: node.attr("wordcoverpage"),
-          wordintropage: node.attr("wordintropage"),
-          ulstyle: node.attr("ulstyle"),
-          olstyle: node.attr("olstyle"),
-          htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
-          doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
-          break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
-          suppressasciimathdup: node.attr("suppress-asciimath-dup"),
-          bare: node.attr("bare"),
-          baseassetpath: node.attr("base-asset-path"),
-          aligncrosselements: node.attr("align-cross-elements"),
-        }
-
-        if fonts_manifest = node.attr(FONTS_MANIFEST)
-          attrs[IsoDoc::XslfoPdfConvert::MN2PDF_OPTIONS] = {
-            IsoDoc::XslfoPdfConvert::MN2PDF_FONT_MANIFEST => fonts_manifest,
-          }
-        end
-
-        attrs
-      end
-
-      def doc_converter(node)
-        IsoDoc::WordConvert.new(doc_extract_attributes(node))
-      end
-
-      def presentation_xml_converter(node)
-        IsoDoc::PresentationXMLConvert.new(html_extract_attributes(node))
-      end
-
       def init(node)
         @fn_number ||= 0
         @draft = false
@@ -124,6 +46,7 @@ module Asciidoctor
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
         @no_isobib = node.attr("no-isobib")
+        @index_terms = node.attr("index-terms")
         @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
         @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
         @bibdb = nil
@@ -136,31 +59,12 @@ module Asciidoctor
         init_bib_caches(node)
         init_iev_caches(node)
         @lang = (node.attr("language") || "en")
-        @script = (node.attr("script") || default_script(node.attr("language")))
+        @script = (node.attr("script") ||
+                   Metanorma::Utils.default_script(node.attr("language")))
         @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
         @i18n = @isodoc.i18n
       end
 
-      def default_fonts(node)
-        b = node.attr("body-font") ||
-          (node.attr("script") == "Hans" ? '"Source Han Sans",serif' : '"Cambria",serif')
-        h = node.attr("header-font") ||
-          (node.attr("script") == "Hans" ? '"Source Han Sans",sans-serif' : '"Cambria",serif')
-        m = node.attr("monospace-font") || '"Courier New",monospace'
-        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
-      end
-
-      def outputs(node, ret)
-        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert("#{@filename}.xml")
-        html_converter(node).convert("#{@filename}.presentation.xml",
-                                     nil, false, "#{@filename}.html")
-        doc_converter(node).convert("#{@filename}.presentation.xml",
-                                    nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
-                                     nil, false, "#{@filename}.pdf")
-      end
-
       def document(node)
         init(node)
         ret = makexml(node).to_xml(encoding: "US-ASCII", indent: 2)

data/lib/asciidoctor/standoc/blocks.rb

@@ -1,5 +1,5 @@
 require "htmlentities"
-require "uri"
+require "uri" if /^2\./.match?(RUBY_VERSION)
 require_relative "./blocks_notes"
 
 module Asciidoctor

data/lib/asciidoctor/standoc/cleanup.rb

@@ -48,6 +48,7 @@ module Asciidoctor
         termdef_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
+        index_cleanup(xmldoc)
         bpart_cleanup(xmldoc)
         quotesource_cleanup(xmldoc)
         callout_cleanup(xmldoc)
@@ -76,7 +77,7 @@ module Asciidoctor
            street city state country postcode identifier referenceFrom surname
            referenceTo docidentifier docnumber prefix initial addition forename
            title draft secretariat title-main title-intro title-part
-           verbaldefinition nonverbalrepresentation}.freeze
+           verbal-definition non-verbal-representation}.freeze
 
       # it seems Nokogiri::XML is treating the content of <script> as cdata,
       # because of its use in HTML. Bad nokogiri. Undoing that, since we use

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -89,8 +89,7 @@ module Asciidoctor
       def note_cleanup(xmldoc)
         q = "//note[following-sibling::*[not(local-name() = 'note')]]"
         xmldoc.xpath(q).each do |n|
-          next if n["keep-separate"] == "true"
-          next unless n.ancestors("table").empty?
+          next if n["keep-separate"] == "true" || !n.ancestors("table").empty?
 
           prev = n.previous_element || next
           n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -15,15 +15,18 @@ module Asciidoctor
         )
       end
 
-      def term_defs_boilerplate(div, source, term, preface, isodoc)
+      def term_defs_boilerplate(div, source, term, _preface, isodoc)
         a = @i18n.term_def_boilerplate and div.next = a
         source.each do |s|
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil,
                      "term source #{s['bibitemid']} not referenced")
         end
-        a = source.empty? && term.nil? ?  @i18n.no_terms_boilerplate :
-          term_defs_boilerplate_cont(source, term, isodoc)
+        a = if source.empty? && term.nil?
+              @i18n.no_terms_boilerplate
+            else
+              term_defs_boilerplate_cont(source, term, isodoc)
+            end
         a and div.next = a
       end
 
@@ -51,10 +54,11 @@ module Asciidoctor
       end
 
       TERM_CLAUSE = "//sections/terms | "\
-        "//sections/clause[descendant::terms]".freeze
+                    "//sections/clause[descendant::terms]".freeze
 
       NORM_REF = "//bibliography/references[@normative = 'true'] | "\
-        "//bibliography/clause[.//references[@normative = 'true']]".freeze
+                 "//bibliography/clause[.//references[@normative = 'true']]"
+        .freeze
 
       def boilerplate_isodoc(xmldoc)
         x = xmldoc.dup
@@ -118,8 +122,11 @@ module Asciidoctor
 
       def boilerplate(xml, conv)
         file = boilerplate_file(xml)
-        file = File.join(@localdir, @boilerplateauthority) if @boilerplateauthority
-        !file.nil? and File.exists?(file) or return
+        if @boilerplateauthority
+          file = File.join(@localdir,
+                           @boilerplateauthority)
+        end
+        (!file.nil? and File.exists?(file)) or return
         conv.populate_template(File.read(file, encoding: "UTF-8"), nil)
       end
 
@@ -166,28 +173,29 @@ module Asciidoctor
         end
       end
 
-      def indirect_eref_to_xref(e, id)
-        loc = e&.at("./localityStack[locality[@type = 'anchor']]")&.remove&.text ||
-          e&.at("./locality[@type = 'anchor']")&.remove&.text || id
-        e.name = "xref"
-        e.delete("bibitemid")
-        e.delete("citeas")
-        e["target"] = loc
-        unless e.document.at("//*[@id = '#{loc}']")
-          e.children = %(** Missing target #{loc})
-          e["target"] = id
+      def indirect_eref_to_xref(eref, ident)
+        loc = eref&.at("./localityStack[locality[@type = 'anchor']]")
+          &.remove&.text ||
+          eref&.at("./locality[@type = 'anchor']")&.remove&.text || ident
+        eref.name = "xref"
+        eref.delete("bibitemid")
+        eref.delete("citeas")
+        eref["target"] = loc
+        unless eref.document.at("//*[@id = '#{loc}']")
+          eref.children = %(** Missing target #{loc})
+          eref["target"] = ident
         end
       end
 
       def resolve_local_indirect_erefs(xmldoc, refs, prefix)
         refs.each_with_object([]) do |r, m|
           id = r.sub(/^#{prefix}_/, "")
-          if n = xmldoc.at("//*[@id = '#{id}']") and n.at("./ancestor-or-self::*[@type = '#{prefix}']")
+          if n = xmldoc.at("//*[@id = '#{id}']") and
+              n.at("./ancestor-or-self::*[@type = '#{prefix}']")
             xmldoc.xpath("//eref[@bibitemid = '#{r}']").each do |e|
               indirect_eref_to_xref(e, id)
             end
-          else
-            m << r
+          else m << r
           end
         end
       end

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -159,15 +159,25 @@ module Asciidoctor
       end
 
       def contenthash_id_cleanup(doc)
-        ids = doc.xpath("//*[@id]").each_with_object({}) do |x, m|
+        ids = contenthash_id_make(doc)
+        contenthash_id_update_refs(doc, ids)
+      end
+
+      def contenthash_id_make(doc)
+        doc.xpath("//*[@id]").each_with_object({}) do |x, m|
           next unless guid?(x["id"])
 
           m[x["id"]] = contenthash(x)
           x["id"] = m[x["id"]]
         end
-        [%w(review from), %(review to), %(callout target), %(eref bibitemid),
-         %(citation bibitemid), %(xref target), %(xref to)].each do |a|
-          doc.xpath("//#{a[0]}").each { |x| ids[a[1]] and x[a[1]] = ids[a[1]] }
+      end
+
+      def contenthash_id_update_refs(doc, ids)
+        [%w(review from), %w(review to), %w(callout target), %w(eref bibitemid),
+         %w(citation bibitemid), %w(xref target), %w(xref to)].each do |a|
+          doc.xpath("//#{a[0]}").each do |x|
+            ids[x[a[1]]] and x[a[1]] = ids[x[a[1]]]
+          end
         end
       end
 

data/lib/asciidoctor/standoc/cleanup_ref_dl.rb

@@ -17,45 +17,53 @@ module Asciidoctor
 
       def validate_ref_dl(bib, c)
         id = bib["id"]
-        id ||= c["id"] unless /^_/.match(c["id"]) # do not accept implicit id
+        id ||= c["id"] unless /^_/.match?(c["id"]) # do not accept implicit id
         unless id
-          @log.add("Anchors", c, "The following reference is missing an anchor:\n" + c.to_xml)
+          @log.add("Anchors", c,
+                   "The following reference is missing an anchor:\n" + c.to_xml)
           return
         end
         @refids << id
-        bib["title"] or @log.add("Bibliography", c, "Reference #{id} is missing a title")
-        bib["docid"] or @log.add("Bibliography", c, "Reference #{id} is missing a document identifier (docid)")
+        bib["title"] or
+          @log.add("Bibliography", c, "Reference #{id} is missing a title")
+        bib["docid"] or
+          @log.add("Bibliography", c,
+                   "Reference #{id} is missing a document identifier (docid)")
       end
 
       def extract_from_p(tag, bib, key)
         return unless bib[tag]
+
         "<#{key}>#{bib[tag].at('p').children}</#{key}>"
       end
 
       # if the content is a single paragraph, replace it with its children
       # single links replaced with uri
-      def p_unwrap(p)
-        elems = p.elements
+      def p_unwrap(para)
+        elems = para.elements
         if elems.size == 1 && elems[0].name == "p"
           link_unwrap(elems[0]).children.to_xml.strip
         else
-          p.to_xml.strip
+          para.to_xml.strip
         end
       end
 
-      def link_unwrap(p)
-        elems = p.elements
+      def link_unwrap(para)
+        elems = para.elements
         if elems.size == 1 && elems[0].name == "link"
-          p.at("./link").replace(elems[0]["target"].strip)
+          para.at("./link").replace(elems[0]["target"].strip)
         end
-        p
+        para
       end
 
       def dd_bib_extract(dtd)
         return nil if dtd.children.empty?
+
         dtd.at("./dl") and return dl_bib_extract(dtd)
         elems = dtd.remove.elements
-        return p_unwrap(dtd) unless elems.size == 1 && %w(ol ul).include?(elems[0].name)
+        return p_unwrap(dtd) unless elems.size == 1 &&
+          %w(ol ul).include?(elems[0].name)
+
         ret = []
         elems[0].xpath("./li").each do |li|
           ret << p_unwrap(li)
@@ -64,7 +72,7 @@ module Asciidoctor
       end
 
       def add_to_hash(bib, key, val)
-        Metanorma::Utils::set_nested_value(bib, key.split(/\./), val)
+        Metanorma::Utils::set_nested_value(bib, key.split("."), val)
       end
 
       # definition list, with at most one level of unordered lists
@@ -73,14 +81,16 @@ module Asciidoctor
         bib = {}
         key = ""
         dl.xpath("./dt | ./dd").each do |dtd|
-          dtd.name == "dt" and key = dtd.text.sub(/:+$/, "") or add_to_hash(bib, key, dd_bib_extract(dtd))
+          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) or
+            add_to_hash(bib, key, dd_bib_extract(dtd))
         end
         c.xpath("./clause").each do |c1|
           key = c1&.at("./title")&.text&.downcase&.strip
           next unless %w(contributor relation series).include? key
+
           add_to_hash(bib, key, dl_bib_extract(c1, true))
         end
-        if !nested and c.at("./title")
+        if !nested && c.at("./title")
           title = c.at("./title").remove.children.to_xml
           bib["title"] = [bib["title"]] if bib["title"].is_a? Hash
           bib["title"] = [bib["title"]] if bib["title"].is_a? String

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -48,10 +48,10 @@ module Asciidoctor
       end
 
       def requirement_description_wrap(reqt, text)
-        return if text.element? && (reqt_subpart(text.name) ||
+        return if (text.element? && (reqt_subpart(text.name) ||
                 %w(requirement recommendation
-                   permission).include?(text.name)) ||
-          text.text.strip.empty?
+                   permission).include?(text.name))) ||
+          (text.text.strip.empty? && !text.at(".//xref | .//eref | .//link"))
 
         t = Nokogiri::XML::Element.new("description", reqt)
         text.before(t)

data/lib/asciidoctor/standoc/cleanup_section_names.rb

@@ -21,7 +21,7 @@ module Asciidoctor
           title = get_or_make_title(node)
           fn = title.xpath("./fn")
           fn.each(&:remove)
-          title.content = text
+          title.children = text
           fn.each { |n| title << n }
         end
       end
@@ -82,7 +82,7 @@ module Asciidoctor
           p.delete("id")
           p.delete("variant_title")
           p.xpath("(#{path})[last()]").each do |sect|
-            ins = sect.at("./title") and ins.next = p or
+            (ins = sect.at("./title") and ins.next = p) or
               sect.children.first.previous = p
           end
         end

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -6,14 +6,16 @@ module Asciidoctor
     module Cleanup
       def termdomain_cleanup(xmldoc)
         xmldoc.xpath("//p/domain").each do |a|
-          prev = a.parent.previous
+          parent = a.parent
+          prev = parent.previous
           prev.next = a.remove
+          parent.text.strip.empty? and parent.remove
         end
       end
 
       def termdomain1_cleanup(xmldoc)
         xmldoc.xpath("//term").each do |t|
-          d = t.xpath("./domain | ./subject | ./usageinfo").last or next
+          d = t.xpath("./domain | ./subject").last or next
           defn = d.at("../definition") and defn.previous = d.remove
         end
       end
@@ -21,32 +23,46 @@ module Asciidoctor
       def termdefinition_cleanup(xmldoc)
         generate_termdefinitions(xmldoc)
         split_termdefinitions(xmldoc)
+        alternate_termdefinitions(xmldoc)
       end
 
+      TERMDEF_BLOCKS =
+        "./p | ./ol | ./dl[not(@metadata = 'true')] | ./ul | ./figure | "\
+        "./formula | ./table".freeze
+
       def generate_termdefinitions(xmldoc)
         xmldoc.xpath("//term[not(definition)]").each do |d|
-          first_child = d.at("./p | ./figure | ./formula | ./table") || next
+          first_child = d.at(TERMDEF_BLOCKS) || next
           t = Nokogiri::XML::Element.new("definition", xmldoc)
           first_child.replace(t)
           t << first_child.remove
-          d.xpath("./p | ./figure | ./formula | ./table").each { |n| t << n.remove }
+          d.xpath(TERMDEF_BLOCKS).each do |n|
+            t << n.remove
+          end
         end
       end
 
       def split_termdefinitions(xmldoc)
         xmldoc.xpath("//definition").each do |d|
-          n = d.children.first.add_previous_sibling("<nonverbalrepresentation/>").first
-          v = d.children.first.add_previous_sibling("<verbaldefinition/>").first
-          nonverb = false
-          d.elements.each do |e|
-            case e.name
-            when "nonverbalrepresentation", "verbaldefinition" then next
-            when "figure", "table", "formula"
-              n << e.remove
-              nonverb = true
-            when "termsource"
-              (nonverb ? n : v) << e.remove
-            else v << e.remove
+          if d.at("./p | ./ol | ./dl | ./ul")
+            d.children = "<verbal-definition>#{d.children}</verbal-definition>"
+          else
+            d.children = "<non-verbal-representation>"\
+                         "#{d.children}</non-verbal-representation>"
+          end
+        end
+      end
+
+      def alternate_termdefinitions(xmldoc)
+        xmldoc.xpath("//term").each do |t|
+          t.xpath("./definition").each do |d|
+            d1 = d.next_element or next
+            if (v = d.at("./verbal-definition")) &&
+                !d.at("./non-verbal-representation") &&
+                !d1.at("./verbal-definition") &&
+                nv = d1.at("./non-verbal-representation")
+              v.next = nv.remove
+              d1.remove
             end
           end
         end
@@ -60,7 +76,7 @@ module Asciidoctor
       def term_children_cleanup(xmldoc)
         xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
         xmldoc.xpath("//term").each do |t|
-          %w(termnote termexample termsource).each do |w|
+          %w(termnote termexample termsource term).each do |w|
             t.xpath("./#{w}").each { |n| t << n.remove }
           end
         end
@@ -76,9 +92,9 @@ module Asciidoctor
 
       def termnote_example_cleanup(xmldoc)
         %w(note example).each do |w|
-        xmldoc.xpath("//term#{w}[not(ancestor::term)]").each do |x|
-          x.name = w
-        end
+          xmldoc.xpath("//term#{w}[not(ancestor::term)]").each do |x|
+            x.name = w
+          end
         end
       end
 
@@ -90,14 +106,35 @@ module Asciidoctor
         term_termsource_to_designation(xmldoc)
         term_designation_reorder(xmldoc)
         termdef_from_termbase(xmldoc)
-        termdef_stem_cleanup(xmldoc)
         termdomain_cleanup(xmldoc)
+        termdef_stem_cleanup(xmldoc)
         termdefinition_cleanup(xmldoc)
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
         term_children_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc)
       end
+
+      def index_cleanup(xmldoc)
+        return unless @index_terms
+
+        xmldoc.xpath("//preferred").each do |p|
+          index_cleanup1(p.at("./expression/name | ./letter-symbol/name"),
+                         p.xpath("./field-of-application | ./usage-info")
+            &.map(&:text)&.join(", "))
+        end
+        xmldoc.xpath("//definitions/dl/dt").each do |p|
+          index_cleanup1(p, "")
+        end
+      end
+
+      def index_cleanup1(term, fieldofappl)
+        return unless term
+
+        idx = term.children.dup
+        fieldofappl.empty? or idx << ", &#x3c;#{fieldofappl}&#x3e;"
+        term << "<index><primary>#{idx.to_xml}</primary></index>"
+      end
     end
   end
 end