metanorma-iso 1.7.2 → 1.8.2

data/lib/asciidoctor/iso/validate_style.rb

@@ -7,28 +7,32 @@ module Asciidoctor
     class Converter < Standoc::Converter
       def extract_text(node)
         return "" if node.nil?
+
         node1 = Nokogiri::XML.fragment(node.to_s)
         node1.xpath("//link | //locality | //localityStack").each(&:remove)
         ret = ""
         node1.traverse { |x| ret += x.text if x.text? }
-        ret
+        HTMLEntities.new.decode(ret)
       end
 
       # ISO/IEC DIR 2, 12.2
       def foreword_style(node)
         return if @novalid
+
         style_no_guidance(node, extract_text(node), "Foreword")
       end
 
       # ISO/IEC DIR 2, 14.2
       def scope_style(node)
         return if @novalid
+
         style_no_guidance(node, extract_text(node), "Scope")
       end
 
       # ISO/IEC DIR 2, 13.2
       def introduction_style(node)
         return if @novalid
+
         r = requirement_check(extract_text(node))
         style_warning(node, "Introduction may contain requirement", r) if r
       end
@@ -36,6 +40,7 @@ module Asciidoctor
       # ISO/IEC DIR 2, 16.5.6
       def definition_style(node)
         return if @novalid
+
         r = requirement_check(extract_text(node))
         style_warning(node, "Definition may contain requirement", r) if r
       end
@@ -44,6 +49,7 @@ module Asciidoctor
       # ISO/IEC DIR 2, 25.5
       def example_style(node)
         return if @novalid
+
         style_no_guidance(node, extract_text(node), "Example")
         style(node, extract_text(node))
       end
@@ -51,6 +57,7 @@ module Asciidoctor
       # ISO/IEC DIR 2, 24.5
       def note_style(node)
         return if @novalid
+
         style_no_guidance(node, extract_text(node), "Note")
         style(node, extract_text(node))
       end
@@ -58,6 +65,7 @@ module Asciidoctor
       # ISO/IEC DIR 2, 26.5
       def footnote_style(node)
         return if @novalid
+
         style_no_guidance(node, extract_text(node), "Footnote")
         style(node, extract_text(node))
       end
@@ -70,6 +78,7 @@ module Asciidoctor
       # and a negative match on its preceding token
       def style_two_regex_not_prev(n, text, re, re_prev, warning)
         return if text.nil?
+
         arr = Tokenizer::WhitespaceTokenizer.new.tokenize(text)
         arr.each_index do |i|
           m = re.match arr[i]
@@ -80,43 +89,45 @@ module Asciidoctor
         end
       end
 
-      def style(n, t)
+      def style(node, text)
         return if @novalid
-        style_number(n, t)
-        style_percent(n, t)
-        style_abbrev(n, t)
-        style_units(n, t)
+
+        style_number(node, text)
+        style_percent(node, text)
+        style_abbrev(node, text)
+        style_units(node, text)
       end
 
       # ISO/IEC DIR 2, 9.1
       # ISO/IEC DIR 2, Table B.1
-      def style_number(n, t)
+      def style_number(node, text)
         style_two_regex_not_prev(
-          n, t, /^(?<num>-?[0-9]{4,}[,0-9]*)$/,
+          node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)$/,
           %r{\b(ISO|IEC|IEEE/|(in|January|February|March|April|May|June|August|September|October|November|December)\b)$},
-          "number not broken up in threes")
+          "number not broken up in threes"
+        )
         style_regex(/\b(?<num>[0-9]+\.[0-9]+)/i,
-                    "possible decimal point", n, t)
-        style_regex(/\b(?<num>billion[s]?)\b/i,
-                    "ambiguous number", n, t)
+                    "possible decimal point", node, text)
+        style_regex(/\b(?<num>billions?)\b/i,
+                    "ambiguous number", node, text)
       end
 
       # ISO/IEC DIR 2, 9.2.1
-      def style_percent(n, t)
+      def style_percent(node, text)
         style_regex(/\b(?<num>[0-9.,]+%)/,
-                    "no space before percent sign", n, t)
+                    "no space before percent sign", node, text)
         style_regex(/\b(?<num>[0-9.,]+ \u00b1 [0-9,.]+ %)/,
-                    "unbracketed tolerance before percent sign", n, t)
+                    "unbracketed tolerance before percent sign", node, text)
       end
 
       # ISO/IEC DIR 2, 8.4
       # ISO/IEC DIR 2, 9.3
-      def style_abbrev(n, t)
+      def style_abbrev(node, text)
         style_regex(/(^|\s)(?!e\.g\.|i\.e\.)
                     (?<num>[a-z]{1,2}\.([a-z]{1,2}|\.))\b/ix,
-                      "no dots in abbreviations", n, t)
+                    "no dots in abbreviations", node, text)
         style_regex(/\b(?<num>ppm)\b/i,
-                    "language-specific abbreviation", n, t)
+                    "language-specific abbreviation", node, text)
       end
 
       # leaving out as problematic: N J K C S T H h d B o E
@@ -125,12 +136,13 @@ module Asciidoctor
         "bit|kB|MB|Hart|nat|Sh|var)".freeze
 
       # ISO/IEC DIR 2, 9.3
-      def style_units(n, t)
+      def style_units(node, text)
         style_regex(/\b(?<num>[0-9][0-9,]*\s+[\u00b0\u2032\u2033])/,
-                    "space between number and degrees/minutes/seconds", n, t)
+                    "space between number and degrees/minutes/seconds",
+                    node, text)
         style_regex(/\b(?<num>[0-9][0-9,]*#{SI_UNIT})\b/,
-                    "no space between number and SI unit", n, t)
-        style_non_std_units(n, t)
+                    "no space between number and SI unit", node, text)
+        style_non_std_units(node, text)
       end
 
       NONSTD_UNITS = {
@@ -139,10 +151,10 @@ module Asciidoctor
       }.freeze
 
       # ISO/IEC DIR 2, 9.3
-      def style_non_std_units(n, t)
+      def style_non_std_units(node, text)
         NONSTD_UNITS.each do |k, v|
           style_regex(/\b(?<num>[0-9][0-9,]*\s+#{k})\b/,
-                      "non-standard unit (should be #{v})", n, t)
+                      "non-standard unit (should be #{v})", node, text)
         end
       end
     end

data/lib/asciidoctor/iso/validate_title.rb

@@ -3,9 +3,13 @@ require "metanorma-standoc"
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
+      def title_lang_part(doc, part, lang)
+        doc.at("//bibdata/title[@type='title-#{part}' and @language='#{lang}']")
+      end
+
       def title_intro_validate(root)
-        title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
-        title_intro_fr = root.at("//title[@type='title-intro' and @language='fr']")
+        title_intro_en = title_lang_part(root, "intro", "en")
+        title_intro_fr = title_lang_part(root, "intro", "fr")
         if title_intro_en.nil? && !title_intro_fr.nil?
           @log.add("Style", title_intro_fr, "No English Title Intro!")
         end
@@ -15,8 +19,8 @@ module Asciidoctor
       end
 
       def title_main_validate(root)
-        title_main_en = root.at("//title[@type='title-main' and @language='en']")
-        title_main_fr = root.at("//title[@type='title-main' and @language='fr']")
+        title_main_en = title_lang_part(root, "main", "en")
+        title_main_fr = title_lang_part(root, "main", "fr")
         if title_main_en.nil? && !title_main_fr.nil?
           @log.add("Style", title_main_fr, "No English Title!")
         end
@@ -26,8 +30,8 @@ module Asciidoctor
       end
 
       def title_part_validate(root)
-        title_part_en = root.at("//title[@type='title-part' and @language='en']")
-        title_part_fr = root.at("//title[@type='title-part' and @language='fr']")
+        title_part_en = title_lang_part(root, "part", "en")
+        title_part_fr = title_lang_part(root, "part", "fr")
         (title_part_en.nil? && !title_part_fr.nil?) &&
           @log.add("Style", title_part_fr, "No English Title Part!")
         (!title_part_en.nil? && title_part_fr.nil?) &&
