metanorma-bipm 0.0.2 → 1.0.1

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

@@ -1 +1,10 @@
 annex: Appendix
+appendix: Annex
+see: see
+see_also: see also
+clause: Chapter
+subclause: Section
+formula: Equation
+inequality: Inequality
+bibliography: References
+index: Index

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

@@ -1,4 +1,22 @@
 annex: Annexe
+appendix: Appendice
+see: voir
+see_also: voir aussi
+clause: chapître
+subclause: section
+formula: équation
+inequality: inégalité
+bibliography: Références
+note_xref: note
+termnote: note % à l’article
+list: liste
+figure: figure
+table: tableau
+requirement: exigence
+recommendation: recommandation
+permission: autorisation
+example_xref: exemple
+index: Index
 doctype_dict: 
   brochure: brochure
   mise-en-pratique: mise-en-pratique
@@ -12,7 +30,7 @@ doctype_dict:
   cipm-mra: cipm-mra
   resolution: résolution
 stage_dict: 
-    draft-proposal: projet-de-proposition
-    draft-development: projet-de-développement
-    in-force: en-vigeur
-    retired: retiré
+  draft-proposal: projet-de-proposition
+  draft-development: projet-de-développement
+  in-force: en-vigeur
+  retired: retiré

data/lib/isodoc/bipm/index.rb

@@ -0,0 +1,136 @@
+require "twitter_cldr"
+require "sterile"
+
+module IsoDoc
+  module BIPM
+    class PresentationXMLConvert < IsoDoc::Generic::PresentationXMLConvert
+       def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
+      def index(docxml)
+        return unless docxml.at(ns("//index"))
+        i = docxml.root.add_child "<clause type='index' #{add_id}><title>#{@i18n.index}</title></clause>"
+        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)
+        index.keys.sort.each do |k|
+          c = i.first.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)
+          end
+        end
+        @xrefs.bookmark_anchor_names(docxml.xpath(ns(@xrefs.sections_xpath)))
+      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

data/lib/isodoc/bipm/metadata.rb

@@ -7,17 +7,34 @@ module IsoDoc
         Metanorma::BIPM.configuration
       end
 
+      SI_ASPECT = %w(A_e_deltanu A_e cd_Kcd_h_deltanu cd_Kcd full K_k_deltanu
+      K_k kg_h_c_deltanu kg_h m_c_deltanu m_c mol_NA s_deltanu).freeze
+
+      def initialize(lang, script, labels)
+        super
+        here = File.join(File.dirname(__FILE__), "html", "si-aspect")
+        si_paths = []
+        SI_ASPECT.each do |s|
+          si_paths << File.expand_path(File.join(here, "#{s}.png"))
+        end
+        set(:si_aspect_index, SI_ASPECT)
+        set(:si_aspect_paths, si_paths)
+      end
+
+      TITLE = "//bibdata/title".freeze
+
       def title(isoxml, _out)
-        lang1 = @lang == "fr" ? "fr" : "en"
-        lang2 = @lang == "fr" ? "en" : "fr"
+        lang1, lang2  = @lang == "fr" ? %w(fr en) : %w(en fr)
         set(:doctitle, @c.encode(isoxml&.at(
-          ns("//bibdata/title[@type='main'][@language='#{lang1}']"))&.text || ""))
+          ns("#{TITLE}[@type='main'][@language='#{lang1}']"))&.text || ""))
         set(:docsubtitle, @c.encode(isoxml&.at(
-          ns("//bibdata/title[@type='main'][@language='#{lang2}']"))&.text || ""))
-        set(:appendixtitle, @c.encode(isoxml&.at(
-          ns("//bibdata/title[@type='appendix'][@language='#{lang1}']"))&.text || ""))
-        set(:appendixsubtitle, @c.encode(isoxml&.at(
-          ns("//bibdata/title[@type='appendix'][@language='#{lang2}']"))&.text || ""))
+          ns("#{TITLE}[@type='main'][@language='#{lang2}']"))&.text || ""))
+        %w(appendix part subtitle).each do |e|
+          set("#{e}title".to_sym, @c.encode(isoxml&.at(
+            ns("#{TITLE}[@type='#{e}'][@language='#{lang1}']"))&.text || ""))
+          set("#{e}subtitle".to_sym, @c.encode(isoxml&.at(
+            ns("#{TITLE}[@type='#{e}'][@language='#{lang2}']"))&.text || ""))
+        end
       end
 
       def status_print(status)
@@ -30,11 +47,18 @@ module IsoDoc
 
       def docid(isoxml, _out)
         super
-        label1 = @lang == "fr" ? "Annexe" : "Appendix"
-        label2 = @lang == "fr" ? "Appendix" : "Annexe"
+        label1, label2 = @lang == "fr" ? %w(Annexe Appendix) : %w(Appendix Annexe)
         dn = isoxml.at(ns("//bibdata/ext/structuredidentifier/appendix"))
         dn and set(:appendixid, @i18n.l10n("#{label1} #{dn&.text}"))
         dn and set(:appendixid_alt, @i18n.l10n("#{label2} #{dn&.text}"))
+        label1, label2  = @lang == "fr" ? %w(Partie Part) : %w(Part Partie)
+        dn = isoxml.at(ns("//bibdata/ext/structuredidentifier/part"))
+        dn and set(:partid, @i18n.l10n("#{label1} #{dn&.text}"))
+        dn and set(:partid_alt, @i18n.l10n("#{label2} #{dn&.text}"))
+      end
+
+      def extract_person_names_affiliations(authors)
+        extract_person_affiliations(authors)
       end
     end
   end

data/lib/isodoc/bipm/pdf_convert.rb

@@ -10,12 +10,23 @@ module IsoDoc
         super
       end
 
+      def configuration
+        Metanorma::BIPM.configuration
+      end
+
       def pdf_stylesheet(docxml)
-        "bipm.brochure.xsl"
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        doctype = "brochure" unless %w(guide mise-en-pratique rapport).
+          include? doctype
+        "bipm.#{doctype}.xsl"
       end
 
       def pdf_options(docxml)
-        if docxml.root.name == "metanorma-collection"
+        if docxml.root.name == "metanorma-collection" &&
+            docxml.at("//m:bipm-standard/m:bibdata/m:language[@current = 'true'][. = 'fr']",
+                      "m" => configuration.document_namespace) &&
+            docxml.at("//m:bipm-standard/m:bibdata/m:language[@current = 'true'][. = 'en']",
+                      "m" => configuration.document_namespace)
           "--split-by-language"
         else
           super

data/lib/isodoc/bipm/presentation_xml_convert.rb

@@ -1,6 +1,7 @@
 require "isodoc"
 require "metanorma-generic"
 require_relative "init"
+require_relative "index"
 
 module IsoDoc
   module BIPM
@@ -9,19 +10,114 @@ module IsoDoc
         return if labelled_ancestor(f)
         return if f["unnumbered"] && !f.at(ns("./name"))
         n = @xrefs.anchor(f['id'], :label, false)
-        prefix_name(f, ".<tab/>", l10n("#{@i18n.table} #{n}"), "name")
+        prefix_name(f, ".<tab/>", l10n("#{@i18n.table.capitalize} #{n}"), "name")
       end
 
       def annex1(f)
