metanorma-iso 1.3.20 → 1.3.25

data/lib/asciidoctor/iso/macros.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/extensions'
+
+module Asciidoctor
+  module Iso
+    # Macro to transform `term[X,Y]` into em, termxref xml
+    class TermRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+
+      named :term
+      name_positional_attributes 'name', 'termxref'
+      using_format :short
+
+      def process(_parent, _target, attrs)
+        termref = attrs['termxref'] || attrs['name']
+        "<em>#{attrs['name']}</em> (<termxref>#{termref}</termxref>)"
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/section.rb

@@ -4,38 +4,12 @@ require "uri"
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-      def section(node)
-        a = section_attributes(node)
-        noko do |xml|
-          case sectiontype(node)
-          when "foreword" then foreword_parse(a, xml, node)
-          when "introduction" then introduction_parse(a, xml, node)
-          when "patent notice" then patent_notice_parse(xml, node)
-          when "scope" then scope_parse(a, xml, node)
-          when "normative references" then norm_ref_parse(a, xml, node)
-          when "terms and definitions"
-            @term_def = true
-            term_def_parse(a, xml, node, true)
-            @term_def = false
-          when "symbols and abbreviated terms"
-            symbols_parse(a, xml, node)
-          when "acknowledgements"
-            acknowledgements_parse(a, xml, node)
-          when "bibliography" then bibliography_parse(a, xml, node)
-          else
-            if @term_def then term_def_subclause_parse(a, xml, node)
-            elsif @biblio then bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "bibliography"
-              bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "appendix" && node.level == 1
-              annex_parse(a, xml, node)
-            elsif node.option? "appendix"
-              appendix_parse(a, xml, node)
-            else
-              clause_parse(a, xml, node)
-            end
-          end
-        end.join("\n")
+      def clause_parse(attrs, xml, node)
+        title = node&.attr("heading")&.downcase ||
+          node.title.gsub(/<[^>]+>/, "").downcase
+        title == "scope" and return scope_parse(attrs, xml, node)
+        node.option? "appendix" and return appendix_parse(attrs, xml, node)
+        super
       end
 
       def appendix_parse(attrs, xml, node)
@@ -61,6 +35,18 @@ module Asciidoctor
           xml_section << content
         end
       end
+
+      def section_attributes(node)
+        super.merge(
+          change: @amd ? node.attr("change") : nil,
+          locality: @amd ? node.attr("locality") : nil,
+        )
+      end
+
+      def sectiontype(node, level = true)
+        return nil if @amd
+        super
+      end
     end
   end
 end

