metanorma-iso 2.4.2 → 2.4.4

data/lib/isodoc/iso/presentation_terms.rb

@@ -0,0 +1,102 @@
+require_relative "init"
+require "isodoc"
+require_relative "index"
+require_relative "presentation_xref"
+require_relative "presentation_bibdata"
+require_relative "../../relaton/render/general"
+
+module IsoDoc
+  module Iso
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def concept(docxml)
+        concept_term(docxml)
+        docxml.xpath(ns("//concept")).each do |node|
+          concept_render(node, ital: "false", ref: "false",
+                               linkref: "true", linkmention: "false")
+        end
+      end
+
+      def concept_term(docxml)
+        docxml.xpath(ns("//term")).each do |f|
+          m = {}
+          (f.xpath(ns(".//concept")) - f.xpath(ns(".//term//concept")))
+            .each { |c| concept_term1(c, m) }
+        end
+      end
+
+      def concept_term1(node, seen)
+        term = to_xml(node.at(ns("./refterm")))
+        if term && seen[term]
+          concept_render(node, ital: "false", ref: "false",
+                               linkref: "true", linkmention: "false")
+        else concept_render(node, ital: "true", ref: "true",
+                                  linkref: "true", linkmention: "false")
+        end
+        seen[term] = true if term
+        seen
+      end
+
+      def concept1_ref_content(ref)
+        prev = "("
+        foll = ")"
+        if ref.name == "termref"
+          prev, foll = @i18n.term_defined_in.split("%")
+        end
+        ref.previous = prev
+        ref.next = foll
+      end
+
+      def concept1(node)
+        node.replace(node&.at(ns("./renderterm"))&.children ||
+                     node&.at(ns("./refterm"))&.children ||
+                     node.children)
+      end
+
+      def termdefinition1(elem)
+        prefix_domain_to_definition(elem)
+        super
+      end
+
+      def prefix_domain_to_definition(elem)
+        ((d = elem.at(ns("./domain"))) &&
+          (v = elem.at(ns("./definition/verbal-definition"))) &&
+          v.elements.first.name == "p") or return
+        v.elements.first.children.first.previous =
+          "&#x3c;#{to_xml(d.remove.children)}&#x3e; "
+      end
+
+      def insertall_after_here(node, insert, name)
+        node.children.each do |n|
+          n.name == name or next
+          insert.next = n.remove
+          insert = n
+        end
+        insert
+      end
+
+      def termexamples_before_termnotes(node)
+        insert = node.at(ns("./definition")) or return
+        insert = insertall_after_here(node, insert, "termexample")
+        insertall_after_here(node, insert, "termnote")
+      end
+
+      def terms(docxml)
+        docxml.xpath(ns("//term[termnote][termexample]")).each do |node|
+          termexamples_before_termnotes(node)
+        end
+        super
+      end
+
+      def related1(node)
+        node.remove
+      end
+
+      def termsource_status(status)
+        case status
+        when "modified", "adapted"
+          @i18n.modified
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -3,6 +3,7 @@ require "isodoc"
 require_relative "index"
 require_relative "presentation_xref"
 require_relative "presentation_bibdata"
+require_relative "presentation_terms"
 require_relative "../../relaton/render/general"
 
 module IsoDoc
@@ -86,50 +87,6 @@ module IsoDoc
         end
       end
 
-      def concept(docxml)
-        concept_term(docxml)
-        docxml.xpath(ns("//concept")).each do |node|
-          concept_render(node, ital: "false", ref: "false",
-                               linkref: "true", linkmention: "false")
-        end
-      end
-
-      def concept_term(docxml)
-        docxml.xpath(ns("//term")).each do |f|
-          m = {}
-          (f.xpath(ns(".//concept")) - f.xpath(ns(".//term//concept")))
-            .each { |c| concept_term1(c, m) }
-        end
-      end
-
-      def concept_term1(node, seen)
-        term = to_xml(node.at(ns("./refterm")))
-        if term && seen[term]
-          concept_render(node, ital: "false", ref: "false",
-                               linkref: "true", linkmention: "false")
-        else concept_render(node, ital: "true", ref: "true",
-                                  linkref: "true", linkmention: "false")
-        end
-        seen[term] = true if term
-        seen
-      end
-
-      def concept1_ref_content(ref)
-        prev = "("
-        foll = ")"
-        if ref.name == "termref"
-          prev, foll = @i18n.term_defined_in.split("%")
-        end
-        ref.previous = prev
-        ref.next = foll
-      end
-
-      def concept1(node)
-        node.replace(node&.at(ns("./renderterm"))&.children ||
-                     node&.at(ns("./refterm"))&.children ||
-                     node.children)
-      end
-
       # we're assuming terms and clauses in the right place for display,
       # to cope with multiple terms sections
       def display_order(docxml)
