isodoc 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14b2734abde4e3ab09b2a0637134ff9346bf2e378cebd580d154ae3799461c92
-  data.tar.gz: 3a1594d3c372cced922b30641dcdda21b1b2c95f8a921bd2d309eb7218952d35
+  metadata.gz: 7b149d913a483c336d7463e587e980fe234f4d1e32d8d683a070d919b0ce7429
+  data.tar.gz: 46e568e2b91f13069f62131ab1b86e28fd74416c55ae0937935575927a578430
 SHA512:
-  metadata.gz: 5638291318ca9a1eaa7c626b031afa8116dfb933cb6c8e408904126c367852b3e298735629c356e1d6192b49eec3c5fd8e94f39f5219d486b5aab9832158f43f
-  data.tar.gz: 52320e6fd84d57978a2c803417cfccfedf13e63b3b83c5bcbc73d69f2234a231ff35709b6bcd57dcbd9a622efda6c74c8fae50d132704fe8a655f71e996d2c71
+  metadata.gz: ae43a3f990e70f7d1929357172ca48b4cbc5db2750e61d1f91768c8087e796f5e333de64b60fc928434862e1fb874151c6a00a0cd41e25d491fe79e8604dfa9d
+  data.tar.gz: 9abab47db0d610e3971c1f9a19af240449dc11d6cd1d8d0f9e1e860f4b00e4a6947cce60d8483ba8701a180472278badaee6d431a07bd32ba1727ea5ad4d9a16

data/lib/isodoc/base_style/metanorma_word.css

@@ -1,6 +1,3 @@
-div.table_container {
-  margin-bottom: 14pt; }
-
 ol {
   margin-bottom: 0cm; }
 
@@ -54,3 +51,6 @@ table.rouge-line-table {
 
 td.rouge-code p.Sourcecode {
   margin: 0px; }
+
+div.table_container {
+  margin-bottom: 14pt; }

data/lib/isodoc/base_style/metanorma_word.scss

@@ -1,6 +1,4 @@
-div.table_container {
-  margin-bottom: 14pt;
-}
+
 
 ol      
         {margin-bottom:0cm;}
@@ -53,3 +51,7 @@ table.rouge-line-table {
 td.rouge-code p.Sourcecode {
   margin: 0px;
 }
+
+div.table_container {
+  margin-bottom: 14pt;
+}

data/lib/isodoc/common.rb

@@ -1,16 +1,16 @@
-require_relative "./function/blocks"
-require_relative "./function/cleanup"
-require_relative "./function/form"
-require_relative "./function/inline"
-require_relative "./function/lists"
-require_relative "./function/references"
-require_relative "./function/section"
-require_relative "./function/table"
-require_relative "./function/terms"
-require_relative "./function/to_word_html"
-require_relative "./function/utils"
-require_relative "./function/reqt"
-require_relative "./class_utils"
+require_relative "function/blocks"
+require_relative "function/cleanup"
+require_relative "function/form"
+require_relative "function/inline"
+require_relative "function/lists"
+require_relative "function/references"
+require_relative "function/section"
+require_relative "function/table"
+require_relative "function/terms"
+require_relative "function/to_word_html"
+require_relative "function/utils"
+require_relative "function/reqt"
+require_relative "class_utils"
 
 module IsoDoc
   class Common

data/lib/isodoc/init.rb

@@ -129,5 +129,13 @@ module IsoDoc
       @toctables = options[:toctables]
       @tocrecommendations = options[:tocrecommendations]
     end
+
+    AGENCIES = %w(ISO IEC ITU IETF NIST OGC IEEE BIPM BSI BS JIS IANA UN W3C
+                  IHO CSA IEV)
+      .freeze
+
+    def agency?(text)
+      self.class::AGENCIES.include?(text)
+    end
   end
 end

data/lib/isodoc/metadata.rb

@@ -1,5 +1,5 @@
-require_relative "./metadata_date"
-require_relative "./metadata_contributor"
+require_relative "metadata_date"
+require_relative "metadata_contributor"
 
 module IsoDoc
   class Metadata
@@ -15,7 +15,7 @@ module IsoDoc
 
     def initialize(lang, script, locale, i18n, fonts_options = {})
       @metadata = { lang: lang, script: script }
-      DATETYPES.each { |w| @metadata["#{w.gsub(/-/, '_')}date".to_sym] = "XXX" }
+      DATETYPES.each { |w| @metadata["#{w.gsub('-', '_')}date".to_sym] = "XXX" }
       @lang = lang
       @script = script
       @locale = locale

data/lib/isodoc/metadata_contributor.rb

@@ -67,7 +67,7 @@ module IsoDoc
       publisher = []
       xml.xpath(ns("//bibdata/contributor[xmlns:role/@type = 'publisher']/" \
                    "organization")).each do |org|
-        name = org.at(ns("./name"))&.text
+        name = extract_variant(org.at(ns("./name")))
         agency1 = org.at(ns("./abbreviation"))&.text || name
         publisher << name if name
         agency = iso?(org) ? "ISO/#{agency}" : "#{agency}#{agency1}/"
@@ -75,6 +75,12 @@ module IsoDoc
       [agency, publisher]
     end
 
+    def extract_variant(node)
+      node.nil? and return node
+      x = node.at(ns("./variant[@language = '#{@lang}']")) and node = x
+      node.text
+    end
+
     def agency(xml)
       agency, publisher = agency1(xml)
       set(:agency, agency.sub(%r{/$}, ""))

data/lib/isodoc/presentation_function/inline.rb

@@ -10,10 +10,10 @@ module IsoDoc
 
     def get_linkend(node)
       node["style"] == "id" and anchor_id_postprocess(node)
-      return unless xref_empty?(node)
-
-      link = anchor_linkend(node, docid_l10n(node["target"] ||
-                                             expand_citeas(node["citeas"])))
+      xref_empty?(node) or return
+      target = docid_l10n(node["target"]) ||
+        expand_citeas(docid_l10n(node["citeas"]))
+      link = anchor_linkend(node, target)
       link += eref_localities(node.xpath(ns("./locality | ./localityStack")),
                               link, node)
       non_locality_elems(node).each(&:remove)
@@ -24,8 +24,7 @@ module IsoDoc
     # <locality type="section"><reference>3.1</reference></locality></origin>
 
     def unnest_linkend(node)
-      return unless node.at(ns("./xref[@nested]"))
-
+      node.at(ns("./xref[@nested]")) or return
       node.xpath(ns("./xref[@nested]")).each { |x| x.delete("nested") }
       node.xpath(ns("./location | ./locationStack")).each(&:remove)
       node.replace(node.children)
@@ -64,15 +63,15 @@ module IsoDoc
       get_linkend(node)
     end
 
-    def variant(docxml)
-      docxml.xpath(ns("//variant")).each { |f| variant1(f) }
-      docxml.xpath(ns("//variant[@remove = 'true']")).each(&:remove)
-      docxml.xpath(ns("//variant")).each do |v|
-        next unless v&.next&.name == "variant"
-
+    def variant(xml)
+      b = xml.xpath(ns("//bibdata//variant"))
+      (xml.xpath(ns("//variant")) - b).each { |f| variant1(f) }
+      (xml.xpath(ns("//variant[@remove = 'true']")) - b).each(&:remove)
+      (xml.xpath(ns("//variant")) - b).each do |v|
+        v.next&.name == "variant" or next
         v.next = "/"
       end
-      docxml.xpath(ns("//variant")).each { |f| f.replace(f.children) }
+      (xml.xpath(ns("//variant")) - b).each { |f| f.replace(f.children) }
     end
 
     def variant1(node)

data/lib/isodoc/presentation_function/section.rb

@@ -25,9 +25,8 @@ module IsoDoc
       level = @xrefs.anchor(elem["id"], :level, false) ||
         (elem.ancestors("clause, annex").size + 1)
       t = elem.at(ns("./title")) and t["depth"] = level
-      return if !elem.ancestors("boilerplate, metanorma-extension").empty? ||
-        @suppressheadingnumbers || elem["unnumbered"]
-
+      !elem.ancestors("boilerplate, metanorma-extension").empty? ||
+        @suppressheadingnumbers || elem["unnumbered"] and return
       lbl = @xrefs.anchor(elem["id"], :label,
                           elem.parent.name != "sections") or return
       prefix_name(elem, "<tab/>", "#{lbl}#{clausedelim}", "title")
@@ -133,17 +132,15 @@ module IsoDoc
 
     def display_order(docxml)
       i = 0
-      i = display_order_xpath(docxml, "//preface/*", i)
-      i = display_order_at(docxml, "//clause[@type = 'scope']", i)
-      i = display_order_at(docxml, @xrefs.klass.norm_ref_xpath, i)
-      i = display_order_at(docxml, "//sections/terms | " \
-                                   "//sections/clause[descendant::terms]", i)
-      i = display_order_at(docxml, "//sections/definitions", i)
-      i = display_order_xpath(docxml, @xrefs.klass.middle_clause(docxml), i)
-      i = display_order_xpath(docxml, "//annex", i)
-      i = display_order_xpath(docxml, @xrefs.klass.bibliography_xpath, i)
-      i = display_order_xpath(docxml, "//indexsect", i)
-      display_order_xpath(docxml, "//colophon/*", i)
+      d = @xrefs.clause_order(docxml)
+      %i(preface main annex back).each do |s|
+        d[s].each do |a|
+          i = if a[:multi]
+                display_order_xpath(docxml, a[:path], i)
+              else display_order_at(docxml, a[:path], i)
+              end
+        end
+      end
     end
 
     def clausetitle(docxml)

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.6.0".freeze
+  VERSION = "2.6.1".freeze
 end

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -1,18 +1,66 @@
 module IsoDoc
   module XrefGen
     module Sections
+      def clause_order(docxml)
+        { preface: clause_order_preface(docxml),
+          main: clause_order_main(docxml),
+          annex: clause_order_annex(docxml),
+          back: clause_order_back(docxml) }
+      end
+
+      def clause_order_preface(_docxml)
+        [{ path: "//preface/*", multi: true }]
+      end
+
+      def clause_order_main(docxml)
+        [
+          { path: "//clause[@type = 'scope']" },
+          { path: @klass.norm_ref_xpath },
+          { path: "//sections/terms | " \
+                  "//sections/clause[descendant::terms]" },
+          { path: "//sections/definitions | " \
+                  "//sections/clause[descendant::definitions][not(descendant::terms)]" },
+          { path: @klass.middle_clause(docxml), multi: true },
+        ]
+      end
+
+      def clause_order_annex(_docxml)
+        [{ path: "//annex", multi: true }]
+      end
+
+      def clause_order_back(_docxml)
+        [
+          { path: @klass.bibliography_xpath },
+          { path: "//indexsect", multi: true },
+          { path: "//colophon/*", multi: true },
+        ]
+      end
+
       def back_anchor_names(xml)
         if @parse_settings.empty? || @parse_settings[:clauses]
-          i = Counter.new("@")
-          xml.xpath(ns("//annex")).each do |c|
+          annex_anchor_names(xml)
+          back_clauses_anchor_names(xml)
+        end
+        references(xml) if @parse_settings.empty? || @parse_settings[:refs]
+      end
+
+      def annex_anchor_names(xml)
+        i = Counter.new("@")
+        clause_order_annex(xml).each do |a|
+          xml.xpath(ns(a[:path])).each do |c|
             annex_names(c, i.increment(c).print)
+            a[:multi] or break
           end
-          xml.xpath(ns(@klass.bibliography_xpath)).each do |b|
-            preface_names(b)
+        end
+      end
+
+      def back_clauses_anchor_names(xml)
+        clause_order_back(xml).each do |a|
+          xml.xpath(ns(a[:path])).each do |c|
+            back_names(c)
+            a[:multi] or break
           end
-          xml.xpath(ns("//colophon/clause")).each { |b| preface_names(b) }
         end
-        references(xml) if @parse_settings.empty? || @parse_settings[:refs]
       end
 
       def references(docxml)
@@ -21,20 +69,29 @@ module IsoDoc
         end
       end
 
-      def initial_anchor_names(doc)
+      def initial_anchor_names(xml)
         if @parse_settings.empty? || @parse_settings[:clauses]
-          doc.xpath(ns("//preface/*")).each do |c|
-            c.element? and preface_names(c)
+          preface_anchor_names(xml)
+          main_anchor_names(xml)
+        end
+      end
+
+      def preface_anchor_names(xml)
+        clause_order_preface(xml).each do |a|
+          xml.xpath(ns(a[:path])).each do |c|
+            preface_names(c)
+            a[:multi] or break
+          end
+        end
+      end
+
+      def main_anchor_names(xml)
+        n = Counter.new
+        clause_order_main(xml).each do |a|
+          xml.xpath(ns(a[:path])).each do |c|
+            section_names(c, n, 1)
+            a[:multi] or break
           end
-          # potentially overridden in middle_section_asset_names()
-          sequential_asset_names(doc.xpath(ns("//preface/*")))
-          n = Counter.new
-          n = section_names(doc.at(ns("//clause[@type = 'scope']")), n, 1)
-          n = section_names(doc.at(ns(@klass.norm_ref_xpath)), n, 1)
-          n = section_names(doc.at(ns("//sections/terms | " \
-                                      "//sections/clause[descendant::terms]")), n, 1)
-          n = section_names(doc.at(ns("//sections/definitions")), n, 1)
-          clause_names(doc, n)
         end
       end
 
@@ -57,8 +114,7 @@ module IsoDoc
         ret = clause.at(ns("./title"))&.text
         if use_elem_name && !ret
           clause.name.capitalize
-        else
-          ret
+        else ret
         end
       end
 
@@ -67,8 +123,15 @@ module IsoDoc
 
       # in StanDoc, prefaces have no numbering; they are referenced only by title
       def preface_names(clause)
-        return if clause.nil?
+        unnumbered_names(clause)
+      end
+
+      def back_names(clause)
+        unnumbered_names(clause)
+      end
 
+      def unnumbered_names(clause)
+        clause.nil? and return
         preface_name_anchors(clause, 1,
                              clause_title(clause, use_elem_name: true))
         clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
@@ -94,23 +157,15 @@ module IsoDoc
       end
 
       def middle_section_asset_names(doc)
-        middle_sections = "//clause[@type = 'scope'] | " \
-                          "#{@klass.norm_ref_xpath} | " \
-                          "//sections/terms | //preface/* | " \
-                          "//sections/definitions | //clause[parent::sections]"
+        middle_sections =
+          "//clause[@type = 'scope'] | #{@klass.norm_ref_xpath} | " \
+          "//sections/terms | //preface/* | " \
+          "//sections/definitions | //clause[parent::sections]"
         sequential_asset_names(doc.xpath(ns(middle_sections)))
       end
 
-      def clause_names(docxml, num)
-        docxml.xpath(ns(@klass.middle_clause(docxml)))
-          .each_with_index do |c, _i|
-          section_names(c, num, 1)
-        end
-      end
-
       def section_names(clause, num, lvl)
         clause.nil? and return num
-
         num.increment(clause)
         section_name_anchors(clause, num.print, lvl)
         clause.xpath(ns(SUBCLAUSES)).each_with_object(Counter.new) do |c, i|
@@ -138,7 +193,8 @@ module IsoDoc
         obl = l10n("(#{@labels['inform_annex']})")
         clause["obligation"] == "normative" and
           obl = l10n("(#{@labels['norm_annex']})")
-        title = Common::case_with_markup(@labels["annex"], "capital", @script)
+        title = Common::case_with_markup(@labels["annex"], "capital",
+                                         @script)
         l10n("<strong>#{title} #{num}</strong><br/>#{obl}")
       end
 

data/lib/isodoc-yaml/i18n-ar.yaml

@@ -30,7 +30,7 @@ external_terms_boilerplate: |
   <p> لأغراض هذا المستند ، تنطبق المصطلحات والتعريفات الواردة في%. </ p>
 internal_external_terms_boilerplate: |
   <p>لأغراض هذه الوثيقة ،تنطبق المصطلحات والتعاريف الواردة في % وما يلي.</p>
-term_defined_in: "[المصطلح المحدد في %]"
+term_defined_in: "(%)"
 binary_and: "%1 و %2"
 multiple_and: "%1, و %2"
 binary_or: "%1 او %2"

data/lib/isodoc-yaml/i18n-de.yaml

@@ -32,7 +32,7 @@ external_terms_boilerplate: |
           <p>Für die Zwecke dieses Dokuments gelten die in % angegebenen Begriffe und Definitionen.</p>
 internal_external_terms_boilerplate: |
           <p>Für die Zwecke dieses Dokuments gelten die in % und im Folgenden aufgeführten Begriffe und Definitionen.</p>
-term_defined_in: "[Begriff definiert in %]"
+term_defined_in: "(%)"
 binary_and: "%1 und %2"
 multiple_and: "%1, und %2"
 binary_or: "%1 oder %2"

data/lib/isodoc-yaml/i18n-en.yaml

@@ -38,7 +38,7 @@ external_terms_boilerplate: |
 internal_external_terms_boilerplate: |
           <p>For the purposes of this document, the terms and definitions 
             given in % and the following apply.</p>
-term_defined_in: "[term defined in %]"
+term_defined_in: "(%)"
 binary_and: "%1 and %2"
 multiple_and: "%1, and %2"
 binary_or: "%1 or %2"

data/lib/isodoc-yaml/i18n-es.yaml

@@ -34,7 +34,7 @@ external_terms_boilerplate: |
           <p>Para los propósitos de este documento, se aplican los términos y definiciones dados en %.</p>
 internal_external_terms_boilerplate: |
           <p>Para los propósitos de este documento, se aplican los términos y definiciones dados en % y los siguientes.</p>
-term_defined_in: "[término definido en %]"
+term_defined_in: "(%)"
 binary_and: "%1 y %2"
 multiple_and: "%1, y %2"
 binary_or: "%1 o %2"

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -31,7 +31,7 @@ external_terms_boilerplate: |
           <p>Pour les besoins du présent document, les termes et définitions de % s’appliquent.</p>
 internal_external_terms_boilerplate: |
           <p>Pour les besoins du présent document, les termes et définitions de % ainsi que les suivants, s’appliquent.</p>
-term_defined_in: "[terme défini dans %]"
+term_defined_in: "(%)"
 binary_and: "%1 et %2"
 multiple_and: "%1, et %2"
 binary_or: "%1 ou %2"

data/lib/isodoc-yaml/i18n-ja.yaml

@@ -31,7 +31,7 @@ external_terms_boilerplate: |
           <p>この規格で用いる主な用語及び定義は，% による。</p>
 internal_external_terms_boilerplate: |
           <p>この規格で用いる主な用語及び定義は，次によるほか，% による。</p>
-term_defined_in: "[term defined in %]"
+term_defined_in: "(%)"
 binary_and: "%1 and %2"
 multiple_and: "%1, and %2"
 binary_or: "%1 or %2"

data/lib/isodoc-yaml/i18n-ru.yaml

@@ -37,7 +37,7 @@ external_terms_boilerplate: |
 internal_external_terms_boilerplate: |
           <p>Для целей этого документа применяются 
             термины и определения, данные в % и следующие.</p>
-term_defined_in: "[термин, определенный в %]"
+term_defined_in: "(%)"
 binary_and: "%1 и %2"
 multiple_and: "%1, и %2"
 binary_or: "%1 или %2"

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -33,7 +33,7 @@ external_terms_boilerplate: |
           <p>% 界定的术语和定义适用于本文件。</p>
 internal_external_terms_boilerplate: |
           <p>% 界定的以及下列术语和定义适用于本文件。</p>
-term_defined_in: "〖术语于%中定义〗"
+term_defined_in: "（%）"
 binary_and: "%1和%2"
 multiple_and: "%1、和%2"
 binary_or: "%1或%2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html2doc