metanorma-iso 1.10.5 → 2.0.2

data/lib/asciidoctor/iso/validate_section.rb

@@ -1,247 +1,3 @@
-require "nokogiri"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/validate_section"
 
-module Asciidoctor
-  module ISO
-    class Converter < Standoc::Converter
-      def section_validate(doc)
-        doctype = doc&.at("//bibdata/ext/doctype")&.text
-        unless %w(amendment technical-corrigendum).include? doctype
-          foreword_validate(doc.root)
-          normref_validate(doc.root)
-          symbols_validate(doc.root)
-          sections_presence_validate(doc.root)
-          sections_sequence_validate(doc.root)
-        end
-        section_style(doc.root)
-        subclause_validate(doc.root)
-        super
-      end
-
-      # ISO/IEC DIR 2, 12.4
-      def foreword_validate(root)
-        f = root.at("//foreword") || return
-        s = f.at("./clause")
-        @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[@normative = 'true']") || return
-        f.at("./references | ./clause") &&
-          @log.add("Style", f, "normative references contains subclauses")
-      end
-
-      ONE_SYMBOLS_WARNING = "Only one Symbols and Abbreviated "\
-                            "Terms section in the standard".freeze
-
-      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) || @log.add("Style", f.first, ONE_SYMBOLS_WARNING)
-        f.first.elements.each do |e|
-          unless %w(title dl).include? e.name
-            @log.add("Style", f.first, NON_DL_SYMBOLS_WARNING)
-            return
-          end
-        end
-      end
-
-      def seqcheck(names, msg, accepted)
-        n = names.shift
-        return [] if n.nil?
-
-        test = accepted.map { |a| n.at(a) }
-        if test.all?(&:nil?)
-          @log.add("Style", nil, msg)
-        end
-        names
-      end
-
-      def sections_presence_validate(root)
-        root.at("//sections/clause[@type = 'scope']") or
-          @log.add("Style", nil, "Scope clause missing")
-        root.at("//references[@normative = 'true']") or
-          @log.add("Style", nil, "Normative references missing")
-        root.at("//terms") or
-          @log.add("Style", nil, "Terms & definitions missing")
-      end
-
-      # spec of permissible section sequence
-      # we skip normative references, it goes to end of list
-      SEQ =
-        [
-          {
-            msg: "Initial section must be (content) Foreword",
-            val: ["./self::foreword"],
-          },
-          {
-            msg: "Prefatory material must be followed by (clause) Scope",
-            val: ["./self::introduction", "./self::clause[@type = 'scope']"],
-          },
-          {
-            msg: "Prefatory material must be followed by (clause) Scope",
-            val: ["./self::clause[@type = 'scope']"],
-          },
-          {
-            msg: "Normative References must be followed by "\
-                 "Terms and Definitions",
-            val: ["./self::terms | .//terms"],
-          },
-        ].freeze
-
-      SECTIONS_XPATH =
-        "//foreword | //introduction | //sections/terms | .//annex | "\
-        "//sections/definitions | //sections/clause | "\
-        "//references[not(parent::clause)] | "\
-        "//clause[descendant::references][not(parent::clause)]".freeze
-
-      def sections_sequence_validate(root)
-        names, n = sections_sequence_validate_start(root)
-        if root&.at("//bibdata/ext/subdoctype")&.text == "vocabulary"
-          names, n = sections_sequence_validate_body_vocab(names, n)
-        else
-          names, n = sections_sequence_validate_body(names, n)
-        end
-        sections_sequence_validate_end(names, n)
-      end
-
-      def sections_sequence_validate_start(root)
-        names = root.xpath(SECTIONS_XPATH)
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
-        n = names[0]
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
-        n&.at("./self::introduction") and
-          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val])
-        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val])
-        n = names.shift
-        n = names.shift if n&.at("./self::definitions")
-        [names, n]
-      end
-
-      def sections_sequence_validate_body(names, elem)
-        if elem.nil? || elem.name != "clause"
-          @log.add("Style", elem, "Document must contain at least one clause")
-        end
-        elem&.at("./self::clause") ||
-          @log.add("Style", elem, "Document must contain clause after "\
-                                  "Terms and Definitions")
-        elem&.at("./self::clause[@type = 'scope']") &&
-          @log.add("Style", elem,
-                   "Scope must occur before Terms and Definitions")
-        elem = names.shift
-        while elem&.name == "clause"
-          elem&.at("./self::clause[@type = 'scope']")
-          @log.add("Style", elem,
-                   "Scope must occur before Terms and Definitions")
-          elem = names.shift
-        end
-        %w(annex references).include? elem&.name or
-          @log.add("Style", elem,
-                   "Only annexes and references can follow clauses")
-        [names, elem]
-      end
-
-      def sections_sequence_validate_body_vocab(names, elem)
-        while elem && %w(clause terms).include?(elem.name)
-          elem = names.shift
-        end
-        %w(annex references).include? elem&.name or
-          @log.add("Style", elem,
-                   "Only annexes and references can follow terms and clauses")
-        [names, elem]
-      end
-
-      def sections_sequence_validate_end(names, elem)
-        while elem&.name == "annex"
-          elem = names.shift
-          if elem.nil?
-            @log.add("Style", nil, "Document must include (references) "\
-                                   "Normative References")
-          end
-        end
-        elem&.at("./self::references[@normative = 'true']") ||
-          @log.add("Style", nil, "Document must include (references) "\
-                                 "Normative References")
-        elem = names&.shift
-        elem&.at("./self::references[@normative = 'false']") ||
-          @log.add("Style", elem,
-                   "Final section must be (references) Bibliography")
-        names.empty? ||
-          @log.add("Style", elem,
-                   "There are sections after the final Bibliography")
-      end
-
-      NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze
-      SCOPE_WARN = "Scope contains subclauses: should be succinct".freeze
-
-      def section_style(root)
-        foreword_style(root.at("//foreword"))
-        introduction_style(root.at("//introduction"))
-        scope_style(root.at("//clause[@type = 'scope']"))
-        scope = root.at("//clause[@type = 'scope']/clause")
-        # ISO/IEC DIR 2, 14.4
-        scope.nil? || style_warning(scope, SCOPE_WARN, nil)
-        tech_report_style(root)
-      end
-
-      def tech_report_style(root)
-        root.at("//bibdata/ext/doctype")&.text == "technical-report" or return
-        root.xpath("//sections/clause[not(@type = 'scope')] | //annex")
-          .each do |s|
-          r = requirement_check(extract_text(s)) and
-            style_warning(s,
-                          "Technical Report clause may contain requirement", r)
-        end
-      end
-
-      ASSETS_TO_STYLE =
-        "//termsource | //formula | //termnote | "\
-        "//p[not(ancestor::boilerplate)] | //li[not(p)] | //dt | "\
-        "//dd[not(p)] | //td[not(p)] | //th[not(p)]".freeze
-
-      NORM_BIBITEMS =
-        "//references[@normative = 'true']/bibitem".freeze
-
-      # ISO/IEC DIR 2, 10.2
-      def norm_bibitem_style(root)
-        root.xpath(NORM_BIBITEMS).each do |b|
-          if b.at(Standoc::Converter::ISO_PUBLISHER_XPATH).nil?
-            @log.add("Style", b, "#{NORM_ISO_WARN}: #{b.text}")
-          end
-        end
-      end
-
-      def asset_style(root)
-        root.xpath("//example | //termexample").each { |e| example_style(e) }
-        root.xpath("//definition/verbal-definition").each { |e| definition_style(e) }
-        root.xpath("//note").each { |e| note_style(e) }
-        root.xpath("//fn").each { |e| footnote_style(e) }
-        root.xpath(ASSETS_TO_STYLE).each { |e| style(e, extract_text(e)) }
-        norm_bibitem_style(root)
-        super
-      end
-
-      def subclause_validate(root)
-        root.xpath("//clause/clause/clause/clause/clause/clause/clause/clause")
-          .each do |c|
-          style_warning(c, "Exceeds the maximum clause depth of 7", nil)
-        end
-      end
-
-      # 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
-    end
-  end
-end