data/lib/asciidoctor/iso/term_lookup_cleanup.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true.
+
+module Asciidoctor
+  module ISO
+    # Intelligent term lookup xml modifier
+    # Lookup all `term` and `calause` tags and replace `termxref` tags with
+    # `xref`:target tag
+    class TermLookupCleanup
+      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/
+      EXISTING_TERM_REGEXP = /\Aterm-/
+
+      attr_reader :xmldoc, :termlookup, :log
+
+      def initialize(xmldoc, log)
+        @xmldoc = xmldoc
+        @log = log
+        @termlookup = {}
+      end
+
+      def call
+        @termlookup = replace_automatic_generated_ids_terms
+        set_termxref_tags_target
+      end
+
+      private
+
+      def set_termxref_tags_target
+        xmldoc.xpath('//termxref').each do |node|
+          target = normalize_ref_id(node.text)
+          if termlookup[target].nil?
+            remove_missing_ref(node, target)
+            next
+          end
+
+          modify_ref_node(node, target)
+        end
+      end
+
+      def remove_missing_ref(node, target)
+        log.add('AsciiDoc Input',
+                node,
+                %(Error: Term reference in `term[#{target}]` missing: \
+                "#{target}" is not defined in document))
+        # Term ref have parentess around it - (ref),
+        # if no target remove parentes and render as text
+        node.next.remove
+        term_name_node = node.previous.previous
+        term_name_node.remove
+        node.previous.remove
+        node.add_previous_sibling(term_name_node.text)
+        node.remove
+      end
+
+      def modify_ref_node(node, target)
+        node.name = 'xref'
+        node['target'] = termlookup[target]
+        node.children.remove
+        node.remove_attribute('defaultref')
+      end
+
+      def replace_automatic_generated_ids_terms
+        xmldoc.xpath('//term').each.with_object({}) do |term_node, res|
+          next if AUTOMATIC_GENERATED_ID_REGEXP.match(term_node['id']).nil?
+
+          normalize_id_and_memorize(term_node, res, './preferred')
+        end
+      end
+
+      def normalize_id_and_memorize(term_node, res_table, text_selector)
+        term_text = normalize_ref_id(term_node.at(text_selector).text)
+        term_node['id'] = unique_text_id(term_text)
+        res_table[term_text] = term_node['id']
+      end
+
+      def normalize_ref_id(text)
+        text.downcase.gsub(/[[:space:]]/, '-')
+      end
+
+      def unique_text_id(text)
+        return "term-#{text}" if xmldoc.at("//*[@id = 'term-#{text}']").nil?
+
+        (1..Float::INFINITY).lazy.each do |index|
+          if xmldoc.at("//*[@id = 'term-#{text}-#{index}']").nil?
+            break("term-#{text}-#{index}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/validate.rb

@@ -24,12 +24,14 @@ module Asciidoctor
       def isosubgroup_validate(root)
         root.xpath("//technical-committee/@type").each do |t|
           unless %w{TC PC JTC JPC}.include? t.text
-            @log.add("Document Attributes", nil, "invalid technical committee type #{t}")
+            @log.add("Document Attributes", nil,
+                     "invalid technical committee type #{t}")
           end
         end
         root.xpath("//subcommittee/@type").each do |t|
           unless %w{SC JSC}.include? t.text
-            @log.add("Document Attributes", nil, "invalid subcommittee type #{t}")
+            @log.add("Document Attributes", nil,
+                     "invalid subcommittee type #{t}")
           end
         end
       end
@@ -39,10 +41,12 @@ module Asciidoctor
         root.xpath("//xref").each do |t|
           # does not deal with preceding text marked up
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\b(see| refer to)\s*$/mi.match(preceding)
+          next unless !preceding.nil? &&
+            /\b(see| refer to)\s*$/mi.match(preceding)
           (target = root.at("//*[@id = '#{t['target']}']")) || next
           if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
-            @log.add("Style", t, "'see #{t['target']}' is pointing to a normative section")
+            @log.add("Style", t,
+                     "'see #{t['target']}' is pointing to a normative section")
           end
         end
       end
@@ -51,25 +55,28 @@ module Asciidoctor
       def see_erefs_validate(root)
         root.xpath("//eref").each do |t|
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\b(see|refer to)\s*$/mi.match(preceding)
+          next unless !preceding.nil? &&
+            /\b(see|refer to)\s*$/mi.match(preceding)
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
-            @log.add("Bibliography", t, "'#{t} is not pointing to a real reference")
+            @log.add("Bibliography", t,
+                     "'#{t} is not pointing to a real reference")
             next
           end
-          if target.at("./ancestor::references"\
-              "[title = 'Normative References']")
-            @log.add("Style", t, "'see #{t}' is pointing to a normative reference")
+          if target.at("./ancestor::references[@normative = 'true']")
+            @log.add("Style", t,
+                     "'see #{t}' is pointing to a normative reference")
           end
         end
       end
 
       # ISO/IEC DIR 2, 10.4
       def locality_erefs_validate(root)
-        root.xpath("//eref[locality]").each do |t|
+        root.xpath("//eref[descendant::locality]").each do |t|
           if /^(ISO|IEC)/.match t["citeas"]
             unless /:[ ]?(\d+{4}|–)$/.match t["citeas"]
-              @log.add("Style", t, "undated reference #{t['citeas']} should not contain "\
-                "specific elements")
+              @log.add("Style", t,
+                       "undated reference #{t['citeas']} should not contain "\
+                       "specific elements")
             end
           end
         end
@@ -106,32 +113,37 @@ module Asciidoctor
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         %w(international-standard technical-specification technical-report 
         publicly-available-specification international-workshop-agreement 
-        guide).include? doctype or
-        @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
+        guide amendment technical-corrigendum).include? doctype or
+        @log.add("Document Attributes", nil,
+                 "#{doctype} is not a recognised document type")
       end
 
       def script_validate(xmldoc)
         script = xmldoc&.at("//bibdata/script")&.text
         script == "Latn" or
-          @log.add("Document Attributes", nil, "#{script} is not a recognised script")
+          @log.add("Document Attributes", nil,
+                   "#{script} is not a recognised script")
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(00 10 20 30 40 50 60 90 95).include? stage or
-          @log.add("Document Attributes", nil, "#{stage} is not a recognised stage")
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised stage")
       end
 
       def substage_validate(xmldoc)
         substage = xmldoc&.at("//bibdata/status/substage")&.text or return
         %w(00 20 60 90 92 93 98 99).include? substage or
-          @log.add("Document Attributes", nil, "#{substage} is not a recognised substage")
+          @log.add("Document Attributes", nil,
+                   "#{substage} is not a recognised substage")
       end
 
       def iteration_validate(xmldoc)
         iteration = xmldoc&.at("//bibdata/status/iteration")&.text or return
         /^\d+/.match(iteration) or
-          @log.add("Document Attributes", nil, "#{iteration} is not a recognised iteration")
+          @log.add("Document Attributes", nil,
+                   "#{iteration} is not a recognised iteration")
       end
 
       def bibdata_validate(doc)
@@ -163,15 +175,23 @@ module Asciidoctor
             found = true if /^ISO DATE:/.match n.text
           end
           found or
-            @log.add("Style", b, "Reference #{b&.at("./@id")&.text} does not have an "\
-          "associated footnote indicating unpublished status")
+            @log.add("Style", b,
+                     "Reference #{b&.at("./@id")&.text} does not have an "\
+                     "associated footnote indicating unpublished status")
         end
       end
 
       def validate(doc)
         content_validate(doc)
+        doctype = doc&.at("//bibdata/ext/doctype")&.text
+        schema = case doctype
+                 when "amendment", "technical-corrigendum" # @amd
+                   "isostandard-amd.rng"
+                 else
+                   "isostandard.rng"
+                 end
         schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "isostandard.rng"))
+                        File.join(File.dirname(__FILE__), schema))
       end
     end
   end

data/lib/asciidoctor/iso/validate_section.rb

@@ -22,7 +22,7 @@ module Asciidoctor
 
       # ISO/IEC DIR 2, 15.4
       def normref_validate(root)
-        f = root.at("//references[title = 'Normative References']") || return
+        f = root.at("//references[@normative = 'true']") || return
         f.at("./references | ./clause") &&
           @log.add("Style", f, "normative references contains subclauses")
       end
@@ -168,7 +168,7 @@ module Asciidoctor
         "//li[not(p)] | //dt | //dd[not(p)] | //td[not(p)] | //th[not(p)]".freeze
 
       NORM_BIBITEMS =
-        "//references[title = 'Normative References']/bibitem".freeze
+        "//references[@normative = 'true']/bibitem".freeze
 
       # ISO/IEC DIR 2, 10.2
       def norm_bibitem_style(root)

data/lib/asciidoctor/iso/validate_style.rb

@@ -8,7 +8,7 @@ module Asciidoctor
       def extract_text(node)
         return "" if node.nil?
         node1 = Nokogiri::XML.fragment(node.to_s)
-        node1.xpath("//link | //locality").each(&:remove)
+        node1.xpath("//link | //locality | //localityStack").each(&:remove)
         ret = ""
         node1.traverse { |x| ret += x.text if x.text? }
         ret

data/lib/isodoc/iso/base_convert.rb

@@ -9,6 +9,34 @@ module IsoDoc
         @meta = Metadata.new(lang, script, labels)
       end
 
+      def convert1(docxml, filename, dir)
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        @amd = %w(amendment technical-corrigendum).include? doctype
+        if @amd
+          @oldsuppressheadingnumbers = @suppressheadingnumbers
+          @suppressheadingnumbers = true
+        end
+        super
+      end
+
+      def annex(isoxml, out)
+        @amd and @suppressheadingnumbers = @oldsuppressheadingnumbers
+        super
+        @amd and @suppressheadingnumbers = true
+      end
+
+      def anchor_names(docxml)
+        if @amd
+          back_anchor_names(docxml)
+          note_anchor_names(docxml.xpath(ns("//annex//table | //annex//figure")))
+          note_anchor_names(docxml.xpath(ns("//annex")))
+          example_anchor_names(docxml.xpath(ns("//annex")))
+          list_anchor_names(docxml.xpath(ns("//annex")))
+        else
+          super
+        end
+      end
+
       def implicit_reference(b)
         b&.at(ns("./docidentifier"))&.text == "IEV"
       end
@@ -21,11 +49,7 @@ module IsoDoc
         out.div **{ class: "Section3", id: f["id"] } do |div|
           clause_name(num, @introduction_lbl, div, title_attr)
           f.elements.each do |e|
-            if e.name == "patent-notice"
-              e.elements.each { |e1| parse(e1, div) }
-            else
-              parse(e, div) unless e.name == "title"
-            end
+            parse(e, div) unless e.name == "title"
           end
         end
       end