-      lbl = @xrefs.anchor(f['id'], :label)
-      if t = f.at(ns("./title"))
-        t.children = "<strong>#{t.children.to_xml}</strong>"
+        return if f["unnumbered"] == "true"
+        lbl = @xrefs.anchor(f['id'], :label)
+        if t = f.at(ns("./title"))
+          t.children = "<strong>#{t.children.to_xml}</strong>"
+        end
+        prefix_name(f, ".<tab/>", lbl, "title")
+      end
+
+      def clause1(f)
+        return if f["unnumbered"] == "true"
+        return if f.at(("./ancestor::*[@unnumbered = 'true']"))
+        super
+      end
+
+      def conversions(docxml)
+        super
+        doccontrol docxml
+      end
+
+      def doccontrol docxml
+        return unless docxml.at(ns("//bibdata/relation[@type = 'supersedes']"))
+        clause = <<~END
+        <doccontrol>
+        <title>Document Control</title>
+        <table unnumbered="true"><tbody>
+        <tr><td>Authors:</td><td/><td>#{list_authors(docxml)}</td></tr>
+        <tr>#{list_draft(docxml, 1)&.map { |x| "<td>#{x}</td>" }&.join }
+        <td>#{list_cochairs(docxml)}</td></tr>
+        <tr>#{list_draft(docxml, 2)&.map { |x| "<td>#{x}</td>" }&.join }
+        <td>#{list_chairs(docxml)}</td></tr>
+        #{list_drafts(docxml)}
+        </tbody></table></doccontrol>
+        END
+        docxml.root << clause
+      end
+
+      def list_drafts(xml)
+        ret = ""
+        i = 3
+        while a = list_draft(xml, i)
+          ret += "<tr>#{list_draft(xml, i).map { |x| "<td>#{x}</td>" }.join }"\
+            "<td/></tr>"
+          i += 1
+        end
+        ret
+      end
+
+      def list_draft(xml, i)
+        return unless d =
+          xml.at(ns("//bibdata/relation[@type = 'supersedes'][#{i}]/bibitem"))
+        date = d&.at(ns("./date"))&.text
+        draft = d&.at(ns("./version/draft"))&.text and
+          draft = "Draft #{draft}"
+        edn = d&.at(ns("./edition"))&.text and
+          edn = "Edition #{edn}"
+        [date, [draft, edn].join(" ")]
+      end
+
+      def list_authors(xml)
+        ret = list_people(
+          xml, "//bibdata/contributor[xmlns:role/@type = 'author']/person")
+        @i18n.multiple_and(ret, @i18n.get["and"])
+      end
+
+      COCHAIR = "xmlns:role[contains(text(),'co-chair')]".freeze
+      CHAIR = "[xmlns:role[contains(text(),'chair')]"\
+        "[not(contains(text(),'co-chair'))]]".freeze
+
+      def list_cochairs(xml)
+        ret = list_people(xml, "//bibdata/contributor[#{COCHAIR}]/person")
+        role = xml&.at(ns("//bibdata/contributor[#{COCHAIR}]/role"))&.text
+        label = ret.size > 1 && role ? "#{role}s" : role
+        "#{label}: #{@i18n.multiple_and(ret, @i18n.get["and"])}"
+      end
+
+      def list_chairs(xml)
+        ret = list_people(xml, "//bibdata/contributor#{CHAIR}/person")
+        role = xml&.at(ns("//bibdata/contributor#{CHAIR}/role"))&.text
+        label = ret.size > 1 && role ? "#{role}s" : role
+        "#{label}: #{@i18n.multiple_and(ret, @i18n.get["and"])}"
+      end
+
+      def list_people(xml, xpath)
+        ret = []
+        xml.xpath(ns(xpath)).each do |p|
+          name = p&.at(ns("./name/completename"))&.text
+          aff = p&.at(ns("./affiliation/organization/abbreviation"))&.text ||
+            p&.at(ns("./affiliation/organization/name"))&.text
+          c = name || ""
+          aff and c += " (#{aff})"
+          ret << c
+        end
+        ret
+      end
+
+      def twitter_cldr_localiser_symbols
+        { group: "&#x202F;", fraction_group: "&#x202F;", fraction_group_digits: 3 }
+      end
+
+      def mathml1(f, locale)
+        localize_maths(f, locale)
       end
-      prefix_name(f, ".<tab/>", lbl, "title")
-    end
 
       include Init
     end
   end
 end
-

data/lib/isodoc/bipm/xref.rb

@@ -1,15 +1,150 @@
 module IsoDoc
   module BIPM
     class Xref < IsoDoc::Xref
+      def initialize(lang, script, klass, i18n, options = {})
+        super
+      end
+
+      def clause_names(docxml, sect_num)
+        sect_num = 0
+        docxml.xpath(ns("//sections/clause[not(@unnumbered = 'true')] | "\
+                        "//sections/terms[not(@unnumbered = 'true')] | "\
+                        "//sections/definitions[not(@unnumbered = 'true')]")).
+        each_with_index do |c, i|
+          section_names(c, (i + sect_num), 1)
+        end
+        docxml.xpath(ns("//sections/clause[@unnumbered = 'true'] | "\
+                        "//sections/terms[@unnumbered = 'true'] | "\
+                        "//sections/definitions[@unnumbered = 'true']")).
+        each do |c|
+          unnumbered_section_names(c, 1)
+        end
+      end
+
+      NUMBERED_SUBCLAUSES = "./clause[not(@unnumbered = 'true')] | "\
+        "./references[not(@unnumbered = 'true')] | "\
+        "./term[not(@unnumbered = 'true')] | "\
+        "./terms[not(@unnumbered = 'true')] | "\
+        "./definitions[not(@unnumbered = 'true')]".freeze
+
+      UNNUMBERED_SUBCLAUSES = "./clause[@unnumbered = 'true'] | "\
+        "./references[@unnumbered = 'true'] | "\
+        "./term[@unnumbered = 'true'] | "\
+        "./terms[@unnumbered = 'true'] | "\
+        "./definitions[@unnumbered = 'true']".freeze
+
+      def section_names(clause, num, lvl)
+        return num if clause.nil?
+        num = num + 1
+        @anchors[clause["id"]] =
+          { label: num.to_s, xref: l10n("#{@labels["clause"]} #{num}"),
+            level: lvl, type: "clause" }
+        clause.xpath(ns(NUMBERED_SUBCLAUSES)).each_with_index do |c, i|
+          section_names1(c, "#{num}.#{i + 1}", lvl + 1)
+        end
+        clause.xpath(ns(UNNUMBERED_SUBCLAUSES)).each_with_index do |c, i|
+          unnumbered_section_names1(c, lvl + 1)
+        end
+        num
+      end
+
+      def unnumbered_section_names(clause, lvl)
+        return if clause.nil?
+        lbl = clause&.at(ns("./title"))&.text || "[#{clause["id"]}]"
+        @anchors[clause["id"]] =
+          { label: lbl, xref: l10n(%{"#{lbl}"}), level: lvl, type: "clause" }
+        clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
+          unnumbered_section_names1(c, lvl + 1)
+        end
+      end
+
+      def section_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { label: num, level: level, xref: l10n("#{@labels["subclause"]} #{num}"),
+            type: "clause" }
+        clause.xpath(ns(NUMBERED_SUBCLAUSES)).each_with_index do |c, i|
+          section_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+        clause.xpath(ns(UNNUMBERED_SUBCLAUSES)).each_with_index do |c, i|
+          unnumbered_section_names1(c, lvl + 1)
+        end
+      end
+
+      def unnumbered_section_names1(clause, level)
+        lbl = clause&.at(ns("./title"))&.text || "[#{clause["id"]}]"
+        @anchors[clause["id"]] =
+          { label: lbl, xref: l10n(%{"#{lbl}"}), level: level, type: "clause" }
+        clause.xpath(ns(SUBCLAUSES)).each do |c|
+          unnumbered_section_names1(c, level + 1)
+        end
+      end
+
       def back_anchor_names(docxml)
         super
