metanorma-iso 1.7.4 → 1.8.4

data/lib/asciidoctor/iso/isodoc.rng

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -86,6 +91,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">
@@ -514,6 +548,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -775,8 +812,100 @@
         <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>
+    <define name="pagebreak">
+      <element name="pagebreak">
+        <optional>
+          <attribute name="orientation">
+            <choice>
+              <value>landscape</value>
+              <value>portrait</value>
+            </choice>
+          </attribute>
+        </optional>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="docsubtype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -793,7 +922,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">
@@ -814,8 +971,170 @@
       <ref name="permission"/>
       <ref name="imagemap"/>
       <ref name="svgmap"/>
+      <ref name="inputform"/>
+    </choice>
+  </define>
+  <define name="inputform">
+    <element name="form">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="name"/>
+      <attribute name="action"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="TextElement"/>
+          <ref name="FormInput"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="FormInput">
+    <choice>
+      <ref name="input"/>
+      <ref name="formlabel"/>
+      <ref name="select"/>
+      <ref name="textarea"/>
+    </choice>
+  </define>
+  <define name="InputType">
+    <choice>
+      <value>button</value>
+      <value>checkbox</value>
+      <value>date</value>
+      <value>file</value>
+      <value>password</value>
+      <value>radio</value>
+      <value>submit</value>
+      <value>text</value>
     </choice>
   </define>
+  <define name="input">
+    <element name="input">
+      <attribute name="type">
+        <ref name="InputType"/>
+      </attribute>
+      <optional>
+        <attribute name="checked">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="readonly">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="maxlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="minlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
+  <define name="formlabel">
+    <element name="label">
+      <attribute name="for">
+        <data type="IDREF"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="select">
+    <element name="select">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="multiple">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="size">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="option"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="option">
+    <element name="option">
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="textarea">
+    <element name="textarea">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="rows">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="cols">
+          <data type="int"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
   <define name="bibliography">
     <element name="bibliography">
       <oneOrMore>
@@ -888,9 +1207,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>

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

@@ -83,6 +83,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <ref name="editorialgroup"/>
       <zeroOrMore>
         <ref name="ics"/>

data/lib/asciidoctor/iso/isostandard.rng

@@ -38,6 +38,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="horizontal"/>
       </optional>
@@ -256,6 +259,15 @@
         <value>guide</value>
         <value>amendment</value>
         <value>technical-corrigendum</value>
+        <value>directive</value>
+      </choice>
+    </define>
+    <define name="DocumentSubtype">
+      <choice>
+        <value>specification</value>
+        <value>method-of-test</value>
+        <value>vocabulary</value>
+        <value>code-of-practice</value>
       </choice>
     </define>
     <define name="structuredidentifier">

data/lib/asciidoctor/iso/section.rb

@@ -10,7 +10,7 @@ module Asciidoctor
       end
 
       def scope_parse(attrs, xml, node)
-        attrs = attrs.merge(type: "scope") unless @amd 
+        attrs = attrs.merge(type: "scope") unless @amd
         clause_parse(attrs, xml, node)
       end
 
@@ -32,6 +32,7 @@ module Asciidoctor
 
       def sectiontype(node, level = true)
         return nil if @amd
+
         super
       end
     end

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,84 +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|
-          next if i["src"].start_with?("data:")
-          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)
@@ -251,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