metanorma-iso 1.3.24 → 1.4.1

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

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/iso" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!-- default namespace isostandard = "https://www.metanorma.com/ns/iso" -->
+  <include href="isostandard.rng">
+    <start>
+      <ref name="iso-standard"/>
+    </start>
+    <define name="sections">
+      <element name="sections">
+        <oneOrMore>
+          <ref name="clause"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="clause">
+      <element name="clause">
+        <optional>
+          <attribute name="type"/>
+        </optional>
+        <optional>
+          <attribute name="change">
+            <choice>
+              <value>add</value>
+              <value>delete</value>
+              <value>modify</value>
+            </choice>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="locality"/>
+        </optional>
+        <ref name="Clause-Section"/>
+      </element>
+    </define>
+    <define name="iso-standard">
+      <element name="iso-standard">
+        <ref name="bibdata"/>
+        <optional>
+          <ref name="boilerplate"/>
+        </optional>
+        <ref name="preface"/>
+        <oneOrMore>
+          <ref name="sections"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="documentnumber">
+      <element name="project-number">
+        <optional>
+          <attribute name="part">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="subpart">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="amendment">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="corrigendum">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="origyr">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <text/>
+      </element>
+    </define>
+    <define name="BibDataExtensionType">
+      <ref name="doctype"/>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <ref name="structuredidentifier"/>
+      <optional>
+        <ref name="stagename"/>
+      </optional>
+      <optional>
+        <ref name="updates_document_type"/>
+      </optional>
+    </define>
+  </include>
+  <!-- end overrides -->
+  <define name="updates_document_type">
+    <element name="updates-document-type">
+      <ref name="DocumentType"/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/iso/isostandard.rng

@@ -91,6 +91,12 @@
     </define>
     <define name="sections">
       <element name="sections">
+        <zeroOrMore>
+          <choice>
+            <ref name="note"/>
+            <ref name="admonition"/>
+          </choice>
+        </zeroOrMore>
         <ref name="clause"/>
         <optional>
           <choice>
@@ -263,6 +269,8 @@
         <value>publicly-available-specification</value>
         <value>international-workshop-agreement</value>
         <value>guide</value>
+        <value>amendment</value>
+        <value>technical-corrigendum</value>
       </choice>
     </define>
     <define name="structuredidentifier">
@@ -354,6 +362,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
         <optional>
           <attribute name="subsequence"/>
         </optional>
@@ -510,7 +521,7 @@
         </attribute>
       </optional>
       <oneOrMore>
-        <ref name="paragraph-with-footnote"/>
+        <ref name="BasicBlock"/>
       </oneOrMore>
     </element>
   </define>

data/lib/asciidoctor/iso/reqt.rng

@@ -30,9 +30,22 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="subsequence"/>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
@@ -141,6 +154,16 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/asciidoctor/iso/section.rb

@@ -35,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

@@ -31,23 +31,20 @@ module Asciidoctor
             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,
+        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)
+        term_name_node.name = "strong"
+        term_name_node.children.first.content =
+          %(term "#{term_name_node.text}" not resolved)
+        node.add_previous_sibling(term_name_node)
         node.remove
       end
 
@@ -60,15 +57,15 @@ module Asciidoctor
 
       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)
+                  unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node['id']).nil?
         term_node['id'] = unique_text_id(term_text)
+                  end
         res_table[term_text] = term_node['id']
       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,13 +55,16 @@ 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[@normative = 'true']")
-            @log.add("Style", t, "'see #{t}' is pointing to a normative reference")
+            @log.add("Style", t,
+                     "'see #{t}' is pointing to a normative reference")
           end
         end
       end
@@ -67,8 +74,9 @@ module Asciidoctor
         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
@@ -105,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)
@@ -157,20 +170,24 @@ module Asciidoctor
 
       def bibitem_validate(xmldoc)
         xmldoc.xpath("//bibitem[date/on = '–']").each do |b|
-          found = false
-          b.xpath("./note").each do |n|
-            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")
+          b.at("./note[@type = 'ISO DATE']") or
+            @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_requirements.rb

@@ -16,7 +16,7 @@ module Asciidoctor
            (is|are)_not_(allowed | permitted |
                          acceptable | permissible) |
            (is|are)_not_to_be |
-           do_not )
+           [.,:;]_do_not )
         \\b
       REGEXP
       REQUIREMENT_RE =

data/lib/asciidoctor/iso/validate_style.rb

@@ -1,6 +1,6 @@
 require "metanorma-standoc"
 require "nokogiri"
-require "pp"
+require "tokenizer"
 
 module Asciidoctor
   module ISO
@@ -70,7 +70,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 = text.split(/\W+/)
+        arr = Tokenizer::WhitespaceTokenizer.new.tokenize(text)
         arr.each_index do |i|
           m = re.match arr[i]
           m_prev = i.zero? ? nil : re_prev.match(arr[i - 1])
@@ -91,9 +91,10 @@ module Asciidoctor
       # ISO/IEC DIR 2, 9.1
       # ISO/IEC DIR 2, Table B.1
       def style_number(n, t)
-        style_two_regex_not_prev(n, t, /^(?<num>-?[0-9]{4,}[,0-9]*)$/,
-                                 %r{(\bISO|\bIEC|\bIEEE/)$},
-                                 "number not broken up in threes")
+        style_two_regex_not_prev(
+          n, t, /^(?<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")
         style_regex(/\b(?<num>[0-9]+\.[0-9]+)/i,
                     "possible decimal point", n, t)
         style_regex(/\b(?<num>billion[s]?)\b/i,

data/lib/asciidoctor/iso/validate_title.rb

@@ -36,7 +36,7 @@ module Asciidoctor
 
       # ISO/IEC DIR 2, 11.4
       def title_subpart_validate(root)
-        docid = root.at("//bibdata/docidentifier[@type = 'iso']")
+        docid = root.at("//bibdata/docidentifier[@type = 'ISO']")
         subpart = /-\d+-\d+/.match docid
         iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
                       "organization[abbreviation = 'IEC' or "\

data/lib/isodoc/iso/base_convert.rb

@@ -1,5 +1,7 @@
 require "isodoc"
 require_relative "metadata"
+require_relative "sections"
+require_relative "xref"
 require "fileutils"
 
 module IsoDoc
@@ -9,43 +11,25 @@ module IsoDoc
         @meta = Metadata.new(lang, script, labels)
       end
 
-      def implicit_reference(b)
-        b&.at(ns("./docidentifier"))&.text == "IEV"
+      def xref_init(lang, script, klass, labels, options)
+        @xrefs = Xref.new(lang, script, klass, labels, options)
       end
 
-      def introduction(isoxml, out)
-        f = isoxml.at(ns("//introduction")) || return
-        num = f.at(ns(".//clause")) ? "0" : nil
-        title_attr = { class: "IntroTitle" }
-        page_break(out)
-        out.div **{ class: "Section3", id: f["id"] } do |div|
-          clause_name(num, @introduction_lbl, div, title_attr)
-          f.elements.each do |e|
-            parse(e, div) unless e.name == "title"
-          end
-        end
+      def amd(docxml)
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        %w(amendment technical-corrigendum).include? doctype
       end
 
-      def foreword(isoxml, out)
-        f = isoxml.at(ns("//foreword")) || return
-        page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @foreword_lbl }
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+      def convert1(docxml, filename, dir)
+        if amd(docxml)
+          @oldsuppressheadingnumbers = @suppressheadingnumbers
+          @suppressheadingnumbers = true
         end
-      end
-
-      def initial_anchor_names(d)
         super
-        introduction_names(d.at(ns("//introduction")))
       end
 
-      # we can reference 0-number clauses in introduction
-      def introduction_names(clause)
-        return if clause.nil?
-        clause.xpath(ns("./clause")).each_with_index do |c, i|
-          section_names1(c, "0.#{i + 1}", 2)
-        end
+      def implicit_reference(b)
+        b&.at(ns("./docidentifier"))&.text == "IEV"
       end
 
       # terms not defined in standoc
@@ -57,36 +41,6 @@ module IsoDoc
         end
       end
 
-      def annex_names(clause, num)
-        appendix_names(clause, num)
-        super
-      end
-
-      def appendix_names(clause, num)
-        clause.xpath(ns("./appendix")).each_with_index do |c, i|
-          @anchors[c["id"]] = anchor_struct(i + 1, nil, @appendix_lbl, "clause")
-          @anchors[c["id"]][:level] = 2
-          @anchors[c["id"]][:container] = clause["id"]
-        end
-      end
-
-      def section_names1(clause, num, level)
-        @anchors[clause["id"]] =
-          { label: num, level: level, xref: num }
-        # subclauses are not prefixed with "Clause"
-        clause.xpath(ns("./clause | ./terms | ./term | ./definitions | ./references")).
-          each_with_index do |c, i|
-          section_names1(c, "#{num}.#{i + 1}", level + 1)
-        end
-      end
-
-      def annex_names1(clause, num, level)
-        @anchors[clause["id"]] = { label: num, xref: num, level: level }
-        clause.xpath(ns("./clause | ./references")).each_with_index do |c, i|
-          annex_names1(c, "#{num}.#{i + 1}", level + 1)
-        end
-      end
-
       def eref_localities1_zh(target, type, from, to, delim)
         subsection = from&.text&.match(/\./)
         ret = (delim == ";") ? ";" : (type == "list") ? "" : delim
@@ -100,6 +54,7 @@ module IsoDoc
       end
 
       def eref_localities1(target, type, from, to, delim, lang = "en")
+        return "" if type == "anchor"
         subsection = from&.text&.match(/\./)
         type = type.downcase
         return l10n(eref_localities1_zh(target, type, from, to, delim)) if lang == "zh"
@@ -114,12 +69,12 @@ module IsoDoc
       end
 
       def prefix_container(container, linkend, target)
-        delim = anchor(target, :type) == "listitem" ? " " : ", "
-        l10n(anchor(container, :xref) + delim + linkend)
+        delim = @xrefs.anchor(target, :type) == "listitem" ? " " : ", "
+        l10n(@xrefs.anchor(container, :xref) + delim + linkend)
       end
 
       def example_span_label(node, div, name)
-        n = get_anchors[node["id"]]
+        n = @xrefs.get[node["id"]]
         div.span **{ class: "example_label" } do |p|
           lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @example_lbl :
             l10n("#{@example_lbl} #{n[:label]}")
@@ -191,23 +146,6 @@ module IsoDoc
         ""
       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
-      end
-
-      def table_footnote_reference_format(a)
-        a.content = a.content + ")"
-      end
-
-      def clause_parse_title(node, div, c1, out)
-        return inline_header_title(out, node, c1) if c1.nil?
-        super
-      end
-
       def cleanup(docxml)
         super
         table_th_center(docxml)
@@ -221,14 +159,57 @@ module IsoDoc
         end
       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"])
+      def formula_where(dl, out)
+        return if dl.nil?
+        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 << "#{@where_lbl} "
+          dl.at(ns("./dt")).children.each { |n| parse(n, s) }
+          s << " "
+        end
+        parse(dl.at(ns("./dd/p")), out)
+      end
+
+      def admonition_parse(node, out)
+        type = node["type"]
+        name = admonition_name(node, type)
+        out.div **{ id: node["id"], class: admonition_class(node) } do |div|
+          node.first_element_child.name == "p" ?
+            admonition_p_parse(node, div, name) : admonition_parse1(node, div, name)
+        end
+      end
+
+      def admonition_parse1(node, div, name)
+        div.p do |p|
+          admonition_name_parse(node, p, name) if name
+        end
+        node.children.each { |n| parse(n, div) unless n.name == "name" }
+      end
+
+      def admonition_p_parse(node, div, name)
+        div.p do |p|
+          admonition_name_parse(node, p, name) if name
+          node.first_element_child.children.each { |n| parse(n, p) }
+        end
+        node.element_children[1..-1].each { |n| parse(n, div) }
+      end
+
+      def admonition_name_parse(_node, div, name)
+        name.children.each { |n| parse(n, div) }
+        div << " &mdash; "
+      end
+
+      def figure_name_parse(node, div, name)
+        lbl = @xrefs.anchor(node['id'], :label, false)
+        lbl = nil if labelled_ancestor(node) && node.ancestors("figure").empty?
+        return if lbl.nil? && name.nil?
+        div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
+          figname = node.parent.name == "figure" ? "" : "#{@figure_lbl} "
+          lbl.nil? or p << l10n("#{figname}#{lbl}")
+          name and !lbl.nil? and p << "&nbsp;&mdash; "
+          name and name.children.each { |n| parse(n, div) }
         end
       end
     end