@@ -41,21 +45,21 @@ module Asciidoctor
         iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
                       "organization[abbreviation = 'IEC' or "\
                       "name = 'International Electrotechnical Commission']")
-        @log.add("Style", docid, "Subpart defined on non-IEC document!") if subpart && !iec
+        subpart && !iec and
+          @log.add("Style", docid, "Subpart defined on non-IEC document!")
       end
 
       # ISO/IEC DIR 2, 11.5.2
       def title_names_type_validate(root)
         doctypes = /International\sStandard | Technical\sSpecification |
         Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
-        title_main_en = root.at("//title[@type='title-main' and @language='en']")
-        if !title_main_en.nil? && doctypes.match(title_main_en.text)
+        title_main_en = title_lang_part(root, "main", "en")
+        !title_main_en.nil? && doctypes.match(title_main_en.text) and
           @log.add("Style", title_main_en, "Main Title may name document type")
-        end
-        title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
-        if !title_intro_en.nil? && doctypes.match(title_intro_en.text)
-          @log.add("Style", title_intro_en, "Title Intro may name document type")
-        end
+        title_intro_en = title_lang_part(root, "intro", "en")
+        !title_intro_en.nil? && doctypes.match(title_intro_en.text) and
+          @log.add("Style", title_intro_en,
+                   "Title Intro may name document type")
       end
 
       # ISO/IEC DIR 2, 22.2
@@ -64,8 +68,9 @@ module Asciidoctor
           title = s&.at("./title")&.text || s.name
           s.xpath("./clause | ./terms | ./references").each do |ss|
             subtitle = ss.at("./title")
-            !subtitle.nil? && !subtitle&.text&.empty? ||
-              @log.add("Style", ss, "#{title}: each first-level subclause must have a title")
+            !subtitle.nil? && !subtitle&.text&.empty? or
+              @log.add("Style", ss,
+                       "#{title}: each first-level subclause must have a title")
           end
         end
       end
@@ -82,7 +87,8 @@ module Asciidoctor
           withtitle = withtitle || (subtitle && !subtitle.text.empty?)
         end
         notitle && withtitle &&
-          @log.add("Style", nil, "#{label}: all subclauses must have a title, or none")
+          @log.add("Style", nil,
+                   "#{label}: all subclauses must have a title, or none")
       end
 
       def title_validate(root)

data/lib/isodoc/iso/base_convert.rb

@@ -15,6 +15,7 @@ module IsoDoc
 
       def implicit_reference(b)
         return true if b&.at(ns("./docidentifier"))&.text == "IEV"
+
         super
       end
 
@@ -27,8 +28,9 @@ module IsoDoc
         end
       end
 
-      def example_span_label(node, div, name)
+      def example_span_label(_node, div, name)
         return if name.nil?
+
         div.span **{ class: "example_label" } do |p|
           name.children.each { |n| parse(n, div) }
         end
@@ -56,6 +58,7 @@ module IsoDoc
         node.elements.each do |e|
           next if e.name == "name"
           return true if e.name == "p"
+
           return false
         end
         false
@@ -74,6 +77,7 @@ module IsoDoc
       def insertall_after_here(node, insert, name)
         node.children.each do |n|
           next unless n.name == name
+
           insert.next = n.remove
           insert = n
         end
@@ -83,6 +87,7 @@ module IsoDoc
       def termexamples_before_termnotes(node)
         return unless node.at(ns("./termnote")) && node.at(ns("./termexample"))
         return unless insert = node.at(ns("./definition"))
+
         insert = insertall_after_here(node, insert, "termexample")
         insert = insertall_after_here(node, insert, "termnote")
       end
@@ -110,6 +115,7 @@ module IsoDoc
         return super unless (dl&.xpath(ns("./dt"))&.size == 1 && 
                              dl&.at(ns("./dd"))&.elements&.size == 1 &&
                              dl&.at(ns("./dd/p")))
+
         out.span **{ class: "zzMoveToFollowing" } do |s|
           s << "#{@i18n.where} "
           dl.at(ns("./dt")).children.each { |n| parse(n, s) }
@@ -149,7 +155,18 @@ module IsoDoc
 
       def figure_name_parse(node, div, name)
         div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
-          name and name.children.each { |n| parse(n, div) }
+          name&.children&.each { |n| parse(n, div) }
+        end
+      end
+
+      def middle(isoxml, out)
+        super
+        indexsect isoxml, out
+      end
+
+      def indexsect(isoxml, out)
+        isoxml.xpath(ns("//indexsect")).each do |i|
+          clause_parse(i, out)
         end
       end
     end

data/lib/isodoc/iso/html/style-human.css

@@ -115,6 +115,13 @@ a.FootnoteRef + a.FootnoteRef:before {
   content: ", ";
   vertical-align: super; }
 
+.addition {
+  color: blue; }
+
+.deletion {
+  color: red;
+  text-decoration: line-through; }
+
 #standard-band {
   background-color: #0AC442; }
 

data/lib/isodoc/iso/html/style-iso.css

@@ -115,6 +115,13 @@ a.FootnoteRef + a.FootnoteRef:before {
   content: ", ";
   vertical-align: super; }
 
+.addition {
+  color: blue; }
+
+.deletion {
+  color: red;
+  text-decoration: line-through; }
+
 #standard-band {
   background-color: #0AC442; }
 

data/lib/isodoc/iso/html_convert.rb

@@ -38,7 +38,6 @@ module IsoDoc
                            html_doc_path("style-iso.scss")),
         htmlcoverpage: html_doc_path("html_iso_titlepage.html"),
         htmlintropage: html_doc_path("html_iso_intro.html"),
-        scripts: html_doc_path("scripts.html"),
         }
       end
 

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

@@ -14,3 +14,7 @@ price_based_on: Price based on % pages
 under_preparation: Under preparation. (Stage at the time of publication %).
 table_of_contents: Contents
 date: Date
+index: Index
+see: see
+see_also: see also
+

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

@@ -13,3 +13,7 @@ reference_number: Numéro de référence
 price_based_on: Prix basé sur % pages
 under_preparation: En cours d'élaboration. (Stade au moment de la publication %).
 date: Date
+index: Index
+see: voir
+see_also: voir aussi
+

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

@@ -11,3 +11,7 @@ reference_number: 参考编号
 price_based_on: 价格基于%页
 under_preparation: 制定中（出版时最新状态为%）
 date: 日期
+index: 索引
+see: 见
+see_also: 另见
+

data/lib/isodoc/iso/index.rb

@@ -0,0 +1,140 @@
+module IsoDoc
+  module Iso
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
+      def index(docxml)
+        unless docxml.at(ns("//index"))
+          docxml.xpath(ns("//indexsect")).each { |i| i.remove }
+          return
+        end
+        i = docxml.at(ns("//indexsect")) ||
+          docxml.root.add_child("<indexsect #{add_id}><title>#{@i18n.index}</title></indexsect>").first
+        index = sort_indexterms(docxml.xpath(ns("//index")), docxml.xpath(ns("//index-xref[@also = 'false']")),
+                                docxml.xpath(ns("//index-xref[@also = 'true']")))
+        index1(docxml, i, index)
+      end
+
+      def index1(docxml, i, index)
+        c = i.add_child("<ul></ul>").first
+        index.keys.sort.each do |k|
+          #c = i.add_child "<clause #{add_id}><title>#{k}</title><ul></ul></clause>"
+          words = index[k].keys.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+          words.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+            #c.first.at(ns("./ul")).add_child index_entries(words, index[k], w)
+            c.add_child index_entries(words, index[k], w)
+          end
+        end
+        docxml.xpath(ns("//indexsect//xref")).each { |x| x.children.remove }
+        @xrefs.bookmark_anchor_names(docxml)
+      end
+
+      def sortable(s)
+        HTMLEntities.new.decode(Nokogiri::XML.fragment(s).text)
+      end
+
+      def index_entries_opt
+        { xref_lbl: ", ", see_lbl: ", #{see_lbl}", also_lbl: ", #{also_lbl}" }
+      end
+
+      def index_entries(words, index, primary)
+        ret = index_entries_head(words[primary], index.dig(words[primary], nil, nil), index_entries_opt)
+        words2 = index[words[primary]]&.keys&.reject { |k| k.nil?}&.each_with_object({}) { |w, v| v[w.downcase] = w }
+        unless words2.empty?
+          ret += "<ul>"
+          words2.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+            ret += index_entries2(words2, index[words[primary]], w)
+          end
+          ret += "</ul>"
+        end
+        ret + "</li>"
+      end
+
+      def index_entries2(words, index, secondary)
+        ret = index_entries_head(words[secondary], index.dig(words[secondary], nil), index_entries_opt)
+        words3 = index[words[secondary]]&.keys&.reject { |k| k.nil?}&.each_with_object({}) { |w, v| v[w.downcase] = w }
+        unless words3.empty?
+          ret += "<ul>"
+          words3.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+            ret += (index_entries_head(words3[w], index[words[secondary]][words3[w]], index_entries_opt) + "</li>")
+          end
+          ret += "</ul>"
+        end
+        ret + "</li>"
+      end
+
+      def index_entries_head(head, entries, opt)
+        ret = "<li>#{head}"
+        xref = entries&.dig(:xref)&.join(", ")
+        see_sort = entries&.dig(:see)&.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+        see = see_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map { |k| see_sort[k] }&.join(", ")
+        also_sort = entries&.dig(:also)&.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+        also = also_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map { |k| also_sort[k] }&.join(", ")
+        ret += "#{opt[:xref_lbl]} #{xref}" if xref
+        ret += "#{opt[:see_lbl]} #{see}" if see
+        ret += "#{opt[:also_lbl]} #{also}" if also
+        ret
+      end
+
+      def see_lbl
+        @lang == "en" ? @i18n.see : "<em>#{@i18n.see}</em>"
+      end
+
+      def also_lbl
+        @lang == "en" ? @i18n.see_also : "<em>#{@i18n.see_also}</em>"
+      end
+
+      def sort_indexterms(terms, see, also)
+        index = extract_indexterms(terms)
+        index = extract_indexsee(index, see, :see)
+        index = extract_indexsee(index, also, :also)
+        index.keys.sort.each_with_object({}) do |k, v|
+          v[sortable(k)[0].upcase.transliterate] ||= {}
+          v[sortable(k)[0].upcase.transliterate][k] = index[k]
+        end
+      end
+
+      def extract_indexsee(v, terms, label)
+        terms.each_with_object(v) do |t, v|
+          term = t&.at(ns("./primary"))&.children&.to_xml
+          term2 = t&.at(ns("./secondary"))&.children&.to_xml
+          term3 = t&.at(ns("./tertiary"))&.children&.to_xml
+          v[term] ||= {}
+          v[term][term2] ||= {}
+          v[term][term2][term3] ||= {}
+          v[term][term2][term3][label] ||= []
+          v[term][term2][term3][label] << t&.at(ns("./target"))&.children&.to_xml
+          t.remove
+        end
+      end
+
+      def xml_encode_attr(s)
+        HTMLEntities.new.encode(s, :basic, :hexadecimal).gsub(/\&#x([^;]+);/) { |x| "&#x#{$1.upcase};" }
+      end
+
+      # attributes are decoded into UTF-8, elements in extract_indexsee are still in entities
+      def extract_indexterms(terms)
+        terms.each_with_object({}) do |t, v|
+          term = t&.at(ns("./primary"))&.children&.to_xml
+          term2 = t&.at(ns("./secondary"))&.children&.to_xml
+          term3 = t&.at(ns("./tertiary"))&.children&.to_xml
+          index2bookmark(t)
+          v[term] ||= {}
+          v[term][term2] ||= {}
+          v[term][term2][term3] ||= {}
+          v[term][term2][term3][:xref] ||= []
+          to = t["to"] ? "to='#{t['to']}' " : ""
+          v[term][term2][term3][:xref] << "<xref target='#{t['id']}' #{to}pagenumber='true'/>"
+        end
+      end
+
+      def index2bookmark(t)
+        t.name = "bookmark"
+        t.children.each { |x| x.remove }
+        t["id"] = "_#{UUIDTools::UUID.random_create}"
+      end
+    end
+  end
+end