@@ -145,41 +102,6 @@ module IsoDoc
         display_order_xpath(docxml, "//indexsect", i)
       end
 
-      def termdefinition1(elem)
-        prefix_domain_to_definition(elem)
-        super
-      end
-
-      def prefix_domain_to_definition(elem)
-        ((d = elem.at(ns("./domain"))) &&
-          (v = elem.at(ns("./definition/verbal-definition"))) &&
-          v.elements.first.name == "p") or return
-        v.elements.first.children.first.previous =
-          "<#{to_xml(d.remove.children)}> "
-      end
-
-      def insertall_after_here(node, insert, name)
-        node.children.each do |n|
-          n.name == name or next
-          insert.next = n.remove
-          insert = n
-        end
-        insert
-      end
-
-      def termexamples_before_termnotes(node)
-        insert = node.at(ns("./definition")) or return
-        insert = insertall_after_here(node, insert, "termexample")
-        insertall_after_here(node, insert, "termnote")
-      end
-
-      def terms(docxml)
-        docxml.xpath(ns("//term[termnote][termexample]")).each do |node|
-          termexamples_before_termnotes(node)
-        end
-        super
-      end
-
       def admonition1(elem)
         super
         n = elem.at(ns("./name")) or return
@@ -212,10 +134,6 @@ module IsoDoc
         type
       end
 
-      def related1(node)
-        node.remove
-      end
-
       def note1(elem)
         elem["type"] == "units" and return
         super
@@ -237,6 +155,12 @@ module IsoDoc
         dlist.remove
       end
 
+      def toc_title(docxml)
+        doctype = docxml.at(ns("//bibdata/ext/doctype"))&.text
+        %w(amendment technical-corrigendum).include?(doctype) and return
+        super
+      end
+
       include Init
     end
   end

data/lib/isodoc/iso/sections.rb

@@ -35,26 +35,26 @@ module IsoDoc
         amd(isoxml) and @suppressheadingnumbers = true
       end
 
-      def introduction(isoxml, out)
-        f = isoxml.at(ns("//introduction")) || return
+=begin
+      def introduction(clause, out)
         title_attr = { class: "IntroTitle" }
         page_break(out)
-        out.div class: "Section3", id: f["id"] do |div|
-          clause_name(f, f.at(ns("./title")), div, title_attr)
-          f.elements.each do |e|
+        out.div class: "Section3", id: clause["id"] do |div|
+          clause_name(clause, clause.at(ns("./title")), div, title_attr)
+          clause.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
         end
       end
+=end
 
-      def foreword(isoxml, out)
-        f = isoxml.at(ns("//foreword")) or return
+      def foreword(clause, out)
         @foreword = true
         page_break(out)
