metanorma-standoc 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42b32b109ae4f5ac4505f2218a4d4c5768ad388ffb29d3ae292b61fab8923030
-  data.tar.gz: aafef4197f9d88913ef52f8effacb515e54e94f456757758e9ac0bfe41b2656d
+  metadata.gz: bd044342634fd4dd1a67955a5f07785ae4762a0f63520e8254efe6e016853b1a
+  data.tar.gz: 89625dee3748cca3301727fc88650b0f916b8d2f60a258a9731ac09783c2465a
 SHA512:
-  metadata.gz: 13a8345e82e041ebbefecddeea7ba719898b6997877891d76177872b672e9bce7d00c060bf98569b0acd49c0c3ba691a989032e3650066030cf99a86991b5cbb
-  data.tar.gz: 37c1b235d071bb2d7b4f5ff8e73e3f5a3ca668c726245ea75002152bbd9931b07e67869dee8b0b6b8685e4480054f50244ddfa492cdd12275e30d27ec2d389e2
+  metadata.gz: 9958565ebd72f63b2a17af3f6cc89d5055d36f77ba15f4b80763ca64f3d45368b084e321ef05b0f49655943df029556a1ddd1c9cf27a7466299977b48aee57cc
+  data.tar.gz: 3979efde78ee18714f49a321ce89c51aa2039cc153863d118ddc788d610fae7788134688454bff075a9c95ace5bb097e5b24b169df9877f17a4321632b230b14

data/lib/metanorma/standoc/cleanup.rb

@@ -45,7 +45,7 @@ module Metanorma
         element_name_cleanup(xmldoc)
         ref_cleanup(xmldoc) # feeds: bibitem_cleanup
         note_cleanup(xmldoc)
-        clausebefore_cleanup(xmldoc)
+        clausebefore_cleanup(xmldoc) # feeeds: floatingtitle_cleanup
         floatingtitle_cleanup(xmldoc)
         bibitem_cleanup(xmldoc) # feeds: normref_cleanup, biblio_cleanup,
         # reference_names, bpart_cleanup

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -86,16 +86,33 @@ module Metanorma
       end
 
       def termdef_boilerplate_insert(xmldoc, isodoc, once = false)
-        xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
-          f.at("./clause[@type = 'boilerplate'] | " \
-               "./note[@type = 'boilerplate']") and next
-          term_defs_boilerplate(f.at("./title"),
-                                xmldoc.xpath(".//termdocsource"),
-                                f.at(".//term"), f.at(".//p"), isodoc)
-          once and break
+        if once
+          f = termdef_boilerplate_insert_location(xmldoc) and
+            termdef_boilerplate_insert1(f, xmldoc, isodoc)
+        else
+          xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
+            termdef_boilerplate_insert1(f, xmldoc, isodoc)
+          end
         end
       end
 
+      def termdef_boilerplate_insert_location(xmldoc)
+        f = xmldoc.at(self.class::TERM_CLAUSE)
+        root = xmldoc.at("//sections/terms | //sections/clause[.//terms]")
+        !f || !root and return f || root
+        f.at("./following::terms") and return root
+        f.at("./preceding-sibling::clause") and return root
+        f
+      end
+
+      def termdef_boilerplate_insert1(sect, xmldoc, isodoc)
+        sect.at("./clause[@type = 'boilerplate'] | " \
+                "./note[@type = 'boilerplate']") and return
+        term_defs_boilerplate(sect.at("./title"),
+                              xmldoc.xpath(".//termdocsource"),
+                              sect.at(".//term"), sect.at(".//p"), isodoc)
+      end
+
       def boilerplate_cleanup(xmldoc)
         isodoc = boilerplate_isodoc(xmldoc)
         termdef_boilerplate_cleanup(xmldoc)

data/lib/metanorma/standoc/cleanup_section.rb

@@ -178,8 +178,8 @@ module Metanorma
       end
 
       def clausebefore_cleanup(xmldoc)
-        preface_clausebefore_cleanup(xmldoc)
         sections_clausebefore_cleanup(xmldoc)
+        preface_clausebefore_cleanup(xmldoc)
       end
 
       def preface_clausebefore_cleanup(xmldoc)
@@ -196,10 +196,20 @@ module Metanorma
       end
 
       def sections_clausebefore_cleanup(xmldoc)
-        return unless xmldoc.at("//sections")
-
+        xmldoc.at("//sections") or return
         ins = insert_before(xmldoc, "//sections")
-        xmldoc.xpath("//sections//*[@beforeclauses = 'true']").each do |x|
+        xmldoc.xpath("//sections//*[@beforeclauses = 'true']").reverse.each do |x|
+          x.delete("beforeclauses")
+          ins.previous = x.remove
+        end
+        endofpreface_clausebefore(xmldoc, ins)
+      end
+
+      # only move clausebefore notes at the very end of preface
+      def endofpreface_clausebefore(xmldoc, ins)
+        xmldoc.xpath("//preface//*[@beforeclauses = 'true']").reverse.each do |x|
+          textafternote = xmldoc.xpath("//preface//*") & x.xpath("./following::*")
+          textafternote.text.strip.empty? or break
           x.delete("beforeclauses")
           ins.previous = x.remove
         end
@@ -214,6 +224,7 @@ module Metanorma
       end
 
       def floatingtitle_cleanup(xmldoc)
+        pop_floating_title(xmldoc) # done again, after endofpreface_clausebefore
         floating_title_preface2sections(xmldoc)
       end
 

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -50,10 +50,30 @@ module Metanorma
                   "[not(.//definitions[@type = 'symbols'])]".freeze
 
       def section_names_terms_cleanup(xml)