data/lib/asciidoctor/iso/validate_style.rb

@@ -1,170 +1,3 @@
-require "metanorma-standoc"
-require "nokogiri"
-require "tokenizer"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/validate_style"
 
-module Asciidoctor
-  module ISO
-    class Converter < Standoc::Converter
-      def extract_text(node)
-        return "" if node.nil?
-
-        node1 = Nokogiri::XML.fragment(node.to_s)
-        node1.xpath("//link | //locality | //localityStack").each(&:remove)
-        ret = ""
-        node1.traverse { |x| ret += x.text if x.text? }
-        HTMLEntities.new.decode(ret)
-      end
-
-      # ISO/IEC DIR 2, 12.2
-      def foreword_style(node)
-        return if @novalid
-
-        style_no_guidance(node, extract_text(node), "Foreword")
-      end
-
-      # ISO/IEC DIR 2, 14.2
-      def scope_style(node)
-        return if @novalid
-
-        style_no_guidance(node, extract_text(node), "Scope")
-      end
-
-      # ISO/IEC DIR 2, 13.2
-      def introduction_style(node)
-        return if @novalid
-
-        r = requirement_check(extract_text(node))
-        style_warning(node, "Introduction may contain requirement", r) if r
-      end
-
-      # ISO/IEC DIR 2, 16.5.6
-      def definition_style(node)
-        return if @novalid
-
-        r = requirement_check(extract_text(node))
-        style_warning(node, "Definition may contain requirement", r) if r
-      end
-
-      # ISO/IEC DIR 2, 16.5.7
-      # ISO/IEC DIR 2, 25.5
-      def example_style(node)
-        return if @novalid
-
-        style_no_guidance(node, extract_text(node), "Example")
-        style(node, extract_text(node))
-      end
-
-      # ISO/IEC DIR 2, 24.5
-      def note_style(node)
-        return if @novalid
-
-        style_no_guidance(node, extract_text(node), "Note")
-        style(node, extract_text(node))
-      end
-
-      # ISO/IEC DIR 2, 26.5
-      def footnote_style(node)
-        return if @novalid
-
-        style_no_guidance(node, extract_text(node), "Footnote")
-        style(node, extract_text(node))
-      end
-
-      def style_regex(regex, warning, n, text)
-        (m = regex.match(text)) && style_warning(n, warning, m[:num])
-      end
-
-      # style check with a regex on a token
-      # and a negative match on its preceding token
-      def style_two_regex_not_prev(n, text, regex, re_prev, warning)
-        return if text.nil?
-
-        arr = Tokenizer::WhitespaceTokenizer.new.tokenize(text)
-        arr.each_index do |i|
-          m = regex.match arr[i]
-          m_prev = i.zero? ? nil : re_prev.match(arr[i - 1])
-          if !m.nil? && m_prev.nil?
-            style_warning(n, warning, m[:num])
-          end
-        end
-      end
-
-      def style(node, text)
-        return if @novalid
-
-        style_number(node, text)
-        style_percent(node, text)
-        style_abbrev(node, text)
-        style_units(node, text)
-      end
-
-      # ISO/IEC DIR 2, 9.1
-      # ISO/IEC DIR 2, Table B.1
-      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_regex(/\b(?<num>[0-9]+\.[0-9]+)/i,
-                    "possible decimal point", node, text)
-        style_regex(/\b(?<num>billions?)\b/i,
-                    "ambiguous number", node, text)
-      end
-
-      # ISO/IEC DIR 2, 9.2.1
-      def style_percent(node, text)
-        style_regex(/\b(?<num>[0-9.,]+%)/,
-                    "no space before percent sign", node, text)
-        style_regex(/\b(?<num>[0-9.,]+ \u00b1 [0-9,.]+ %)/,
-                    "unbracketed tolerance before percent sign", node, text)
-      end
-
-      # ISO/IEC DIR 2, 8.4
-      # ISO/IEC DIR 2, 9.3
-      def style_abbrev(node, text)
-        style_regex(/(\A|\s)(?!e\.g\.|i\.e\.)
-                    (?<num>[a-z]{1,2}\.([a-z]{1,2}|\.))\b/ix,
-                    "no dots in abbreviations", node, text)
-        style_regex(/\b(?<num>ppm)\b/i,
-                    "language-specific abbreviation", node, text)
-      end
-
-      # leaving out as problematic: N J K C S T H h d B o E
-      SI_UNIT = "(m|cm|mm|km|μm|nm|g|kg|mgmol|cd|rad|sr|Hz|Hz|MHz|Pa|hPa|kJ|"\
-                "V|kV|W|MW|kW|F|μF|Ω|Wb|°C|lm|lx|Bq|Gy|Sv|kat|l|t|eV|u|Np|Bd|"\
-                "bit|kB|MB|Hart|nat|Sh|var)".freeze
-
-      # ISO/IEC DIR 2, 9.3
-      def style_units(node, text)
-        style_regex(/\b(?<num>[0-9][0-9,]*\s+[\u00b0\u2032\u2033])/,
-                    "space between number and degrees/minutes/seconds",
-                    node, text)
-        style_regex(/\b(?<num>[0-9][0-9,]*#{SI_UNIT})\b/o,
-                    "no space between number and SI unit", node, text)
-        style_non_std_units(node, text)
-      end
-
-      NONSTD_UNITS = {
-        sec: "s", mins: "min", hrs: "h", hr: "h", cc: "cm^3",
-        lit: "l", amp: "A", amps: "A", rpm: "r/min"
-      }.freeze
-
-      # ISO/IEC DIR 2, 9.3
-      def style_non_std_units(node, text)
-        NONSTD_UNITS.each do |k, v|
-          style_regex(/\b(?<num>[0-9][0-9,]*\s+#{k})\b/,
-                      "non-standard unit (should be #{v})", node, text)
-        end
-      end
-
-      def style_warning(node, msg, text = nil)
-        return if @novalid
-
-        w = msg
-        w += ": #{text}" if text
-        @log.add("Style", node, w)
-      end
-    end
-  end
-end

data/lib/asciidoctor/iso/validate_title.rb

@@ -1,105 +1,3 @@
-require "metanorma-standoc"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/validate_title"
 
-module Asciidoctor
-  module ISO
-    class Converter < Standoc::Converter
-      def title_lang_part(doc, part, lang)
-        doc.at("//bibdata/title[@type='title-#{part}' and @language='#{lang}']")
-      end
-
-      def title_intro_validate(root)
-        title_intro_en = title_lang_part(root, "intro", "en")
-        title_intro_fr = title_lang_part(root, "intro", "fr")
-        if title_intro_en.nil? && !title_intro_fr.nil?
-          @log.add("Style", title_intro_fr, "No English Title Intro!")
-        end
-        if !title_intro_en.nil? && title_intro_fr.nil?
-          @log.add("Style", title_intro_en, "No French Title Intro!")
-        end
-      end
-
-      def title_main_validate(root)
-        title_main_en = title_lang_part(root, "main", "en")
-        title_main_fr = title_lang_part(root, "main", "fr")
-        if title_main_en.nil? && !title_main_fr.nil?
-          @log.add("Style", title_main_fr, "No English Title!")
-        end
-        if !title_main_en.nil? && title_main_fr.nil?
-          @log.add("Style", title_main_en, "No French Title!")
-        end
-      end
-
-      def title_part_validate(root)
-        title_part_en = title_lang_part(root, "part", "en")
-        title_part_fr = title_lang_part(root, "part", "fr")
-        (title_part_en.nil? && !title_part_fr.nil?) &&
-          @log.add("Style", title_part_fr, "No English Title Part!")
-        (!title_part_en.nil? && title_part_fr.nil?) &&
-          @log.add("Style", title_part_en, "No French Title Part!")
-      end
-
-      # ISO/IEC DIR 2, 11.4
-      def title_subpart_validate(root)
-        docid = root.at("//bibdata/docidentifier[@type = 'ISO']")
-        subpart = /-\d+-\d+/.match docid
-        iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
-                      "organization[abbreviation = 'IEC' or "\
-                      "name = 'International Electrotechnical Commission']")
-        subpart && !iec and
-          @log.add("Style", docid, "Subpart defined on non-IEC document!")
-      end
-
-      # ISO/IEC DIR 2, 11.5.2
-      def title_names_type_validate(root)
-        doctypes = /International\sStandard | Technical\sSpecification |
-        Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
-        title_main_en = title_lang_part(root, "main", "en")
-        !title_main_en.nil? && doctypes.match(title_main_en.text) and
-          @log.add("Style", title_main_en, "Main Title may name document type")
-        title_intro_en = title_lang_part(root, "intro", "en")
-        !title_intro_en.nil? && doctypes.match(title_intro_en.text) and
-          @log.add("Style", title_intro_en,
-                   "Title Intro may name document type")
-      end
-
-      # ISO/IEC DIR 2, 22.2
-      def title_first_level_validate(root)
-        root.xpath(SECTIONS_XPATH).each do |s|
-          title = s&.at("./title")&.text || s.name
-          s.xpath("./clause | ./terms | ./references").each do |ss|
-            subtitle = ss.at("./title")
-            !subtitle.nil? && !subtitle&.text&.empty? or
-              @log.add("Style", ss,
-                       "#{title}: each first-level subclause must have a title")
-          end
-        end
-      end
-
-      # ISO/IEC DIR 2, 22.2
-      def title_all_siblings(xpath, label)
-        notitle = false
-        withtitle = false
-        xpath.each do |s|
-          title_all_siblings(s.xpath("./clause | ./terms | ./references"),
-                             s&.at("./title")&.text || s["id"])
-          subtitle = s.at("./title")
-          notitle = notitle || (!subtitle || subtitle.text.empty?)
-          withtitle = withtitle || (subtitle && !subtitle.text.empty?)
-        end
-        notitle && withtitle &&
-          @log.add("Style", nil,
-                   "#{label}: all subclauses must have a title, or none")
-      end
-
-      def title_validate(root)
-        title_intro_validate(root)
-        title_main_validate(root)
-        title_part_validate(root)
-        title_subpart_validate(root)
-        title_names_type_validate(root)
-        title_first_level_validate(root)
-        title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
-      end
-    end
-  end
-end

data/lib/isodoc/iso/html/style-human.css

@@ -443,44 +443,49 @@ p.Terms {
   margin-top: 0em; }
 
 /* Navigation*/
-#toc {
+#toc, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) {
   font-family: {{bodyfont}};
   font-weight: 400; }
-  #toc ul {
+  #toc ul, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) ul {
     margin: 0;
     padding: 0;
     list-style: none; }
-    #toc ul li a {
+    #toc ul li a, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) ul li a {
       padding: 5px 10px; }
-    #toc ul a {
+    #toc ul a, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) ul a {
       text-decoration: none;
       display: block; }
-      #toc ul a:hover {
+      #toc ul a:hover, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) ul a:hover {
         box-shadow: none;
         color: white; }
-  #toc .h2 {
+  #toc .h2, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) .h2 {
     padding-left: 30px; }
-  #toc .h3 {
+  #toc .h3, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) .h3 {
     padding-left: 50px; }
-  #toc .toc-active, #toc li:hover {
+  #toc .toc-active, #toc li:hover, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) .toc-active, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) li:hover {
     background: #1d1d1d;
     box-shadow: inset -5px 0px 10px -5px #1d1d1d !important; }
-    #toc .toc-active a, #toc li:hover a {
+    #toc .toc-active a, #toc li:hover a, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) .toc-active a, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) li:hover a {
       color: white; }
   @media print {
-    #toc .toc-active, #toc li:hover {
+    #toc .toc-active, #toc li:hover, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) .toc-active, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) li:hover {
       background: white;
       box-shadow: none !important; }
-    #toc li:hover a {
+    #toc li:hover a, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) li:hover a {
       color: black; } }
   @media screen and (max-width: 768px) {
-    #toc {
+    #toc, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) {
       padding: 0 1.5em;
       overflow: visible; } }
-  #toc li:before {
+  #toc li:before, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) li:before {
     content: " ";
     display: none; }
 
+#toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) {
+  margin-top: 0;
+  margin-bottom: 0;
+  font-size: 100%; }
+
 nav {
   line-height: 1.2em; }
   @media screen and (min-width: 768px) {
@@ -534,7 +539,7 @@ nav {
     display: none; }
   h1.toc-contents {
     margin-top: 1em; }
-  ul#toc-list {
+  ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
     padding: 0;
     margin: 0; } }
 

data/lib/isodoc/iso/html/style-human.scss

@@ -259,7 +259,7 @@ p.Terms {
 
 /* Navigation*/
 
-#toc {
+#toc, #toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) {
     @include toc(null, #1d1d1d, white);
     @include sidebarToc();
 
@@ -275,6 +275,12 @@ p.Terms {
     }
 }
 
+#toc > ul :is(.h1, .h2, .h3, .h4, .h5, .h6) {
+   margin-top: 0;
+   margin-bottom: 0;
+   font-size: 100%;
+}
+
 nav {
     @include sidebarNav(#f7f7f7, 278px, 20px);
     line-height: 1.2em;
@@ -299,7 +305,7 @@ nav {
         margin-top: 1em;
     }
 
-    ul#toc-list {
+    ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
         padding: 0;
         margin: 0;
     }