-        out.div **attr_code(id: f["id"]) do |s|
-          clause_name(nil, f.at(ns("./title")) || @i18n.foreword, s,
+        out.div **attr_code(id: clause["id"]) do |s|
+          clause_name(nil, clause.at(ns("./title")) || @i18n.foreword, s,
                       { class: "ForewordTitle" })
-          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+          clause.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
         @foreword = false
       end

data/lib/isodoc/iso/word_cleanup.rb

@@ -142,6 +142,9 @@ module IsoDoc
       # supply missing annex title
       def make_WordToC(docxml, level)
         toc = ""
+        if source = docxml.at("//div[@class = 'TOC']")
+          toc = to_xml(source.children)
+        end
         xpath = (1..level).each.map { |i| "//h#{i}" }.join (" | ")
         docxml.xpath(xpath).each do |h|
           x = ""

data/lib/metanorma/iso/base.rb

@@ -54,6 +54,7 @@ module Metanorma
         super
         @amd = %w(amendment technical-corrigendum).include? doctype(node)
         @vocab = node.attr("docsubtype") == "vocabulary"
+        @validate_years = node.attr("validate-years")
       end
 
       def toc_default

data/lib/metanorma/iso/isodoc.rng

@@ -17,6 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
+<!-- VERSION v1.2.2 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -210,6 +211,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="style"/>
+      </optional>
       <ref name="CitationType"/>
       <oneOrMore>
         <ref name="PureTextElement"/>
@@ -1349,15 +1353,19 @@
       </choice>
     </element>
   </define>
+  <define name="Root-Attributes">
+    <attribute name="version"/>
+    <attribute name="schema-version"/>
+    <attribute name="type">
+      <choice>
+        <value>semantic</value>
+        <value>presentation</value>
+      </choice>
+    </attribute>
+  </define>
   <define name="standard-document">
     <element name="standard-document">
-      <attribute name="version"/>
-      <attribute name="type">
-        <choice>
-          <value>semantic</value>
-          <value>presentation</value>
-        </choice>
-      </attribute>
+      <ref name="Root-Attributes"/>
       <ref name="bibdata"/>
       <optional>
         <ref name="misccontainer"/>
@@ -2131,6 +2139,7 @@
     <choice>
       <value>identical</value>
       <value>modified</value>
+      <value>adapted</value>
       <value>restyled</value>
       <value>context-added</value>
       <value>generalisation</value>

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

@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar ns="https://www.metanorma.org/ns/iso" xmlns="http://relaxng.org/ns/structure/1.0">
-  <!-- default namespace isostandard = "https://www.metanorma.com/ns/iso" -->
+  <!--
+    VERSION v1.2.1
+    default namespace isostandard = "https://www.metanorma.com/ns/iso"
+  -->
   <include href="relaton-iso.rng"/>
   <include href="isostandard.rng">
     <start>
@@ -32,13 +35,7 @@
     </define>
     <define name="iso-standard">
       <element name="iso-standard">
-        <attribute name="version"/>
-        <attribute name="type">
-          <choice>
-            <value>semantic</value>
-            <value>presentation</value>
-          </choice>
-        </attribute>
+        <ref name="Root-Attributes"/>
         <ref name="bibdata"/>
         <optional>
           <ref name="misccontainer"/>

data/lib/metanorma/iso/isostandard.rng

@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar 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" -->
+  <!--
+    VERSION v1.2.1
+    default namespace isostandard = "https://www.metanorma.com/ns/iso"
+  -->
   <include href="isodoc.rng">
     <start>
       <ref name="iso-standard"/>
@@ -240,13 +243,7 @@
   -->
   <define name="iso-standard">
     <element name="iso-standard">
-      <attribute name="version"/>
-      <attribute name="type">
-        <choice>
-          <value>semantic</value>
-          <value>presentation</value>
-        </choice>
-      </attribute>
+      <ref name="Root-Attributes"/>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/metanorma/iso/validate.rb

@@ -30,6 +30,7 @@ module Metanorma
       # ISO/IEC DIR 2, 15.5.3, 20.2
       # does not deal with preceding text marked up
       def see_xrefs_validate(root)
+        @lang == "en" or return
         root.xpath("//xref").each do |t|
           preceding = t.at("./preceding-sibling::text()[last()]")
           next unless !preceding.nil? &&
@@ -45,6 +46,7 @@ module Metanorma
 
       # ISO/IEC DIR 2, 15.5.3
       def see_erefs_validate(root)
+        @lang == "en" or return
         root.xpath("//eref").each do |t|
           prec = t.at("./preceding-sibling::text()[last()]")
           next unless !prec.nil? && /\b(see|refer to)\s*\Z/mi.match(prec)

data/lib/metanorma/iso/validate_image.rb

@@ -3,8 +3,9 @@ module Metanorma
     class Converter < Standoc::Converter
       # DRG directives 3.7; but anticipated by standoc
       def subfigure_validate(xmldoc)
+        elems = { footnote: "fn", note: "note", key: "dl" }
         xmldoc.xpath("//figure//figure").each do |f|
-          { footnote: "fn", note: "note", key: "dl" }.each do |k, v|
+          elems.each do |k, v|
             f.xpath(".//#{v}").each do |n|
               @log.add("Style", n, "#{k} is not permitted in a subfigure")
             end
@@ -13,10 +14,10 @@ module Metanorma
       end
 
       def image_name_prefix(xmldoc)
-        std = xmldoc&.at("//bibdata/ext/structuredidentifier/project-number") or
+        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"
+        num = xmldoc.at("//bibdata/docnumber")&.text or return
+        ed = xmldoc.at("//bibdata/edition")&.text || "1"
         prefix = num
         std["part"] and prefix += "-#{std['part']}"
         prefix += "_ed#{ed}"
@@ -25,7 +26,7 @@ module Metanorma
       end
 
       def image_name_suffix(xmldoc)
-        case xmldoc&.at("//bibdata/language")&.text
+        case xmldoc.at("//bibdata/language")&.text
         when "fr" then "_f"
         when "de" then "_d"
         when "ru" then "_r"

data/lib/metanorma/iso/validate_list.rb

@@ -60,7 +60,7 @@ module Metanorma
         case prectext.strip[-1]
         when ":", "" then list_after_colon_punctuation(list, entries)
         when "." then entries.each { |li| list_full_sentence(li) }
-        else style_warning(list, "All lists must be preceded by "\
+        else style_warning(list, "All lists must be preceded by " \
                                  "colon or full stop", prectext)
         end
       end
@@ -80,7 +80,7 @@ module Metanorma
       def list_semicolon_phrase(elem, last)
         text = elem.text.strip
         starts_lowercase?(text) or
-          style_warning(elem, "List entry of broken up sentence must start "\
+          style_warning(elem, "List entry of broken up sentence must start " \
                               "with lowercase letter", text)
         list_semicolon_phrase_punct(elem, text, last)
       end
@@ -89,11 +89,11 @@ module Metanorma
         punct = text.strip.sub(/^.*?(\S)$/m, "\\1")
         if last
           punct == "." or
-            style_warning(elem, "Final list entry of broken up "\
+            style_warning(elem, "Final list entry of broken up " \
                                 "sentence must end with full stop", text)
         else
           punct == ";" or
-            style_warning(elem, "List entry of broken up sentence must "\
+            style_warning(elem, "List entry of broken up sentence must " \
                                 "end with semicolon", text)
         end
       end
@@ -102,11 +102,11 @@ module Metanorma
         %w(Cyrl Latn Grek).include?(@script) or return
         text = elem.text.strip
         starts_uppercase?(text) or
-          style_warning(elem, "List entry of separate sentences must start "\
+          style_warning(elem, "List entry of separate sentences must start " \
                               "with uppercase letter", text)
         punct = text.strip.sub(/^.*?(\S)$/m, "\\1")
         punct == "." or
-          style_warning(elem, "List entry of separate sentences must "\
+          style_warning(elem, "List entry of separate sentences must " \
                               "end with full stop", text)
       end
 

data/lib/metanorma/iso/validate_requirements.rb

@@ -24,6 +24,7 @@ module Metanorma
       end
 
       def requirement_check(text)
+        @lang == "en" or return
         text.split(/\.\s+/).each do |t|
           return t if requirement_re.match t
         end
@@ -44,6 +45,7 @@ module Metanorma
       end
 
       def recommendation_check(text)
+        @lang == "en" or return
         text.split(/\.\s+/).each do |t|
           return t if recommendation_re.match t
         end
@@ -60,6 +62,7 @@ module Metanorma
       REGEXP
 
       def permission_re
+        @lang == "en" or return
         Regexp.new(self.class::PERMISSION_RE_STR.gsub(/\s/, "")
           .gsub(/_/, "\\s"), Regexp::IGNORECASE)
       end
@@ -82,6 +85,7 @@ module Metanorma
       REGEXP
 
       def possibility_re
+        @lang == "en" or return
         Regexp.new(self.class::POSSIBILITY_RE_STR.gsub(/\s/, "")
           .gsub(/_/, "\\s"), Regexp::IGNORECASE)
       end
@@ -98,6 +102,26 @@ module Metanorma
         nil
       end
 
+      AMBIG_WORDS_RE_STR = <<~REGEXP.freeze
+        \\b
+            need_to | needs_to | might | could
+        \\b
+      REGEXP
+
+      def ambig_words_re
+        @lang == "en" or return
+        Regexp.new(self.class::AMBIG_WORDS_RE_STR.gsub(/\s/, "")
+          .gsub(/_/, "\\s"), Regexp::IGNORECASE)
+      end
+
+      def ambig_words_check(text)
+        @lang == "en" or return
+        text.split(/\.\s+/).each do |t|
+          return t if ambig_words_re.match t
+        end
+        nil
+      end
+
       def style_no_guidance(node, text, docpart)
         @lang == "en" or return
         r = requirement_check(text)

data/lib/metanorma/iso/validate_style.rb

@@ -90,32 +90,63 @@ module Metanorma
       end
 
       def style(node, text)
-        return if @novalid
-
+        @novalid and return
         style_number(node, text)
         style_percent(node, text)
         style_abbrev(node, text)
         style_units(node, text)
         style_punct(node, text)
+        style_subscript(node)
+        style_ambig_words(node, text)
+      end
+
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-quantity
+      def style_subscript(node)
+        warning = "may contain nested subscripts (max 3 levels allowed)"
+        node.xpath(".//sub[.//sub]").each do |x|
+          style_warning(node, warning, x.to_xml)
+        end
+        node.xpath(".//m:msub[.//m:msub]", "m" => MATHML_NS).each do |x|
+          style_warning(node, warning, x.to_xml)
+        end
+      end
+
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-need
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-s-might
+      def style_ambig_words(node, text)
+        r = ambig_words_check(text) and
+          style_warning(node, "may contain ambiguous provision", r)
       end
 
       # ISO/IEC DIR 2, 9.1
       # ISO/IEC DIR 2, Table B.1
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-n-numbers
       def style_number(node, text)
-        style_two_regex_not_prev(
-          node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)\Z/,
-          %r{\b(ISO|IEC|IEEE/|(in|January|February|March|April|May|June|August|September|October|November|December)\b)\Z},
-          "number not broken up in threes"
-        )
+        style_number_grouping(node, text)
         style_regex(/\b(?<num>[0-9]+\.[0-9]+)/i,
                     "possible decimal point", node, text)
         @lang == "en" and style_regex(/\b(?<num>billions?)\b/i,
                                       "ambiguous number", node, text)
-        style_regex(/(^|\s)(?<num>-[0-9][0-9,.]*)/i,
+        style_regex(/(?:^|\s)(?<num>-[0-9][0-9,.]*)/i,
                     "hyphen instead of minus sign U+2212", node, text)
       end
 
+      def style_number_grouping(node, text)
+        if @validate_years
+          style_two_regex_not_prev(
+            node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)\Z/,
+            %r{\b(ISO|IEC|IEEE|(in|January|February|March|April|May|June|August|September|October|November|December)\b)\Z},
+            "number not broken up in threes"
+          )
+        else
+          style_two_regex_not_prev(
+            node, text, /^(?<num>-?(?:[0-9]{5,}[,0-9]*|[03-9]\d\d\d|1[0-8]\d\d|2[1-9]\d\d|20[5-9]\d))\Z/,
+            %r{\b(ISO|IEC|IEEE|\b)\Z},
+            "number not broken up in threes"
+          )
+        end
+      end
+
       # ISO/IEC DIR 2, 9.2.1
       def style_percent(node, text)
         style_regex(/\b(?<num>[0-9.,]+%)/,
@@ -169,6 +200,16 @@ module Metanorma
                                       "Use 'either x or y, or both'", node, text)
         style_regex(/\s(?<num>&)\s/i,
                     "Avoid ampersand in ordinary text'", node, text)
+        eref_style_punct(node)
+      end
+
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-r-ref_unnumbered
+      def eref_style_punct(node)
+        node.xpath(".//eref[@type='footnote']").each do |e|
+          /^\p{P}/.match?(e.next&.text) or next
+          style_warning(node, "superscript cross-reference followed by punctuation",
+                        node.to_xml)
+        end
       end
 
       def style_warning(node, msg, text = nil)

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "2.4.2".freeze
+    VERSION = "2.4.4".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 2.4.2"
+  spec.add_dependency "metanorma-standoc", "~> 2.4.3"
   spec.add_dependency "mnconvert", "~> 1.14"
   spec.add_dependency "pubid-iso", "~> 0.5.0"
   spec.add_dependency "ruby-jing"