metanorma-iso 1.3.19 → 1.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cb914a2716a7b69da948ab0c1429449e23856ae88264944ed6cc5404d3ee0f3
-  data.tar.gz: 88847296644b6ba8112cf60624eef6ee13086002f6d0874484d3b4d19eb9912b
+  metadata.gz: a0620b97c9f91f8019da7ec0cb25086303d5a98c9eda18740e14c581acd8bcea
+  data.tar.gz: 35ca2d87cf4d58f1d8e8d174f8fe802c1e986ad5a6a6d13dc45125e2f4b9dfd6
 SHA512:
-  metadata.gz: 6223e510985b9bcedc831981437cce49d8e260573d10b9e841a08d37d4dd9c3363211e648a2c9e63e7377b26ef929e7fb0a43a40e424b7f56cd3047b5b92d715
-  data.tar.gz: 365452eb2e3cc2fc558bb800aad37abcdcb85e38f6ef5af7fd34457651174bba7789797974755b9b6298e711ff73ca301ddc7ee158c7c3cbf2f30dfbbe6a0e95
+  metadata.gz: 0c99794ef6ca381337f1be16465e1e97ac0656712608d69a7edbb5996213cca0cbe8c2558105e1543e0ef8760b7790dad9bed31b252b34cddd97d54b263be4d3
+  data.tar.gz: 51ca61be6991b07fd9f3b044bbd268893297bba14b59af561a2082983998e183548108e945cf113a9d0046055ced4f56600b0decc4fde38acb6730dd8295f951

data/lib/asciidoctor/iso/base.rb

@@ -36,6 +36,7 @@ module Asciidoctor
           html_converter(node).convert(@filename + ".xml")
           doc_converter(node).convert(@filename + ".xml")
         end
+        @log.write(@filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end

data/lib/asciidoctor/iso/cleanup.rb

@@ -91,6 +91,7 @@ module Asciidoctor
       # then standard class (docid class other than DOI &c)
       # then docnumber if present, numeric sort
       #      else alphanumeric metanorma id (abbreviation)
+      # then doc part number if present, numeric sort
       # then doc id (not DOI &c)
       # then title
       def sort_biblio_key(bib)
@@ -99,12 +100,13 @@ module Asciidoctor
         id = bib&.at("./docidentifier[not(#{OTHERIDS})]")
         metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
         abbrid = metaid unless /^\[\d+\]$/.match(metaid)
+        /\d-(?<partid>\d+)/ =~ id&.text
         type = id['type'] if id
         title = bib&.at("./title[@type = 'main']")&.text ||
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text
         "#{pubclass} :: #{type} :: "\
           "#{num.nil? ? abbrid : sprintf("%09d", num.to_i)} :: "\
-          "#{id&.text} :: #{title}"
+          "#{partid} :: #{id&.text} :: #{title}"
       end
     end
   end

data/lib/asciidoctor/iso/isodoc.rng

@@ -645,6 +645,11 @@
     <optional>
       <attribute name="script"/>
     </optional>
+    <optional>
+      <attribute name="inline-header">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <optional>
       <attribute name="obligation">
         <choice>

data/lib/asciidoctor/iso/isostandard.rng

@@ -73,6 +73,19 @@
         </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">
         <ref name="clause"/>
@@ -325,6 +338,51 @@
         </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="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="alt"/>
+        </optional>
+        <optional>
+          <attribute name="summary"/>
+        </optional>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </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 -->
   <!--
@@ -431,4 +489,26 @@
       <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="paragraph-with-footnote"/>
+      </oneOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/iso/validate.rb

@@ -17,19 +17,19 @@ module Asciidoctor
           title = c.at("./title")
           location = c["id"] || c.text[0..60] + "..."
           location += ":#{title.text}" if c["id"] && !title.nil?
-          warn "ISO style: #{location}: subclause is only child"
+          @log.add("Style", nil, "#{location}: subclause is only child")
         end
       end
 
       def isosubgroup_validate(root)
         root.xpath("//technical-committee/@type").each do |t|
           unless %w{TC PC JTC JPC}.include? t.text
-            warn "ISO: 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
-            warn "ISO: invalid subcommittee type #{t}"
+            @log.add("Document Attributes", nil, "invalid subcommittee type #{t}")
           end
         end
       end
@@ -42,7 +42,7 @@ module Asciidoctor
           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']")
-            warn "ISO: '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
@@ -53,12 +53,12 @@ module Asciidoctor
           preceding = t.at("./preceding-sibling::text()[last()]")
           next unless !preceding.nil? && /\b(see|refer to)\s*$/mi.match(preceding)
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
-            warn "ISO: '#{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']")
-            warn "ISO: 'see #{t}' is pointing to a normative reference"
+            @log.add("Style", t, "'see #{t}' is pointing to a normative reference")
           end
         end
       end
@@ -68,15 +68,15 @@ module Asciidoctor
         root.xpath("//eref[locality]").each do |t|
           if /^(ISO|IEC)/.match t["citeas"]
             unless /:[ ]?(\d+{4}|–)$/.match t["citeas"]
-              warn "ISO: 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
       end
 
-      def termdef_warn(text, re, term, msg)
-        re.match(text) && warn("ISO style: #{term}: #{msg}")
+      def termdef_warn(text, re, t, term, msg)
+        re.match(text) && @log.add("Style", t, "#{term}: #{msg}")
       end
 
       # ISO/IEC DIR 2, 16.5.6
@@ -84,9 +84,9 @@ module Asciidoctor
         xmldoc.xpath("//term").each do |t|
           para = t.at("./definition") || return
           term = t.at("./preferred").text
-          termdef_warn(para.text, /^(the|a)\b/i, term,
+          termdef_warn(para.text, /^(the|a)\b/i, t, term,
                        "term definition starts with article")
-          termdef_warn(para.text, /\.$/i, term,
+          termdef_warn(para.text, /\.$/i, t, term,
                        "term definition ends with period")
         end
         cited_term_style(xmldoc)
@@ -107,31 +107,31 @@ module Asciidoctor
         %w(international-standard technical-specification technical-report 
         publicly-available-specification international-workshop-agreement 
         guide).include? doctype or
-        warn "ISO Document Attributes: #{doctype} is not a recognised document type"
+        @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
-          warn "ISO Document Attributes: #{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
-          warn "ISO Document Attributes: #{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
-          warn "ISO Document Attributes: #{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
-          warn "ISO Document Attributes: #{iteration} is not a recognised iteration"
+          @log.add("Document Attributes", nil, "#{iteration} is not a recognised iteration")
       end
 
       def bibdata_validate(doc)
@@ -163,8 +163,8 @@ module Asciidoctor
             found = true if /^ISO DATE:/.match n.text
           end
           found or
-            warn "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
 

data/lib/asciidoctor/iso/validate_section.rb

@@ -17,29 +17,29 @@ module Asciidoctor
       def foreword_validate(root)
         f = root.at("//foreword") || return
         s = f.at("./clause")
-        warn "ISO style: foreword contains subclauses" unless s.nil?
+        @log.add("Style", f, "foreword contains subclauses") unless s.nil?
       end
 
       # ISO/IEC DIR 2, 15.4
       def normref_validate(root)
         f = root.at("//references[title = 'Normative References']") || return
         f.at("./references | ./clause") &&
-          warn("ISO style: normative references contains subclauses")
+          @log.add("Style", f, "normative references contains subclauses")
       end
 
-      ONE_SYMBOLS_WARNING = "ISO style: only one Symbols and Abbreviated "\
+      ONE_SYMBOLS_WARNING = "Only one Symbols and Abbreviated "\
         "Terms section in the standard".freeze
 
-      NON_DL_SYMBOLS_WARNING = "ISO style: Symbols and Abbreviated Terms can "\
+      NON_DL_SYMBOLS_WARNING = "Symbols and Abbreviated Terms can "\
         "only contain a definition list".freeze
 
       def symbols_validate(root)
         f = root.xpath("//definitions")
         f.empty? && return
-        (f.size == 1) || warn(ONE_SYMBOLS_WARNING)
+        (f.size == 1) || @log.add("Style", f.first, ONE_SYMBOLS_WARNING)
         f.first.elements.each do |e|
           unless e.name == "dl"
-            warn(NON_DL_SYMBOLS_WARNING)
+            @log.add("Style", f.first, NON_DL_SYMBOLS_WARNING)
             return
           end
         end
@@ -48,7 +48,7 @@ module Asciidoctor
       def seqcheck(names, msg, accepted)
         n = names.shift
         unless accepted.include? n
-          warn "ISO style: #{msg}"
+          @log.add("Style", nil, msg)
           names = []
         end
         names
@@ -109,46 +109,46 @@ module Asciidoctor
           n = names.shift || return
         end
         unless n
-          warn "ISO style: Document must contain at least one clause"
+          @log.add("Style", nil, "Document must contain at least one clause")
           return
         end
         n[:tag] == "clause" ||
-          warn("ISO style: Document must contain clause after "\
+          @log.add("Style", nil, "Document must contain clause after "\
                "Terms and Definitions")
         n == { tag: "clause", title: "Scope" } &&
-          warn("ISO style: Scope must occur before Terms and Definitions")
+          @log.add("Style", nil, "Scope must occur before Terms and Definitions")
         n = names.shift || return
         while n[:tag] == "clause"
           n[:title] == "Scope" &&
-            warn("ISO style: Scope must occur before Terms and Definitions")
+            @log.add("Style", nil, "Scope must occur before Terms and Definitions")
           n = names.shift || return
         end
         unless n[:tag] == "annex" || n[:tag] == "references"
-          warn "ISO style: Only annexes and references can follow clauses"
+          @log.add("Style", nil, "Only annexes and references can follow clauses")
         end
         while n[:tag] == "annex"
           n = names.shift
           if n.nil?
-            warn("ISO style: Document must include (references) "\
+            @log.add("Style", nil, "Document must include (references) "\
                  "Normative References")
             return
           end
         end
         n == { tag: "references", title: "Normative References" } ||
-          warn("ISO style: Document must include (references) "\
+          @log.add("Style", nil, "Document must include (references) "\
                "Normative References")
         n = names.shift
         n == { tag: "references", title: "Bibliography" } ||
-          warn("ISO style: Final section must be (references) Bibliography")
+          @log.add("Style", nil, "Final section must be (references) Bibliography")
         names.empty? ||
-          warn("ISO style: There are sections after the final Bibliography")
+          @log.add("Style", nil, "There are sections after the final Bibliography")
       end
 
       def style_warning(node, msg, text = nil)
         return if @novalid
-        w = "ISO style: WARNING (#{Standoc::Utils::current_location(node)}): #{msg}"
+        w = msg
         w += ": #{text}" if text
-        warn w
+        @log.add("Style", node, w)
       end
 
       NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze
@@ -174,7 +174,7 @@ module Asciidoctor
       def norm_bibitem_style(root)
         root.xpath(NORM_BIBITEMS).each do |b|
           if b.at(Standoc::Converter::ISO_PUBLISHER_XPATH).nil?
-            Standoc::Utils::warning(b, NORM_ISO_WARN, b.text)
+            @log.add("Style", b, "#{NORM_ISO_WARN}: #{b.text}")
           end
         end
       end

data/lib/asciidoctor/iso/validate_title.rb

@@ -7,10 +7,10 @@ module Asciidoctor
         title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
         title_intro_fr = root.at("//title[@type='title-intro' and @language='fr']")
         if title_intro_en.nil? && !title_intro_fr.nil?
-          warn "No English Title Intro!"
+          @log.add("Style", title_intro_fr, "No English Title Intro!")
         end
         if !title_intro_en.nil? && title_intro_fr.nil?
-          warn "No French Title Intro!"
+          @log.add("Style", title_intro_en, "No French Title Intro!")
         end
       end
 
@@ -18,10 +18,10 @@ module Asciidoctor
         title_main_en = root.at("//title[@type='title-main' and @language='en']")
         title_main_fr = root.at("//title[@type='title-main' and @language='fr']")
         if title_main_en.nil? && !title_main_fr.nil?
-          warn "No English Title!"
+          @log.add("Style", title_main_fr, "No English Title!")
         end
         if !title_main_en.nil? && title_main_fr.nil?
-          warn "No French Title!"
+          @log.add("Style", title_main_en, "No French Title!")
         end
       end
 
@@ -29,9 +29,9 @@ module Asciidoctor
         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.nil? && !title_part_fr.nil?) &&
-          warn("No English Title Part!")
+          @log.add("Style", title_part_fr, "No English Title Part!")
         (!title_part_en.nil? && title_part_fr.nil?) &&
-          warn("No French Title Part!")
+          @log.add("Style", title_part_en, "No French Title Part!")
       end
 
       # ISO/IEC DIR 2, 11.4
@@ -41,7 +41,7 @@ module Asciidoctor
         iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
                       "organization[abbreviation = 'IEC' or "\
                       "name = 'International Electrotechnical Commission']")
-        warn("Subpart defined on non-IEC document!") if subpart && !iec
+        @log.add("Style", docid, "Subpart defined on non-IEC document!") if subpart && !iec
       end
 
       # ISO/IEC DIR 2, 11.5.2
@@ -50,11 +50,11 @@ module Asciidoctor
         Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
         title_main_en = root.at("//title[@type='title-main' and @language='en']")
         if !title_main_en.nil? && doctypes.match(title_main_en.text)
-          warn "Main Title may name document type"
+          @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']")
         if !title_intro_en.nil? && doctypes.match(title_intro_en.text)
-          warn "Title Intro may name document type"
+          @log.add("Style", title_intro_en, "Title Intro may name document type")
         end
       end
 
@@ -65,7 +65,7 @@ module Asciidoctor
           s.xpath("./clause | ./terms | ./references").each do |ss|
             subtitle = ss.at("./title")
             !subtitle.nil? && !subtitle&.text&.empty? ||
-              warn("#{title}: each first-level subclause must have a title")
+              @log.add("Style", ss, "#{title}: each first-level subclause must have a title")
           end
         end
       end
@@ -82,7 +82,7 @@ module Asciidoctor
           withtitle = withtitle || (subtitle && !subtitle.text.empty?)
         end
         notitle && withtitle &&
-          warn("#{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)