metanorma-iec 1.4.2 → 2.0.0

data/lib/isodoc/iec/presentation_xml_convert.rb

@@ -4,6 +4,14 @@ require "isodoc"
 module IsoDoc
   module Iec
     class PresentationXMLConvert < IsoDoc::Iso::PresentationXMLConvert
+      def i18n_init(lang, script, i18nyaml = nil)
+        super
+        @i18n_lg = {}
+        @i18n_lg["en"] = I18n.new("en", "Latn", i18nyaml || @i18nyaml)
+        @i18n_lg["fr"] = I18n.new("fr", "Latn", i18nyaml || @i18nyaml)
+        @i18n_lg["default"] = @i18n
+      end
+
       def clause(docxml)
         docxml.xpath(ns("//clause[not(ancestor::annex)] | "\
                         "//definitions | //references | "\
@@ -29,16 +37,196 @@ module IsoDoc
           .call(elem)
       end
 
+      DICT_PATHS = { doctype_dict: "./ext/doctype", stage_dict: "./status/stage",
+                     substage_dict: "./status/substage",
+                     function_dict: "./ext/function",
+                     horizontal_dict: "./ext/horizontal" }.freeze
+
       def bibdata_i18n(bib)
         fr = IsoDoc::Iec::I18n.new("fr", "Latn")
         en = IsoDoc::Iec::I18n.new("en", "Latn")
         [{ lang: "en", i18n: en }, { lang: "fr", i18n: fr }].each do |v|
-          { doctype_dict: "./ext/doctype", stage_dict: "./status/stage",
-            substage_dict: "./status/substage", function_dict: "./ext/function",
-            horizontal_dict: "./ext/horizontal" }.each do |lbl, xpath|
-              hash_translate(bib, v[:i18n].get[lbl.to_s], xpath, v[:lang])
-            end
+          DICT_PATHS.each do |lbl, xpath|
+            hash_translate(bib, v[:i18n].get[lbl.to_s], xpath, v[:lang])
+          end
+        end
+      end
+
+      def concept(docxml)
+        @is_iev and concept_iev(docxml)
+        super
+      end
+
+      def concept_iev(docxml)
+        labels = @xrefs.get_anchors.each_with_object({}) do |(k, v), m|
+          m[v[:label]] = k
+        end
+        docpart = docxml&.at(ns("//bibdata/ext/structuredidentifier/"\
+                                "project-number/@part"))&.text or return
+        docxml.xpath(ns("//termref[@base = 'IEV']")).each do |t|
+          concept_iev1(t, docpart, labels)
+        end
+      end
+
+      def concept_iev1(termref, docpart, labels)
+        /^#{docpart}-/.match?(termref["target"]) or return
+        newtarget = labels[termref["target"]] or return
+        termref.name = "xref"
+        termref.delete("base")
+        termref["target"] = newtarget
+      end
+
+      def terms(docxml)
+        otherlang_designations(docxml)
+        super
+        merge_fr_into_en_term(docxml)
+      end
+
+      def merge_fr_into_en_term(docxml)
+        return unless @is_iev
+
+        docxml.xpath(ns("//term[@language = 'en'][@tag]")).each do |en|
+          fr = docxml.at(ns("//term[@language = 'fr'][@tag = '#{en['tag']}']"))
+          merge_fr_into_en_term1(en, fr) if fr
+        end
+        @xrefs.parse docxml
+        docxml.xpath(ns("//term/name")).each(&:remove)
+        term(docxml)
+      end
+
+      def merge_fr_into_en_term1(en_term, fr_term)
+        dl = en_term&.at(ns("./dl[@type = 'other-lang']"))&.remove
+        en_term << fr_term.remove.children
+        en_term << dl if dl
+        en_term["language"] = "en,fr"
+        en_term.delete("tag")
+      end
+
+      def otherlang_designations(docxml)
+        return unless @is_iev
+
+        docxml.xpath(ns("//term")).each do |t|
+          otherlang_designations1(t, t["language"]&.split(/,/) || %w(en fr))
+        end
+      end
+
+      def extract_otherlang_designations(term, lgs)
+        term.xpath(ns(".//preferred/expression[@language]"))
+          .each_with_object([]) do |d, m|
+          lg = d["language"]
+          d.delete("language")
+          next if lgs.include?(lg)
+
+          p = d.parent
+          designation_annotate(p, d.at(ns("./name")))
+          m << { lang: lg, script: Metanorma::Utils.default_script(lg),
+                 designation: l10n_recursive(p.remove, lg).to_xml.strip }
+        end
+      end
+
+      def l10n_recursive(xml, lang)
+        script = Metanorma::Utils.default_script(lang)
+        c = HTMLEntities.new
+        xml.traverse do |x|
+          next unless x.text?
+
+          text = c.encode(c.decode(x.text), :hexadecimal)
+          x.replace(cleanup_entities(l10n(text, lang, script), is_xml: false))
         end
+        xml
+      end
+
+      def merge_otherlang_designations(desgn)
+        h = desgn.each_with_object({}) do |e, m|
+          if m[e[:lang]]
+            m[e[:lang]][:designation] += e[:designation]
+          else m[e[:lang]] = e
+          end
+        end
+        h.keys.sort.each_with_object([]) { |k, m| m << h[k] }
+      end
+
+      def otherlang_designations1(term, lgs)
+        pr = merge_otherlang_designations(
+          extract_otherlang_designations(term, lgs),
+        )
+        return if pr.empty?
+
+        prefs = pr.map do |p|
+          "<dt>#{p[:lang]}</dt>"\
+            "<dd language='#{p[:lang]}' script='#{p[:script]}'>"\
+            "#{cleanup_entities(p[:designation])}</dd>"
+        end
+        term << "<dl type='other-lang'>#{prefs.join}</dl>"
+      end
+
+      def related(docxml)
+        docxml.xpath(ns("//term[related]")).each { |f| move_related(f) }
+        super
+      end
+
+      def move_related(term)
+        defn = term.at(ns("./definition")) or return
+        term.xpath(ns("./related")).reverse.each do |r|
+          defn.next = r.remove
+        end
+      end
+
+      def related1(node)
+        lg = node&.at("./ancestor::xmlns:term/@language")&.text
+        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
+        p = node.at(ns("./preferred"))
+        ref = node.at(ns("./xref | ./eref | ./termref"))
+        label = @i18n.relatedterms[node["type"]].upcase
+        node.replace(l10n("<p>#{label}: "\
+                          "#{p.children.to_xml} (#{ref.to_xml})</p>"))
+        @i18n = @i18n_lg["default"]
+      end
+
+      def termsource_modification(node)
+        lg = node&.at("./ancestor::xmlns:term/@language")&.text
+        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
+        super
+        @i18n = @i18n_lg["default"]
+      end
+
+      def termsource1(node)
+        lg = node&.at("./ancestor::xmlns:term/@language")&.text
+        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
+        if @is_iev then termsource1_iev(node)
+        else super
+        end
+        @i18n = @i18n_lg["default"]
+      end
+
+      def termsource1_iev(elem)
+        while elem&.next_element&.name == "termsource"
+          elem << l10n("; #{elem.next_element.remove.children.to_xml}")
+        end
+        elem.children = l10n("#{@i18n.source}: #{elem.children.to_xml.strip}")
+      end
+
+      def termexample(docxml)
+        docxml.xpath(ns("//termexample")).each do |f|
+          termexample1(f)
+        end
+      end
+
+      def termexample1(elem)
+        lg = elem&.at("./ancestor::xmlns:term/@language")&.text
+        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
+        example1(elem)
+        @i18n = @i18n_lg["default"]
+      end
+
+      def termnote1(elem)
+        lg = elem&.at("./ancestor::xmlns:term/@language")&.text
+        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
+
+        val = @xrefs.anchor(elem["id"], :value) || "???"
+        lbl = @i18n.termnote.gsub(/%/, val)
+        prefix_name(elem, "", lower2cap(lbl), "name")
+        @i18n = @i18n_lg["default"]
       end
 
       include Init

data/lib/isodoc/iec/xref.rb

@@ -16,6 +16,7 @@ module IsoDoc
       def initial_anchor_names(d)
         super
         return unless @is_iev
+
         terms_iev_names(d)
         middle_section_asset_names(d)
         termnote_anchor_names(d)
@@ -24,21 +25,21 @@ module IsoDoc
 
       def terms_iev_names(d)
         d.xpath(ns("//sections/clause/terms")).each_with_index do |t, i|
-          num = "#{@iev_part}-%02d" % [i+1]
+          num = "#{@iev_part}-%02d" % [i + 1]
           @anchors[t["id"]] =
-            { label: num, xref: l10n("#{@labels["section_iev"]}-#{num}"), level: 2,
-              type: "clause" }
-          t.xpath(ns("./term")).each_with_index do |c, i|
-            num2 = "%02d" % [i+1]
+            { label: num, xref: l10n("#{@labels['section_iev']} #{num}"),
+              level: 2, type: "clause" }
+          t.xpath(ns("./term")).each_with_index do |c, j|
+            num2 = "%02d" % [j + 1]
             section_names1(c, "#{num}-#{num2}", 3)
           end
         end
       end
 
       def annex_name_lbl(clause, num)
-        obl = l10n("(#{@labels["inform_annex"]})")
-        obl = l10n("(#{@labels["norm_annex"]})") if clause["obligation"] == "normative"
-        l10n("<strong>#{@labels["annex"]} #{num}</strong><br/>#{obl}")
+        obl = l10n("(#{@labels['inform_annex']})")
+        obl = l10n("(#{@labels['norm_annex']})") if clause["obligation"] == "normative"
+        l10n("<strong>#{@labels['annex']} #{num}</strong><br/>#{obl}")
       end
     end
   end

data/lib/metanorma/iec/converter.rb

@@ -0,0 +1,143 @@
+require "asciidoctor"
+require "metanorma-iso"
+require "metanorma/iso/converter"
+require_relative "./front"
+
+module Metanorma
+  module Iec
+    class Converter < ISO::Converter
+      XML_ROOT_TAG = "iec-standard".freeze
+      XML_NAMESPACE = "https://www.metanorma.org/ns/iec".freeze
+
+      register_for "iec"
+
+      def init(node)
+        super
+        if @is_iev = node.attr("docnumber") == "60050"
+          @vocab = true
+          node.set_attr("docsubtype", "vocabulary")
+        end
+      end
+
+      def boilerplate_file(x_orig)
+        lang = case x_orig&.at("//bibdata/language")&.text
+               when "fr" then "fr"
+               else
+                 "en"
+               end
+        File.join(@libdir, "iec_intro_#{lang}.xml")
+      end
+
+      def doctype_validate(xmldoc)
+        doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
+        %w(international-standard technical-specification technical-report
+           publicly-available-specification international-workshop-agreement
+           guide interpretation-sheet).include? doctype or
+          @log.add("Document Attributes", nil,
+                   "#{doctype} is not a recognised document type")
+        if function = xmldoc&.at("//bibdata/ext/function")&.text
+          %w(emc quality-assurance safety environment).include? function or
+            @log.add("Document Attributes", nil,
+                     "#{function} is not a recognised document function")
+        end
+      end
+
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "iec.rng"))
+      end
+
+      def html_converter(node)
+        if node.nil?
+          IsoDoc::Iec::HtmlConvert.new({})
+        else
+          IsoDoc::Iec::HtmlConvert.new(html_extract_attributes(node))
+        end
+      end
+
+      def doc_converter(node)
+        if node.nil?
+          IsoDoc::Iec::WordConvert.new({})
+        else
+          IsoDoc::Iec::WordConvert.new(doc_extract_attributes(node))
+        end
+      end
+
+      def pdf_converter(node)
+        return if node.attr("no-pdf")
+
+        if node.nil?
+          IsoDoc::Iec::PdfConvert.new({})
+        else
+          IsoDoc::Iec::PdfConvert.new(pdf_extract_attributes(node))
+        end
+      end
+
+      def presentation_xml_converter(node)
+        if node.nil?
+          IsoDoc::Iec::PresentationXMLConvert.new({})
+        else
+          IsoDoc::Iec::PresentationXMLConvert.new(doc_extract_attributes(node))
+        end
+      end
+
+      def norm_ref_preface(node)
+        return super unless @is_iev
+
+        node.at("./title").next =
+          "<p>#{@i18n.norm_empty_pref}</p>"
+      end
+
+      def term_defs_boilerplate(div, source, term, preface, isodoc)
+        return super unless @is_iev
+      end
+
+      def sections_names_cleanup(xml)
+        super
+        @is_iev and replace_title(xml, "//introduction",
+                                  @i18n&.introduction_iev)
+      end
+
+      def note(note)
+        if note.title == "Note from TC/SC Officers"
+          noko do |xml|
+            xml.tc_sc_officers_note do |c|
+              wrap_in_para(note, c)
+            end
+          end.join("\n")
+        else
+          super
+        end
+      end
+
+      def note_cleanup(xmldoc)
+        super
+        n = xmldoc.at("//tc-sc-officers-note") and
+          xmldoc.at("//bibdata/ext").add_child(n.remove)
+      end
+
+      def image_name_validate(xmldoc); end
+
+      def toc_cleanup(xmldoc)
+        toc_iev_cleanup(xmldoc) if @is_iev
+        super
+      end
+
+      def toc_iev_cleanup(xmldoc)
+        iev_variant_titles(xmldoc)
+      end
+
+      def iev_variant_titles(xmldoc)
+        id = xmldoc&.at("//bibdata/docidentifier[@type = 'ISO']")&.text
+        m = /60050-(\d+)/.match(id) or return
+        xmldoc.xpath("//sections/clause/terms/title").each_with_index do |t, i|
+          num = "%02d" % [i + 1]
+          t.next = "<variant-title type='toc'>"\
+                   "#{@i18n.section_iev} #{m[1]}-#{num} &#x2013; "\
+                   "#{t.children.to_xml}</variant-title>"
+        end
+      end
+    end
+  end
+end

data/lib/{asciidoctor → metanorma}/iec/front.rb

@@ -1,4 +1,4 @@
-module Asciidoctor
+module Metanorma
   module Iec
     class Converter < ISO::Converter
       def metadata_author(node, xml)
@@ -199,9 +199,8 @@ module Asciidoctor
         end
       end
 
-      def metadata_doctype(node, xml)
-        xml.doctype doctype(node)
-        xml.horizontal (node.attr("horizontal") || "false")
+      def metadata_subdoctype(node, xml)
+        super
         a = node.attr("function") and xml.function a
       end
 

data/lib/{asciidoctor → metanorma}/iec/iec.rng

@@ -57,6 +57,54 @@
         <ref name="tc-sc-officers-note"/>
       </optional>
     </define>
+    <define name="term">
+      <element name="term">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="language"/>
+        </optional>
+        <optional>
+          <attribute name="script"/>
+        </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="preferred"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="admitted"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="deprecates"/>
+        </zeroOrMore>
+        <optional>
+          <ref name="termdomain"/>
+        </optional>
+        <ref name="termdefinition"/>
+        <zeroOrMore>
+          <ref name="termnote"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="termexample"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="termsource"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="term"/>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="function">