-        replace_title(xml, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        section_names_definitions(xml)
+        section_names_terms1_cleanup(xml)
+      end
+
+      def section_names_definitions(xml)
+        auto_name_definitions(xml) or return
+        replace_title(xml, "//definitions[@type = 'symbols']",
+                      @i18n&.symbols)
         replace_title(xml, "//definitions[@type = 'abbreviated_terms']",
                       @i18n&.abbrev)
-        replace_title(xml, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(xml, "//definitions[not(@type)]",
+                      @i18n&.symbolsabbrev)
+      end
+
+      def auto_name_definitions(xml)
+        xml.xpath("//definitions[@type = 'symbols']").size > 1 and return false
+        xml.xpath("//definitions[@type = 'abbreviated_terms']").size > 1 and
+          return false
+        xml.xpath("//definitions[not(@type)]").size > 1 and return false
+        true
+      end
+
+      def section_names_terms1_cleanup(xml)
+        auto_name_terms(xml) or return
         replace_title(xml, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
                       @i18n&.termsdefsymbols, true)
         replace_title(xml, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
@@ -69,6 +89,54 @@ module Metanorma
         )
       end
 
+      # do not auto-name terms sections if there are terms subclauses
+      # not covered by the auto titles,
+      # or if more than one title is covered by an auto title
+      def auto_name_terms(xml)
+        n = xml.at("//terms | //clause[.//terms]")
+        out = terms_subclauses(n)
+          .each_with_object({ term: 0, sna: 0, ans: 0, sa: 0, nsa: 0,
+                              tsna: 0, tans: 0, tsa: 0, tnsa: 0,
+                              termdef: 0, other: 0 }) do |x, m|
+          terms_subclause_type_tally(x, m, n)
+        end
+        out.delete(:parent)
+        !out.values.detect { |x| x > 1 } && out[:other].zero?
+      end
+
+      def terms_subclauses(node)
+        legal = %w(terms definitions clause)
+        [node, node&.elements].compact.flatten
+          .select do |x|
+            legal.include?(x.name) &&
+              !(x.name == "clause" && x["type"] == "boilerplate")
+          end
+      end
+
+      def terms_subclause_type_tally(node, m, parent)
+        sym = if (node.at(".//term") && !node.at(".//definitions")) ||
+            (node.name == "terms" && !node.at(".//term"))
+                unless m[:parent] == :term # don't count Term > Term twice
+                  :term
+                end
+              elsif node.at(".//term") && node.at("./self::*#{SYMnoABBR}") then :tsna
+              elsif node.at(".//term") && node.at("./self::*#{ABBRnoSYM}") then :tans
+              elsif node.at(".//term") && node.at("./self::*#{SYMABBR}") then :tsa
+              elsif node.at(".//term") && node.at("./self::*#{NO_SYMABBR}") then :tnsa
+              elsif node.at("./self::*#{SYMnoABBR}") then :sna
+              elsif node.at("./self::*#{ABBRnoSYM}") then :ans
+              elsif node.at("./self::*#{SYMABBR}") then :sa
+              elsif node.at("./self::*#{NO_SYMABBR}") then :nsa
+              elsif node.name == "definitions" # ignore
+              elsif node == parent && node.at(".//term") &&
+                  node.at(".//definitions")
+                :termdef
+              else :other
+              end
+        node == parent and m[:parent] = sym
+        sym and m[sym] += 1
+      end
+
       SECTION_CONTAINERS = %w(foreword introduction acknowledgements abstract
                               clause clause references terms definitions annex
                               appendix).freeze

data/lib/metanorma/standoc/converter.rb

@@ -63,6 +63,7 @@ module Metanorma
         treeprocessor Metanorma::Standoc::ToDoInlineAdmonitionBlock
         block Metanorma::Standoc::PlantUMLBlockMacro
         block Metanorma::Standoc::PseudocodeBlockMacro
+        block_macro Metanorma::Standoc::ColumnBreakBlockMacro
       end
 
       include ::Asciidoctor::Converter

data/lib/metanorma/standoc/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.2.5 -->
+<!-- VERSION v1.2.6 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -1013,6 +1013,14 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="BasicBlock" combine="choice">
+    <ref name="columnbreak"/>
+  </define>
+  <define name="columnbreak">
+    <element name="columnbreak">
+      <empty/>
+    </element>
+  </define>
   <define name="MultilingualRenderingType">
     <choice>
       <value>common</value>

data/lib/metanorma/standoc/macros.rb

@@ -61,6 +61,15 @@ module Metanorma
       end
     end
 
+    class ColumnBreakBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+      use_dsl
+      named :columnbreak
+
+      def process(parent, _reader, _attrs)
+        create_pass_block parent, "<columnbreak/>", {}, subs: nil
+      end
+    end
+
     # refer https://github.com/asciidoctor/asciidoctor/blob/main/lib/asciidoctor/substitutors.rb
     # Not using TreeProcessor because that is still too close to
     # inline expressions being processed on access (e.g. titles)

data/lib/metanorma/standoc/processor.rb

@@ -32,6 +32,7 @@ module Metanorma
       end
 
       def output(isodoc_node, inname, outname, format, options = {})
+        options_preprocess(options)
         case format
         when :html
           options = options

data/lib/metanorma/standoc/ref_queue.rb

@@ -142,7 +142,12 @@ module Metanorma
         nil
       end
 
+      def supply_ref_prefix(ret)
+        ret
+      end
+
       def fetch_ref1(code, year, opts)
+        code = supply_ref_prefix(code)
         if opts[:localfile]
           @local_bibdb.get(code, opts[:localfile])
         else @bibdb&.fetch(code, year, opts)
@@ -156,6 +161,7 @@ module Metanorma
       end
 
       def fetch_ref_async(ref, idx, res)
+        ref[:code] &&= supply_ref_prefix(ref[:code])
         if unfetchable_ref_code?(ref)
           res << [ref, idx, nil]
           idx += 1

data/lib/metanorma/standoc/render.rb

@@ -91,7 +91,7 @@ module Metanorma
                          pdf-allow-print pdf-allow-print-hq
                          pdf-allow-access-content pdf-encrypt-metadata fonts
                          font-license-agreement).each_with_object({}) do |x, m|
-          m[x.gsub(/-/, "").to_i] = node.attr(x)
+          m[x.gsub("-", "").to_i] = node.attr(x)
         end
 
         pdf_options.merge(fonts_manifest_option(node) || {})
@@ -102,7 +102,9 @@ module Metanorma
       end
 
       def presentation_xml_converter(node)
-        IsoDoc::PresentationXMLConvert.new(html_extract_attributes(node))
+        IsoDoc::PresentationXMLConvert
+          .new(html_extract_attributes(node)
+          .merge(output_formats: ::Metanorma::Standoc::Processor.new.output_formats)                                )
       end
 
       def default_fonts(node)

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.6.1".freeze
+    VERSION = "2.6.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable