metanorma-iso 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da80e1829e3bb23b48ec255ec0d6533f4649eb2ad68c226213bc79715ae2b1a4
-  data.tar.gz: 91fde5d59c47042e11426c4b66128acd946302786345f30aead55e0783b30297
+  metadata.gz: '07499247abd9fb32513b4866fe1ed231c89ab893d360ed817cd215361c31aac1'
+  data.tar.gz: 0e72da21b9efc829e6868edaacaf430bccfc816588ad0b209fe7ed3fdb077e74
 SHA512:
-  metadata.gz: a20bb43d79f3e9590238a0f115d70d149d14b8ee5884e97898f7ab40f8fcc5cf6855bb5065d90e3931f763d620a68dba936ad79a0a7d87e42e31289a5273b1da
-  data.tar.gz: d9ed11afc2c9ba8ed9964106dc9ebdbbde7278be5b06036e4ba7150a2a0501bd968a10bf7f31cf98c96cb713cb0cd9950b4b47431f91471ce1831b8f454b2bec
+  metadata.gz: c0c76bae355c918ed8dc336e6f00a2145621d7c2c1382331b486381ffc2f57071777d8dd582754c021ec3dfdc45820ec3122c1034ea36048e14fafc1a3505420
+  data.tar.gz: c178a3832ede766c0aea9662284179def0fe8df3c45994de3b396714688c06d0170cf29e0dcc8f1351f4885428a9ee7013d9f7d7898f49cbbbd849e4192e7436

data/README.adoc

@@ -454,6 +454,25 @@ from the image.
 image::logo.jpg
 --
 
+=== Subclauses in Terms & Definitions sections
+
+Normally any terminal subclause in a Terms & Definitions section is treated as a term
+definition. Exceptionally, an introductory section can be tagged to be treated as a clause,
+instead of a term, by prefixing it with the style attribute `[.nonterm]`.
+
+[source,asciidoctor]
+--
+== Terms and definitions
+
+[.nonterm]
+=== Introduction
+The following terms have non-normative effect, and should be ignored by the ametrical.
+
+=== Anapaest
+
+metrical foot consisting of a short, a long, and a short
+--
+
 === Sections embedded more than 5 levels
 
 Asciidoctor permits only 5 levels of section embedding (not counting the document title).

data/docs/guidance.adoc

@@ -241,6 +241,20 @@ stem:[t_A]
 Time to launch.
 --
 
+As defined above, all terminal subclauses of a term section are treated as term definitions. Exceptionally, an introductory section can be treated as a subclause instead of a term, by prefixing it with the style attribute `[.nonterm]`:
+
+[source,asciidoctor]
+--
+== Terms and definitions
+
+[.nonterm]
+=== Introduction
+The following terms have non-normative effect, and should be ignored by the ametrical.
+
+=== Anapaest
+
+metrical foot consisting of a short, a long, and a short
+--
 
 === Symbols and Abbreviations
 

data/docs/quickstart.adoc

@@ -323,6 +323,8 @@ and Note 1 to entry is not included here
 
 Term banks such as the http://www.electropedia.org[IEV] must be treated like any other document, with terms treated as clauses; e.g. `<<IEV,clause "103-01-01">>`. The IEV must be explictly referenced with that label; when the XML is generated, it will be replaced by the official references to `IEC 60050-nnn:2001` standards documents.
 
+Exceptionally, an introductory section can be treated as a subclause instead of a term, by prefixing it with the style attribute `[.nonterm]`.
+
 === References (Normative, Informative)
 
 All bibliographic entries must be given as unordered lists. Normative references are expected to include only ISO and related standards; informative references may include any source.

data/lib/asciidoctor/iso/section.rb

@@ -21,7 +21,8 @@ module Asciidoctor
             @term_def = true
             term_def_parse(a, xml, node, true)
             @term_def = false
-          when "symbols and abbreviated terms"
+          when "symbols and abbreviated terms",
+            "abbreviations", "abbreviated terms", "symbols"
             symbols_parse(a, xml, node)
           when "bibliography" then bibliography_parse(a, xml, node)
           else

data/lib/asciidoctor/iso/validate.rb

@@ -69,122 +69,132 @@ module Asciidoctor
             subtitle = ss.at("./title")
             !subtitle.nil? && !subtitle&.text&.empty? ||
               warn("#{title}: each first-level subclause must have a title")
+          end
+        end
       end
-    end
-  end
 
-  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 &&
-      warn("#{label}: all subclauses must have a title, or none")
-  end
+      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 &&
+          warn("#{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
+      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
 
-  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?
-      warn "ISO style: #{location}: subclause is only child"
-    end
-  end
+      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?
+          warn "ISO style: #{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}"
+      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}"
+          end
+        end
+        root.xpath("//subcommittee/@type").each do |t|
+          unless %w{SC JSC}.include? t.text
+            warn "ISO: invalid subcommittee type #{t}"
+          end
+        end
       end
-    end
-    root.xpath("//subcommittee/@type").each do |t|
-      unless %w{SC JSC}.include? t.text
-        warn "ISO: invalid subcommittee type #{t}"
+
+      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? && /\bsee\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"
+          end
+        end
       end
-    end
-  end
 
-  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? && /\bsee\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"
+      def see_erefs_validate(root)
+        root.xpath("//eref").each do |t|
+          preceding = t.at("./preceding-sibling::text()[last()]")
+          next unless !preceding.nil? && /\bsee\s*$/mi.match(preceding)
+          target = root.at("//*[@id = '#{t['bibitemid']}']")
+          if target.at("./ancestor::references"\
+              "[title = 'Normative References']")
+            warn "ISO: 'see #{t}' is pointing to a normative reference"
+          end
+        end
       end
-    end
-  end
 
-  def see_erefs_validate(root)
-    root.xpath("//eref").each do |t|
-      preceding = t.at("./preceding-sibling::text()[last()]")
-      next unless !preceding.nil? && /\bsee\s*$/mi.match(preceding)
-      target = root.at("//*[@id = '#{t['bibitemid']}']")
-      if target.at("./ancestor::references"\
-          "[title = 'Normative References']")
-        warn "ISO: 'see #{t}' is pointing to a normative reference"
+      def locality_erefs_validate(root)
+        root.xpath("//eref[locality]").each do |t|
+          unless /^IEV$|:[ ]?(\d+{4}|--)$/.match t["citeas"]
+            warn "ISO: undated reference #{t['citeas']} should not contain "\
+              "specific elements"
+          end
+        end
       end
-    end
-  end
 
-  def locality_erefs_validate(root)
-    root.xpath("//eref[locality]").each do |t|
-      unless /^IEV$|:[ ]?(\d+{4}|--)$/.match t["citeas"]
-        warn "ISO: undated reference #{t['citeas']} should not contain "\
-          "specific elements"
+      def termdef_warn(text, re, term, msg)
+        re.match(text) && warn("ISO style: #{term}: #{msg}")
       end
-    end
-  end
 
-  def termdef_warn(text, re, term, msg)
-    re.match(text) && warn("ISO style: #{term}: #{msg}")
-  end
+      def termdef_style(xmldoc)
+        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,
+                       "term definition starts with article")
+          termdef_warn(para.text, /\.$/i, term,
+                       "term definition ends with period")
+        end
+        cited_term_style(xmldoc)
+      end
 
-  def termdef_style(xmldoc)
-    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,
-                   "term definition starts with article")
-      termdef_warn(para.text, /\.$/i, term,
-                   "term definition ends with period")
-    end
-  end
+      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)
+        end
+      end
 
-  def content_validate(doc)
-    super
-    title_validate(doc.root)
-    isosubgroup_validate(doc.root)
-    onlychild_clause_validate(doc.root)
-    termdef_style(doc.root)
-    iev_validate(doc.root)
-    see_xrefs_validate(doc.root)
-    see_erefs_validate(doc.root)
-    locality_erefs_validate(doc.root)
-  end
+      def content_validate(doc)
+        super
+        title_validate(doc.root)
+        isosubgroup_validate(doc.root)
+        onlychild_clause_validate(doc.root)
+        termdef_style(doc.root)
+        iev_validate(doc.root)
+        see_xrefs_validate(doc.root)
+        see_erefs_validate(doc.root)
+        locality_erefs_validate(doc.root)
+      end
 
-  def validate(doc)
-    content_validate(doc)
-    schema_validate(formattedstr_strip(doc.dup),
-                    File.join(File.dirname(__FILE__), "isostandard.rng"))
-  end
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        File.join(File.dirname(__FILE__), "isostandard.rng"))
+      end
     end
   end
 end

data/lib/asciidoctor/iso/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module ISO
-    VERSION = "1.0.3".freeze
+    VERSION = "1.0.4".freeze
   end
 end

data/spec/asciidoctor-iso/validate_spec.rb

@@ -930,4 +930,16 @@ it "Do not warn if not more than 7 levels of subclause" do
 
   INPUT
 end
+
+it "Warn if term citation in Terms & Definitions not preceded with italicised term" do
+    expect { Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true) }.to output(%r{term citation not preceded with italicised term}).to_stderr
+  #{VALIDATING_BLANK_HDR}
+  == Terms and Definitions
+
+  [[term]]
+  === Term
+
+  The definition of a term (<<term>>) is a part of the specialized vocabulary of a particular field
+  INPUT
+end
 end

data/spec/assets/iso.doc

@@ -1,7 +1,7 @@
 MIME-Version: 1.0
-Content-Type: multipart/related; boundary="----=_NextPart_c65e6679.db03.4744"
+Content-Type: multipart/related; boundary="----=_NextPart_64b56c80.e800.431f"
 
-------=_NextPart_c65e6679.db03.4744
+------=_NextPart_64b56c80.e800.431f
 Content-Location: file:///C:/Doc/spec/assets/iso.htm
 Content-Type: text/html; charset="utf-8"
 
@@ -843,11 +843,11 @@ Switzerland<p class="MsoNormal"></p></span></p>
 <p class="MsoToc1"><span lang="EN-GB" xml:lang="EN-GB"><span style="mso-element:field-begin"></span><span style="mso-spacerun:yes">&#xA0;</span>TOC
   \o "1-2" \h \z \u <span style="mso-element:field-separator"></span></span>
 <span class="MsoHyperlink"><span lang="EN-GB" style="mso-no-proof:yes" xml:lang="EN-GB">
-<a href="#_Toc586635060">Foreword<span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB">
+<a href="#_Toc91959334">Foreword<span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB">
 <span style="mso-tab-count:1 dotted">. </span>
 </span><span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB">
 <span style="mso-element:field-begin"></span></span>
-<span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB"> PAGEREF _Toc586635060 \h </span>
+<span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB"> PAGEREF _Toc91959334 \h </span>
   <span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB"><span style="mso-element:field-separator"></span></span><span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB">1</span>
   <span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB"></span><span lang="EN-GB" class="MsoTocTextSpan" xml:lang="EN-GB"><span style="mso-element:field-end"></span></span></a></span></span></p>
 
@@ -880,7 +880,7 @@ Switzerland<p class="MsoNormal"></p></span></p>
 </html>
 
 
-------=_NextPart_c65e6679.db03.4744
+------=_NextPart_64b56c80.e800.431f
 Content-Location: file:///C:/Doc/spec/assets/iso_files/filelist.xml
 Content-Transfer-Encoding: base64
 Content-Type: application/xml
@@ -890,7 +890,7 @@ ICAgICAgIDxvOk1haW5GaWxlIEhSZWY9Ii4uL3NwZWMvYXNzZXRzL2lzby5odG0iLz4gIDxvOkZp
 bGUgSFJlZj0iZmlsZWxpc3QueG1sIi8+CiAgPG86RmlsZSBIUmVmPSJoZWFkZXIuaHRtbCIvPgo8
 L3htbD4K
 
-------=_NextPart_c65e6679.db03.4744
+------=_NextPart_64b56c80.e800.431f
 Content-Location: file:///C:/Doc/spec/assets/iso_files/header.html
 Content-Transfer-Encoding: base64
 Content-Type: text/html charset="utf-8"
@@ -1083,4 +1083,4 @@ cD4NCg0KPHAgY2xhc3M9TXNvRm9vdGVyPjxzcGFuIGxhbmc9RU4tQVUgc3R5bGU9J2ZvbnQtc2l6
 ZToxMC4wcHQ7Jz7CqQ0KJm5ic3A7Jm5ic3A74oCTIEFsbCByaWdodHMgcmVzZXJ2ZWQ8bzpwPjwv
 bzpwPjwvc3Bhbj48L3A+DQoNCjwvZGl2Pg0KDQoNCg0KPC9ib2R5Pg0KDQo8L2h0bWw+DQo=
 
-------=_NextPart_c65e6679.db03.4744--
+------=_NextPart_64b56c80.e800.431f--

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iso
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor