metanorma-iso 1.7.1 → 1.8.1

data/lib/asciidoctor/iso/isodoc.rng

@@ -86,6 +86,35 @@
         <text/>
       </element>
     </define>
+    <define name="erefType">
+      <optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="citeas"/>
+      <attribute name="type">
+        <ref name="ReferenceFormat"/>
+      </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
+      <optional>
+        <attribute name="case">
+          <choice>
+            <value>capital</value>
+            <value>lowercase</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="droploc">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="CitationType"/>
+      <text/>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -102,7 +131,7 @@
           </attribute>
         </optional>
         <oneOrMore>
-          <ref name="li"/>
+          <ref name="ul_li"/>
         </oneOrMore>
         <zeroOrMore>
           <ref name="note"/>
@@ -775,6 +804,78 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="em">
+      <element name="em">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strong">
+      <element name="strong">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="tt">
+      <element name="tt">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="keyword">
+      <element name="keyword">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strike">
+      <element name="strike">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="underline">
+      <element name="underline">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="smallcap">
+      <element name="smallcap">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="colgroup">
@@ -793,7 +894,35 @@
     <value>internal</value>
   </define>
   <define name="TextElement" combine="choice">
-    <ref name="concept"/>
+    <choice>
+      <ref name="concept"/>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
   </define>
   <define name="concept">
     <element name="concept">
@@ -919,6 +1048,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -929,11 +1061,21 @@
       <zeroOrMore>
         <ref name="annex"/>
       </zeroOrMore>
+      <optional>
+        <ref name="bibliography"/>
+      </optional>
       <zeroOrMore>
-        <ref name="references"/>
+        <ref name="indexsect"/>
       </zeroOrMore>
     </element>
   </define>
+  <define name="misccontainer">
+    <element name="misc-container">
+      <oneOrMore>
+        <ref name="AnyElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>
@@ -957,6 +1099,11 @@
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="indexsect">
+    <element name="indexsect">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="boilerplate">
     <element name="boilerplate">
       <optional>
@@ -1698,4 +1845,26 @@
       </zeroOrMore>
     </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="BasicBlock"/>
+      </oneOrMore>
+    </element>
+  </define>
 </grammar>

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

@@ -39,6 +39,9 @@
           </choice>
         </attribute>
         <ref name="bibdata"/>
+        <optional>
+          <ref name="misccontainer"/>
+        </optional>
         <optional>
           <ref name="boilerplate"/>
         </optional>

data/lib/asciidoctor/iso/isostandard.rng

@@ -79,19 +79,6 @@
         </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">
         <zeroOrMore>
@@ -192,17 +179,6 @@
         </zeroOrMore>
       </element>
     </define>
-    <define name="definition">
-      <element name="definition">
-        <oneOrMore>
-          <choice>
-            <ref name="paragraph"/>
-            <ref name="figure"/>
-            <ref name="formula"/>
-          </choice>
-        </oneOrMore>
-      </element>
-    </define>
     <define name="annex">
       <element name="annex">
         <optional>
@@ -333,6 +309,11 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -341,6 +322,12 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
@@ -358,57 +345,6 @@
         </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="number"/>
-        </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="colgroup"/>
-        </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 -->
   <!--
@@ -428,6 +364,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -439,6 +378,9 @@
         <ref name="annex"/>
       </zeroOrMore>
       <ref name="bibliography"/>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
   <define name="horizontal">
@@ -527,28 +469,6 @@
       <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="BasicBlock"/>
-      </oneOrMore>
-    </element>
-  </define>
   <define name="stagename">
     <element name="stagename">
       <text/>

data/lib/asciidoctor/iso/validate.rb

@@ -1,8 +1,9 @@
 require "metanorma-standoc"
-require_relative "./validate_style.rb"
-require_relative "./validate_requirements.rb"
-require_relative "./validate_section.rb"
-require_relative "./validate_title.rb"
+require_relative "./validate_style"
+require_relative "./validate_requirements"
+require_relative "./validate_section"
+require_relative "./validate_title"
+require_relative "./validate_image"
 require "nokogiri"
 require "jing"
 require "iev"
@@ -10,17 +11,6 @@ require "iev"
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-      # ISO/IEC DIR 2, 22.3.2
-      def onlychild_clause_validate(root)
-        root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
-          next unless c.xpath("../clause").size == 1
-          title = c.at("./title")
-          location = c["id"] || c.text[0..60] + "..."
-          location += ":#{title.text}" if c["id"] && !title.nil?
-          @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
@@ -37,12 +27,13 @@ module Asciidoctor
       end
 
       # ISO/IEC DIR 2, 15.5.3
+      # does not deal with preceding text marked up
       def see_xrefs_validate(root)
         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)
+
           (target = root.at("//*[@id = '#{t['target']}']")) || next
           if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
             @log.add("Style", t,
@@ -54,36 +45,34 @@ module Asciidoctor
       # ISO/IEC DIR 2, 15.5.3
       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)
+          prec = t.at("./preceding-sibling::text()[last()]")
+          next unless !prec.nil? && /\b(see|refer to)\s*$/mi.match(prec)
+
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
             @log.add("Bibliography", t,
                      "'#{t} is not pointing to a real reference")
             next
           end
-          if target.at("./ancestor::references[@normative = 'true']")
+          target.at("./ancestor::references[@normative = 'true']") and
             @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[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")
-            end
+          if /^(ISO|IEC)/.match?(t["citeas"]) &&
+              !(/: ?(\d+{4}|–)$/.match?(t["citeas"]))
+            @log.add("Style", t,
+                     "undated reference #{t['citeas']} should not contain "\
+                     "specific elements")
           end
         end
       end
 
-      def termdef_warn(text, re, t, term, msg)
-        re.match(text) && @log.add("Style", t, "#{term}: #{msg}")
+      def termdef_warn(text, regex, elem, term, msg)
+        regex.match(text) && @log.add("Style", elem, "#{term}: #{msg}")
       end
 
       # ISO/IEC DIR 2, 16.5.6
@@ -103,6 +92,7 @@ module Asciidoctor
       def cited_term_style(xmldoc)
         xmldoc.xpath("//term//xref").each do |x|
           next unless xmldoc.at("//term[@id = '#{x['target']}']")
+
           x&.previous&.text == " (" and x&.previous&.previous&.name == "em" or
             style_warning(x, "term citation not preceded with italicised term",
                           x.parent.text)
@@ -111,8 +101,8 @@ module Asciidoctor
 
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
-        %w(international-standard technical-specification technical-report 
-        publicly-available-specification international-workshop-agreement 
+        %w(international-standard technical-specification technical-report
+        publicly-available-specification international-workshop-agreement
         guide amendment technical-corrigendum).include? doctype or
         @log.add("Document Attributes", nil,
                  "#{doctype} is not a recognised document type")
@@ -146,83 +136,6 @@ module Asciidoctor
                    "#{iteration} is not a recognised iteration")
       end
 
-      # DRG directives 3.7; but anticipated by standoc
-      def subfigure_validate(xmldoc)
-        xmldoc.xpath("//figure//figure").each do |f|
-          { footnote: "fn", note: "note", key: "dl" }.each do |k, v|
-            f.xpath(".//#{v}").each do |n|
-              @log.add("Style", n, "#{k} is not permitted in a subfigure")
-            end
-          end
-        end
-      end
-
-      def image_name_prefix(xmldoc)
-        std = xmldoc&.at("//bibdata/ext/structuredidentifier/project-number") or return
-        num = xmldoc&.at("//bibdata/docnumber")&.text or return
-        ed = xmldoc&.at("//bibdata/edition")&.text || "1"
-        prefix = num
-        part = std["part"] and prefix += "-#{std['part']}"
-        prefix += "_ed#{ed}"
-        amd = std["amendment"] and prefix += "amd#{amd}"
-        prefix
-      end
-
-      def image_name_suffix(xmldoc)
-        case xmldoc&.at("//bibdata/language")&.text
-        when "fr" then "_f"
-        when "de" then "_d"
-        when "ru" then "_r"
-        when "es" then "_s"
-        when "ar" then "_a"
-        when "en" then "_e"
-        else
-          "_e"
-        end
-      end
-
-      def disjunct_error(i, cond1, cond2, msg1, msg2)
-        cond1 && !cond2 and @log.add("Style", i, "image name #{i['src']} #{msg1}")
-        !cond1 && cond2 and @log.add("Style", i, "image name #{i['src']} #{msg2}")
-      end
-
-      def image_name_validate1(i, prefix)
-        m = %r[(SL)?#{prefix}fig(?<tab>Tab)?(?<annex>[A-Z])?(Text)?(?<num>\d+)
-            (?<subfig>[a-z])?(?<key>_key\d+)?(?<lang>_[a-z])?$]x.match(File.basename(i["src"], ".*"))
-        if m.nil?
-          @log.add("Style", i, "image name #{i['src']} does not match DRG requirements")
-          return
-        end
-        warn i['src']
-        disjunct_error(i, i.at("./ancestor::table"), !m[:tab].nil?,
-                       "is under a table but is not so labelled", "is labelled as under a table but is not")
-        disjunct_error(i, i.at("./ancestor::annex"), !m[:annex].nil?,
-                       "is under an annex but is not so labelled", "is labelled as under an annex but is not")
-        disjunct_error(i, i.xpath("./ancestor::figure").size > 1, !m[:subfig].nil?,
-                       "does not have a subfigure letter but is a subfigure",
-                       "has a subfigure letter but is not a subfigure")
-        lang = image_name_suffix(i.document.root)
-        (m[:lang] || "_e") == lang or @log.add("Style", i, "image name #{i['src']} expected to have suffix #{lang}")
-      end
-
-      # DRG directives 3.2
-      def image_name_validate(xmldoc)
-        prefix = image_name_prefix(xmldoc) or return
-        xmldoc.xpath("//image").each do |i|
-          if /^ISO_\d+_/.match(File.basename(i["src"]))
-          elsif /^(SL)?#{prefix}fig/.match(File.basename(i["src"]))
-            image_name_validate1(i, prefix)
-          else
-            @log.add("Style", i, "image name #{i['src']} does not match DRG requirements: expect #{prefix}fig")
-          end
-        end
-      end
-
-      def figure_validate(xmldoc)
-        image_name_validate(xmldoc)
-        subfigure_validate(xmldoc)
-      end
-
       def bibdata_validate(doc)
         doctype_validate(doc)
         script_validate(doc)
@@ -250,7 +163,7 @@ module Asciidoctor
         xmldoc.xpath("//bibitem[date/on = '–']").each do |b|
           b.at("./note[@type = 'Unpublished-Status']") or
             @log.add("Style", b,
-                     "Reference #{b&.at("./@id")&.text} does not have an "\
+                     "Reference #{b&.at('./@id')&.text} does not have an "\
                      "associated footnote indicating unpublished status")
         end
       end