@@ -91,9 +115,9 @@ module IsoDoc
         end
       end
 
-      def eref_localities1_zh(target, type, from, to)
+      def eref_localities1_zh(target, type, from, to, delim)
         subsection = from&.text&.match(/\./)
-        ret = type == "list" ? "" : ","
+        ret = (delim == ";") ? ";" : (type == "list") ? "" : delim
         ret += " 第#{from.text}" if from
         ret += "–#{to}" if to
         loc = (@locality[type] || type.sub(/^locality:/, "").capitalize )
@@ -103,11 +127,11 @@ module IsoDoc
         ret
       end
 
-      def eref_localities1(target, type, from, to, lang = "en")
+      def eref_localities1(target, type, from, to, delim, lang = "en")
         subsection = from&.text&.match(/\./)
         type = type.downcase
-        return l10n(eref_localities1_zh(target, type, from, to)) if lang == "zh"
-        ret = type == "list" ? "" : ","
+        return l10n(eref_localities1_zh(target, type, from, to, delim)) if lang == "zh"
+        ret = (delim == ";") ? ";" : (type == "list") ? "" : delim
         loc = @locality[type] || type.sub(/^locality:/, "").capitalize
         ret += " #{loc}" unless subsection && type == "clause" ||
           type == "list" || target.match(/^IEV$|^IEC 60050-/)
@@ -170,6 +194,15 @@ module IsoDoc
         end
       end
 
+      def insertall_after_here(node, insert, name)
+        node.children.each do |n|
+          next unless n.name == name
+          insert.next = n.remove
+          insert = n
+        end
+        insert
+      end
+
       def termexamples_before_termnotes(node)
         return unless node.at(ns("./termnote")) && node.at(ns("./termexample"))
         return unless insert = node.at(ns("./definition"))
@@ -177,23 +210,19 @@ module IsoDoc
         insert = insertall_after_here(node, insert, "termnote")
       end
 
-      def term_parse(node, out)
+      def termdef_parse(node, out)
         termexamples_before_termnotes(node)
-        out.p **{ class: "Terms", style:"text-align:left;" } do |p|
-          node.children.each { |c| parse(c, p) }
-        end
+        super
       end
 
       def clausedelim
         ""
       end
 
-      def format_ref(ref, prefix, isopub, date, allparts)
-        ref = ref.sub(/ \(All Parts\)/i, "")
-        ref = docid_prefix(prefix, ref)
-        return "[#{ref}]" if /^\d+$/.match(ref) && !prefix &&
-          !/^\[.*\]$/.match(ref)
-          ref
+      def reference_names(ref)
+        super
+        @anchors[ref["id"]] = { xref: @anchors[ref["id"]][:xref].
+                                sub(/ \(All Parts\)/i, "") }
       end
 
       def table_footnote_reference_format(a)
@@ -207,23 +236,10 @@ module IsoDoc
 
       def cleanup(docxml)
         super
-        remove_internal_hyperlinks(docxml)
         table_th_center(docxml)
         docxml
       end
 
-      def remove_internal_hyperlinks(docxml)
-        docxml.xpath("//a[@href]").each do |a|
-          next unless /^#/.match(a[:href])
-          anchor = a[:href].sub(/^#/, "")
-          next if a["epub:type"] == "footnote"
-          next unless @anchors[anchor]
-          next unless @anchors[anchor][:type]
-          next if @anchors[anchor][:type] == "clause"
-          a.replace(a.children)
-        end
-      end
-
       def table_th_center(docxml)
         docxml.xpath("//thead//th | //thead//td").each do |th|
           th["align"] = "center"
@@ -232,14 +248,14 @@ module IsoDoc
       end
 
       def hierarchical_formula_names(clause, num)
-      c = IsoDoc::Function::XrefGen::Counter.new
-       clause.xpath(ns(".//formula")).each do |t|
-         next if t["id"].nil? || t["id"].empty?
-         @anchors[t["id"]] =
-           anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", t,
-                         t["inequality"] ? @inequality_lbl : @formula_lbl,
-                         "formula", t["unnumbered"])
-       end
+        c = IsoDoc::Function::XrefGen::Counter.new
+        clause.xpath(ns(".//formula")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          @anchors[t["id"]] =
+            anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", t,
+                          t["inequality"] ? @inequality_lbl : @formula_lbl,
+                          "formula", t["unnumbered"])
+        end
       end
     end
   end