metanorma-iso 1.7.0 → 1.8.0

data/lib/asciidoctor/iso/isostandard-amd.rng

@@ -39,6 +39,9 @@
           </choice>
         </attribute>
         <ref name="bibdata"/>
+        <optional>
+          <ref name="misccontainer"/>
+        </optional>
         <optional>
           <ref name="boilerplate"/>
         </optional>

data/lib/asciidoctor/iso/isostandard.rng

@@ -79,19 +79,6 @@
         </choice>
       </element>
     </define>
-    <define name="ul">
-      <element name="ul">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <oneOrMore>
-          <ref name="ul_li"/>
-        </oneOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </element>
-    </define>
     <define name="sections">
       <element name="sections">
         <zeroOrMore>
@@ -192,17 +179,6 @@
         </zeroOrMore>
       </element>
     </define>
-    <define name="definition">
-      <element name="definition">
-        <oneOrMore>
-          <choice>
-            <ref name="paragraph"/>
-            <ref name="figure"/>
-            <ref name="formula"/>
-          </choice>
-        </oneOrMore>
-      </element>
-    </define>
     <define name="annex">
       <element name="annex">
         <optional>
@@ -333,6 +309,11 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -341,6 +322,12 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
@@ -358,57 +345,6 @@
         </oneOrMore>
       </choice>
     </define>
-    <define name="table">
-      <element name="table">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <optional>
-          <attribute name="width"/>
-        </optional>
-        <optional>
-          <attribute name="unnumbered">
-            <data type="boolean"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="number"/>
-        </optional>
-        <optional>
-          <attribute name="subsequence"/>
-        </optional>
-        <optional>
-          <attribute name="alt"/>
-        </optional>
-        <optional>
-          <attribute name="summary"/>
-        </optional>
-        <optional>
-          <attribute name="uri">
-            <data type="anyURI"/>
-          </attribute>
-        </optional>
-        <optional>
-          <ref name="colgroup"/>
-        </optional>
-        <optional>
-          <ref name="tname"/>
-        </optional>
-        <optional>
-          <ref name="thead"/>
-        </optional>
-        <ref name="tbody"/>
-        <optional>
-          <ref name="tfoot"/>
-        </optional>
-        <zeroOrMore>
-          <ref name="table-note"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="dl"/>
-        </optional>
-      </element>
-    </define>
   </include>
   <!-- end overrides -->
   <!--
@@ -428,6 +364,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -439,6 +378,9 @@
         <ref name="annex"/>
       </zeroOrMore>
       <ref name="bibliography"/>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="horizontal">
@@ -527,28 +469,6 @@
       <ref name="Clause-Section"/>
     </element>
   </define>
-  <define name="ul_li">
-    <element name="li">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="uncheckedcheckbox">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="checkedcheckbox">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
-    </element>
-  </define>
   <define name="stagename">
     <element name="stagename">
       <text/>

data/lib/asciidoctor/iso/validate.rb

@@ -209,6 +209,7 @@ module Asciidoctor
       def image_name_validate(xmldoc)
         prefix = image_name_prefix(xmldoc) or return
         xmldoc.xpath("//image").each do |i|
+          next if i["src"].start_with?("data:")
           if /^ISO_\d+_/.match(File.basename(i["src"]))
           elsif /^(SL)?#{prefix}fig/.match(File.basename(i["src"]))
             image_name_validate1(i, prefix)

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,20 +45,22 @@ 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']")
+        title_main_en = title_lang_part(root, "main", "en")
         if !title_main_en.nil? && doctypes.match(title_main_en.text)
           @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']")
+        title_intro_en = title_lang_part(root, "intro", "en")
         if !title_intro_en.nil? && doctypes.match(title_intro_en.text)
-          @log.add("Style", title_intro_en, "Title Intro may name document type")
+          @log.add("Style", title_intro_en,
+                   "Title Intro may name document type")
         end
       end
 
@@ -64,8 +70,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 +89,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

@@ -152,6 +152,17 @@ module IsoDoc
           name and 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
   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