-        docxml.xpath(ns("//annex")).each_with_index do |c, i|
-          annex_names(c, (i+1).to_s)
+        @annexlbl = docxml.at(ns("//bibdata/ext/structuredidentifier/appendix")) ?
+          @labels["appendix"] : @labels["annex"]
+        docxml.xpath(ns("//annex[not(@unnumbered = 'true')]")).
+          each_with_index { |c, i| annex_names(c, (i+1).to_s) }
+        docxml.xpath(ns("//annex[@unnumbered = 'true']")).
+          each { |c| unnumbered_annex_names(c) }
+      end
+
+      def annex_names(clause, num)
+        @anchors[clause["id"]] =
+          { label: annex_name_lbl(clause, num), type: "clause", value: num.to_s,
+            xref: l10n("#{@annexlbl} #{num}"), level: 1 }
+        if a = single_annex_special_section(clause)
+          annex_names1(a, "#{num}", 1)
+        else
+          clause.xpath(ns(NUMBERED_SUBCLAUSES)).each_with_index do |c, i|
+            annex_names1(c, "#{num}.#{i + 1}", 2)
+          end
+          clause.xpath(ns(UNNUMBERED_SUBCLAUSES)).each do |c|
+            unnumbered_annex_names1(c, 2)
+          end
+        end
+        hierarchical_asset_names(clause, num)
+      end
+
+      def unnumbered_annex_names(clause)
+        lbl = clause&.at(ns("./title"))&.text || "[#{clause["id"]}]"
+        @anchors[clause["id"]] =
+          { label: lbl, type: "clause", value: "",
+            xref: l10n(%{"#{lbl}"}), level: 1 }
+        if a = single_annex_special_section(clause)
+          annex_names1(a, "#{num}", 1)
+        else
+          clause.xpath(ns(SUBCLAUSES)).each do |c|
+            unnumbered_annex_names1(c, 2)
+          end
+        end
+        hierarchical_asset_names(clause, lbl)
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { label: num, xref: l10n("#{@annexlbl} #{num}"),
+            level: level, type: "clause" }
+        clause.xpath(ns(NUMBERED_SUBCLAUSES)).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+        clause.xpath(ns(UNNUMBERED_SUBCLAUSES)).each do |c|
+          unnumbered_annex_names1(c, level + 1)
+        end
+      end
+
+      def unnumbered_annex_names1(clause, level)
+        lbl = clause&.at(ns("./title"))&.text || "[#{clause["id"]}]"
+        @anchors[clause["id"]] =
+          { label: lbl, xref: l10n(%{"#{lbl}"}),
+            level: level, type: "clause" }
+        clause.xpath(ns(SUBCLAUSES)).each do |c|
+          unnumbered_annex_names1(c, level + 1)
         end
       end
 
       def annex_name_lbl(clause, num)
-        l10n("<strong>#{@labels["annex"]} #{num}</strong>")
+        l10n("<strong>#{@annexlbl} #{num}</strong>")
       end
     end
   end