metanorma-standoc 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810c273a1e6b17c407448b2bd4c8857cf76c90238924e2f891d9961564379fa8
-  data.tar.gz: d2bb301e3c33c71443892e368174673d056d68e29f1ddeecc70f64c922116755
+  metadata.gz: a5a2ad92a10730612ba26466f6508a0359c4a12ecd7f973618f0b01d80a83b83
+  data.tar.gz: 395911c6e85240c42682d2a14e310162dd19fbe4a863478d0c90067e32aa6650
 SHA512:
-  metadata.gz: 6771846b0c74aa8fd58317cf03135e3eb2a635037db1e64e488a6225b6dc4144ca934af8abc41cc551d9e1657abcab5331454a47c48f273fbc9150f8db8cddcf
-  data.tar.gz: c94f478d887abd354b24aa6ba9f4dda8095c8eb6ae496f36a871945eaacef4c94e6fb5d8c2e618faaa74dc07ab20fcca0476665f3d533d4f8d8d311fdf75ae29
+  metadata.gz: 17a60dd786a93b4982d2c9408b3308af6b9b31bb852aae30143da11a62c8a35715a77cdbba3bc899445987e646a4a7550ab6942662522c744fb38e76661f9d0e
+  data.tar.gz: 121aa21c43db0262c907b54b0e03f033a319f54756a7dbaca9d0da94fbd3fe85700d576327ab3d581329c4d6a606a2d76f0fefd6ad949db3fc10bad6116f2b05

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metanorma-standoc (1.1.2)
+    metanorma-standoc (1.1.3)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
       html2doc (~> 0.8.0)
@@ -16,7 +16,7 @@ GEM
   specs:
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
-    algoliasearch (1.25.2)
+    algoliasearch (1.26.0)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
     asciidoctor (1.5.8)
@@ -81,7 +81,7 @@ GEM
       algoliasearch
       iecbib (~> 0.2.1)
       iso-bib-item (~> 0.4.2)
-    isodoc (0.9.15)
+    isodoc (0.9.17)
       asciimath
       html2doc (~> 0.8.6)
       htmlentities (~> 4.3.4)

data/README.adoc

@@ -373,6 +373,10 @@ The following terms have non-normative effect, and should be ignored by the amet
 metrical foot consisting of a short, a long, and a short
 --
 
+Any clause within a Terms & Definitions section which is a nonterminal subclause (has
+child nodes) is automatically itself a terms (or definitions) section. On the other hand,
+any descendant of a nonterm clause is also a nonterm clause.
+
 === Cross-references to external documents
 
 Metanorma Asciidoctor, like normal Asciidoctor, will process cross-references to

data/lib/asciidoctor/standoc/blocks.rb

@@ -97,6 +97,7 @@ module Asciidoctor
         return note(node) if node.attr("name") == "note"
         noko do |xml|
           xml.admonition **admonition_attrs(node) do |a|
+            node.title.nil? or a.name { |name| name << node.title }
             wrap_in_para(node, a)
           end
         end.join("\n")

data/lib/asciidoctor/standoc/section.rb

@@ -21,7 +21,8 @@ module Asciidoctor
       end
 
       def sectiontype(node)
-        ret = node&.attr("heading")&.downcase || node.title.downcase
+        ret = node&.attr("heading")&.downcase ||
+          node.title.gsub(/<[^>]+>/, "").downcase
         return ret if ["symbols and abbreviated terms", "abbreviations",
                        "abbreviated terms", "symbols"].include? ret
         return nil unless node.level == 1
@@ -53,8 +54,9 @@ module Asciidoctor
           when "bibliography" then bibliography_parse(a, xml, node)
           else
             if @term_def then term_def_subclause_parse(a, xml, node)
+            elsif @definitions then symbols_parse(a, xml, node)
             elsif @biblio then bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "bibliography" && node.level == 1
+            elsif node.attr("style") == "bibliography"
               bibliography_parse(a, xml, node)
             elsif node.attr("style") == "abstract" 
               abstract_parse(a, xml, node)
@@ -114,24 +116,40 @@ module Asciidoctor
         @biblio = false
       end
 
+      def nonterm_symbols_parse(attrs, xml, node)
+        @definitions = false
+        clause_parse(attrs, xml, node)
+        @definitions = true
+      end
+
       def symbols_parse(attrs, xml, node)
+        node.role == "nonterm" and return nonterm_symbols_parse(attrs, xml, node)
         xml.definitions **attr_code(attrs) do |xml_section|
           xml_section.title { |t| t << node.title }
+          defs = @definitions
+          termdefs = @term_def
+          @definitions = true
+          @term_def = false
           xml_section << node.content
+          @definitions = defs
+          @term_def = termdefs
         end
       end
 
       SYMBOLS_TITLES = ["symbols and abbreviated terms", "symbols",
                         "abbreviated terms"].freeze
 
+      def nonterm_term_def_subclause_parse(attrs, xml, node)
+        @term_def = false
+        clause_parse(attrs, xml, node)
+        @term_def = true
+      end
+
       # subclause contains subclauses
       def term_def_subclause_parse(attrs, xml, node)
-        if node.role == "nonterm"
-          @term_def = false
-          clause_parse(attrs, xml, node)
-          @term_def = true
-          return
-        end
+        node.role == "nonterm" and
+          return nonterm_term_def_subclause_parse(attrs, xml, node)
+        return symbols_parse(attrs, xml, node) if @definitions
         sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
         sub.empty? || (return term_def_parse(attrs, xml, node, false))
         SYMBOLS_TITLES.include?(node.title.downcase) and

data/lib/asciidoctor/standoc/validate_section.rb

@@ -26,7 +26,7 @@ module Asciidoctor
       end
 
       def asset_title_style(root)
-        root.xpath("//figure[image][not(title)]").each do |node|
+        root.xpath("//figure[image][not(name)]").each do |node|
           style_warning(node, "Figure should have title", nil)
         end
         root.xpath("//table[not(name)]").each do |node|

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-    VERSION = "1.1.2".freeze
+    VERSION = "1.1.3".freeze
   end
 end

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -180,6 +180,34 @@ RSpec.describe Asciidoctor::Standoc do
 </clause>
 </terms>
 </sections>
+</standard-document>
+
+      OUTPUT
+  end
+
+        it "processes term notes as plain notes in definitions subclauses of terms & definitions" do
+    expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      === Term1
+
+      === Symbols
+
+      NOTE: This is a note
+      INPUT
+              #{BLANK_HDR}
+              <sections>
+  <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><term id="_">
+  <preferred>Term1</preferred>
+</term>
+<definitions id="_">
+  <title>Symbols</title>
+  <note id="_">
+  <p id="_">This is a note</p>
+</note>
+</definitions></terms>
+</sections>
 </standard-document>
 
       OUTPUT
@@ -253,7 +281,7 @@ RSpec.describe Asciidoctor::Standoc do
       expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
       [CAUTION,type=Safety Precautions]
-      .Safety Precautions
+      .Precautions
       ====
       While werewolves are hardy community members, keep in mind the following dietary concerns:
 
@@ -264,7 +292,7 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
       #{BLANK_HDR}
       <sections>
-         <admonition id="_" type="safety precautions"><p id="_">While werewolves are hardy community members, keep in mind the following dietary concerns:</p>
+         <admonition id="_" type="safety precautions"><name>Precautions</name><p id="_">While werewolves are hardy community members, keep in mind the following dietary concerns:</p>
        <ol id="_" type="arabic">
          <li>
            <p id="_">They are allergic to cinnamon.</p>
@@ -293,19 +321,18 @@ RSpec.describe Asciidoctor::Standoc do
       This is an example
       INPUT
       #{BLANK_HDR}
-              <sections>
-         <terms id="_" obligation="normative">
-         <title>Terms and definitions</title>
-         <term id="_">
-         <preferred>Term1</preferred>
-         <termexample id="_">
-         <p id="_">This is an example</p>
-       </termexample>
-       </term>
-       </terms>
-       </sections>
-       </standard-document>
+      <sections>
+  <terms id="_" obligation="normative">
+  <title>Terms and definitions</title>
+  <term id="_">
+  <preferred>Term1</preferred>
 
+<termexample id="_">
+  <p id="_">This is an example</p>
+</termexample></term>
+</terms>
+</sections>
+</standard-document>
       OUTPUT
     end
 
@@ -336,6 +363,34 @@ RSpec.describe Asciidoctor::Standoc do
       OUTPUT
     end
 
+  it "processes term examples as plain examples in definitions subclauses of terms & definitions" do
+    expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      === Term1
+
+      === Symbols
+
+      [example]
+      This is an example
+      INPUT
+              #{BLANK_HDR}
+<sections> 
+  <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><term id="_">   
+  <preferred>Term1</preferred>   
+</term>  
+<definitions id="_">   
+  <title>Symbols</title>   
+  <example id="_">    
+  <p id="_">This is an example</p>    
+</example>   
+</definitions></terms> 
+</sections>
+</standard-document>
+      OUTPUT
+  end
+
 
     it "processes examples" do
       expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"

data/spec/asciidoctor-standoc/section_spec.rb

@@ -32,12 +32,30 @@ RSpec.describe Asciidoctor::Standoc do
       [.nonterm]
       === Introduction
 
+      ==== Intro 1
+
+      === Intro 2
+
+      [.nonterm]
+      ==== Intro 3
+
+      === Intro 4
+
+      ==== Intro 5
+
+      ===== Term1
+
       === Normal Terms
 
       ==== Term2
 
       === Symbols and Abbreviated Terms
 
+      [.nonterm]
+      ==== General
+
+      ==== Symbols 1
+
       == Abbreviated Terms
 
       == Clause 4
@@ -57,65 +75,90 @@ RSpec.describe Asciidoctor::Standoc do
 
       === Bibliography Subsection
     INPUT
-       <preface><abstract id="_">
-         <p id="_">Text</p>
-       </abstract><foreword obligation="informative">
-         <title>Foreword</title>
-         <p id="_">Text</p>
-       </foreword><introduction id="_" obligation="informative">
-         <title>Introduction</title>
-         <clause id="_" inline-header="false" obligation="informative">
-         <title>Introduction Subsection</title>
-       </clause>
-       </introduction></preface><sections>
-
-       <clause id="_" inline-header="false" obligation="normative">
-         <title>Scope</title>
-         <p id="_">Text</p>
-       </clause>
-
-       <terms id="_" obligation="normative">
-         <title>Terms and definitions</title>
-         <term id="_">
-         <preferred>Term1</preferred>
-       </term>
-       </terms>
-       <clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><clause id="_" inline-header="false" obligation="normative">
-         <title>Introduction</title>
-       </clause>
-       <terms id="_" obligation="normative">
-         <title>Normal Terms</title>
-         <term id="_">
-         <preferred>Term2</preferred>
-       </term>
-       </terms>
-       <definitions id="_"><title>Symbols and Abbreviated Terms</title></definitions>
-       </clause>
-       <definitions id="_"><title>Abbreviated Terms</title></definitions>
-       <clause id="_" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="_" inline-header="false" obligation="normative">
-         <title>Introduction</title>
-       </clause>
-       <clause id="_" inline-header="false" obligation="normative">
-         <title>Clause 4.2</title>
-       </clause></clause>
-       <clause id="_" inline-header="false" obligation="normative">
-         <title>Terms and Definitions</title>
-       </clause>
-
-       </sections><annex id="_" inline-header="false" obligation="normative">
-         <title>Annex</title>
-         <clause id="_" inline-header="false" obligation="normative">
-         <title>Annex A.1</title>
-       </clause>
-       </annex><bibliography><references id="_" obligation="informative">
-         <title>Normative References</title>
-       </references><clause id="_" obligation="informative">
-         <title>Bibliography</title>
-         <references id="_" obligation="informative">
-         <title>Bibliography Subsection</title>
-       </references>
-       </clause></bibliography>
-       </standard-document>
+    <preface><abstract id="_">
+  <p id="_">Text</p>
+</abstract><foreword obligation="informative">
+  <title>Foreword</title>
+  <p id="_">Text</p>
+</foreword><introduction id="_" obligation="informative">
+  <title>Introduction</title>
+  <clause id="_" inline-header="false" obligation="informative">
+  <title>Introduction Subsection</title>
+</clause>
+</introduction></preface><sections>
+
+
+<clause id="_" inline-header="false" obligation="normative">
+  <title>Scope</title>
+  <p id="_">Text</p>
+</clause>
+
+<terms id="_" obligation="normative">
+  <title>Terms and definitions</title>
+  <term id="_">
+  <preferred>Term1</preferred>
+</term>
+</terms>
+<clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><clause id="_" inline-header="false" obligation="normative">
+  <title>Introduction</title>
+  <clause id="_" inline-header="false" obligation="normative">
+  <title>Intro 1</title>
+</clause>
+</clause>
+<terms id="_" obligation="normative">
+  <title>Intro 2</title>
+  <clause id="_" inline-header="false" obligation="normative">
+  <title>Intro 3</title>
+</clause>
+</terms>
+<clause id="_" obligation="normative">
+  <title>Intro 4</title>
+  <terms id="_" obligation="normative">
+  <title>Intro 5</title>
+  <term id="_">
+  <preferred>Term1</preferred>
+</term>
+</terms>
+</clause>
+<terms id="_" obligation="normative">
+  <title>Normal Terms</title>
+  <term id="_">
+  <preferred>Term2</preferred>
+</term>
+</terms>
+<definitions id="_"><title>Symbols and Abbreviated Terms</title><clause id="_" inline-header="false" obligation="normative">
+  <title>General</title>
+</clause>
+<definitions id="_">
+  <title>Symbols 1</title>
+</definitions></definitions></clause>
+<definitions id="_">
+  <title>Abbreviated Terms</title>
+</definitions>
+<clause id="_" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="_" inline-header="false" obligation="normative">
+  <title>Introduction</title>
+</clause>
+<clause id="_" inline-header="false" obligation="normative">
+  <title>Clause 4.2</title>
+</clause></clause>
+<clause id="_" inline-header="false" obligation="normative">
+  <title>Terms and Definitions</title>
+</clause>
+
+</sections><annex id="_" inline-header="false" obligation="normative">
+  <title>Annex</title>
+  <clause id="_" inline-header="false" obligation="normative">
+  <title>Annex A.1</title>
+</clause>
+</annex><bibliography><references id="_" obligation="informative">
+  <title>Normative References</title>
+</references><clause id="_" obligation="informative">
+  <title>Bibliography</title>
+  <references id="_" obligation="informative">
+  <title>Bibliography Subsection</title>
+</references>
+</clause></bibliography>
+</standard-document>
     OUTPUT
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor