asciidoctor-iso 0.6.1 → 0.7.0

data/lib/asciidoctor/iso/isostandard.rng

@@ -119,6 +119,9 @@
       <optional>
         <ref name="copyright"/>
       </optional>
+      <zeroOrMore>
+        <ref name="docrelation"/>
+      </zeroOrMore>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -169,6 +172,9 @@
         <ref name="status"/>
       </optional>
       <ref name="copyright"/>
+      <zeroOrMore>
+        <ref name="docrelation"/>
+      </zeroOrMore>
       <ref name="editorialgroup"/>
     </define>
     <define name="bdate">
@@ -231,11 +237,45 @@
       <element name="sections">
         <ref name="clause"/>
         <ref name="terms"/>
+        <optional>
+          <ref name="symbols-abbrevs"/>
+        </optional>
         <oneOrMore>
           <ref name="clause"/>
         </oneOrMore>
       </element>
     </define>
+    <define name="Content-Section">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <ref name="section-title"/>
+      </optional>
+      <choice>
+        <group>
+          <oneOrMore>
+            <ref name="BasicBlock"/>
+          </oneOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <oneOrMore>
+          <ref name="content-subsection"/>
+        </oneOrMore>
+      </choice>
+    </define>
     <define name="references">
       <element name="references">
         <optional>
@@ -243,6 +283,14 @@
             <data type="ID"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="obligation">
+            <choice>
+              <value>normative</value>
+              <value>informative</value>
+            </choice>
+          </attribute>
+        </optional>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -254,6 +302,24 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="symbols-abbrevs">
+      <element name="symbols-abbrevs">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="obligation">
+            <choice>
+              <value>normative</value>
+              <value>informative</value>
+            </choice>
+          </attribute>
+        </optional>
+        <ref name="dl"/>
+      </element>
+    </define>
     <define name="terms">
       <element name="terms">
         <optional>
@@ -261,23 +327,32 @@
             <data type="ID"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="obligation">
+            <choice>
+              <value>normative</value>
+              <value>informative</value>
+            </choice>
+          </attribute>
+        </optional>
         <optional>
           <ref name="section-title"/>
         </optional>
         <zeroOrMore>
-          <!-- boilerplate -->
-          <ref name="paragraph-with-footnote"/>
+          <ref name="termdocsource"/>
         </zeroOrMore>
-        <optional>
-          <ref name="ul"/>
-        </optional>
         <choice>
           <oneOrMore>
             <ref name="term"/>
           </oneOrMore>
-          <optional>
-            <ref name="terms"/>
-          </optional>
+          <group>
+            <zeroOrMore>
+              <ref name="terms"/>
+            </zeroOrMore>
+            <optional>
+              <ref name="symbols-abbrevs"/>
+            </optional>
+          </group>
         </choice>
       </element>
     </define>
@@ -334,7 +409,7 @@
           </attribute>
         </optional>
         <optional>
-          <attribute name="subtype">
+          <attribute name="obligation">
             <choice>
               <value>normative</value>
               <value>informative</value>
@@ -370,7 +445,7 @@
         <choice>
           <ref name="image"/>
           <oneOrMore>
-            <ref name="figure"/>
+            <ref name="subfigure"/>
           </oneOrMore>
         </choice>
         <zeroOrMore>
@@ -395,11 +470,13 @@
     </define>
     <define name="dd">
       <element name="dd">
-        <!--
-          ( paragraph-with-footnote | table | note | formula | admonition | ol | ul | dl | quote | sourcecode | review | example )*
-          exclude figures?
-        -->
-        <ref name="BasicBlock"/>
+        <zeroOrMore>
+          <!--
+            ( paragraph-with-footnote | table | note | formula | admonition | ol | ul | dl | quote | sourcecode | review | example )*
+            exclude figures?
+          -->
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
       </element>
     </define>
     <define name="admonition">
@@ -528,6 +605,14 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
@@ -647,6 +732,11 @@
           <data type="int"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="subpart">
+          <data type="int"/>
+        </attribute>
+      </optional>
       <data type="int"/>
     </element>
   </define>
@@ -713,6 +803,14 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
@@ -728,4 +826,20 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="subfigure">
+    <element name="figure">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <optional>
+        <ref name="tname"/>
+      </optional>
+      <ref name="image"/>
+    </element>
+  </define>
+  <define name="termdocsource">
+    <element name="source">
+      <ref name="erefType"/>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/iso/lists.rb

@@ -6,14 +6,10 @@ module Asciidoctor
         xml_ul.li do |xml_li|
           style(item, item.text)
           if item.blocks?
-            xml_li.p **id_attr(item) do |t|
-              t << item.text
-            end
+            xml_li.p(**id_attr(item)) { |t| t << item.text }
             xml_li << item.content
           else
-            xml_li.p **id_attr(item) do |p|
-              p << item.text
-            end
+            xml_li.p(**id_attr(item)) { |p| p << item.text }
           end
         end
       end
@@ -30,58 +26,62 @@ module Asciidoctor
         end.join("\n")
       end
 
-      def iso_publisher(t)
+      def iso_publisher(t, code)
         t.contributor do |c|
-          c.role **{ type: "publisher" } 
+          c.role **{ type: "publisher" }
           c.organization do |aff|
-            aff.name "ISO"
+            aff.name code.gsub(%r{[/ \t].*$}, "")
           end
         end
       end
 
+      def plaintxt
+        { format: "text/plain" }
+      end
+
+      def ref_attributes(m)
+        { id: m[:anchor], type: "standard" }
+      end
+
       def isorefmatches(xml, m)
-        ref_attributes = { id: m[:anchor], type: "standard" }
-        xml.bibitem **attr_code(ref_attributes) do |t|
-          t.title **{ format: "text/plain" } { |i| i << ref_normalise(m[:text]) }
+        xml.bibitem **attr_code(ref_attributes(m)) do |t|
+          t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
           t.docidentifier m[:code]
-          t.date m[:year], { type: "published" } if m[:year]
-          iso_publisher(t)
+          t.date(m[:year], type: "published") if m[:year]
+          iso_publisher(t, m[:code])
         end
       end
 
       def isorefmatches2(xml, m)
-        ref_attributes = { id: m[:anchor], type: "standard" }
-        xml.bibitem **attr_code(ref_attributes) do |t|
-          t.title **{ format: "text/plain" } { |i| i << ref_normalise(m[:text]) }
+        xml.bibitem **attr_code(ref_attributes(m)) do |t|
+          t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
           t.docidentifier m[:code]
-          t.date "--", { type: "published" }
-          iso_publisher(t)
-          t.note **{ format: "text/plain" } { |p| p << "ISO DATE: #{m[:fn]}" }
+          t.date "--", type: "published"
+          iso_publisher(t, m[:code])
+          t.note(**plaintxt) { |p| p << "ISO DATE: #{m[:fn]}" }
         end
       end
 
       def isorefmatches3(xml, m)
-        ref_attributes = { id: m[:anchor], type: "standard" }
-        xml.bibitem **attr_code(ref_attributes) do |t|
-          t.title **{ format: "text/plain" } { |i| i << ref_normalise(m[:text]) }
+        xml.bibitem **attr_code(ref_attributes(m)) do |t|
+          t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
           t.docidentifier "#{m[:code]}:All Parts"
-          t.date m[:year], { type: "published" } if m[:year]
-          iso_publisher(t)
+          t.date(m[:year], type: "published") if m[:year]
+          iso_publisher(t, m[:code])
         end
       end
 
+      # TODO: alternative where only title is available
       def refitem(xml, item, node)
-        m = NON_ISO_REF.match item
-        if m.nil? then Utils::warning(node, "no anchor on reference", item)
-        else
-          xml.bibitem **attr_code(id: m[:anchor]) do |t|
-            t.formattedref  **{ format: "application/x-isodoc+xml" } do |i| 
-              i << ref_normalise_no_format(m[:text]) 
-            end
-            code = m[:code]
-            code = "[#{code}]" if /^\d+$?/.match? code
-            t.docidentifier code
+        unless m = NON_ISO_REF.match(item)
+          Utils::warning(node, "no anchor on reference", item)
+          return
+        end
+        xml.bibitem **attr_code(id: m[:anchor]) do |t|
+          t.formattedref **{ format: "application/x-isodoc+xml" } do |i|
+            i << ref_normalise_no_format(m[:text])
           end
+          t.docidentifier(/^\d+$/.match?(m[:code]) ? "[#{m[:code]}]" : m[:code])
         end
       end
 
@@ -107,17 +107,25 @@ module Asciidoctor
       <fn[^>]*>\s*<p>(?<fn>[^\]]+)</p>\s*</fn>,?\s?(?<text>.*)$}xm
 
       ISO_REF_ALL_PARTS = %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[(?<code>(ISO|IEC)[^0-9]*\s[0-9]+)\s\(all\sparts\)\]</ref>(<p>)?,?\s?
-      (?<text>.*)(</p>)?$}xm
+      \[(?<code>(ISO|IEC)[^0-9]*\s[0-9]+)(:(?<year>[0-9]+))?\s
+      \(all\sparts\)\]</ref>,?\s
+      (?<text>.*)$}xm
 
       NON_ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
       \[(?<code>[^\]]+)\]</ref>,?\s
       (?<text>.*)$}xm
 
-      def reference1(node, item, xml, normative)
+      NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze
+
+      def reference1_matches(item)
         matched = ISO_REF.match item
         matched2 = ISO_REF_NO_YEAR.match item
         matched3 = ISO_REF_ALL_PARTS.match item
+        [matched, matched2, matched3]
+      end
+
+      def reference1(node, item, xml, normative)
+        matched, matched2, matched3 = reference1_matches(item)
         if matched3.nil? && matched2.nil? && matched.nil?
           refitem(xml, item, node)
         elsif !matched.nil? then isorefmatches(xml, matched)
@@ -125,8 +133,7 @@ module Asciidoctor
         elsif !matched3.nil? then isorefmatches3(xml, matched3)
         end
         if matched3.nil? && matched2.nil? && matched.nil? && normative
-          w = "non-ISO/IEC reference not expected as normative"
-          Utils::warning(node, w, item)
+          Utils::warning(node, NORM_ISO_WARN, item)
         end
       end
 
@@ -143,7 +150,7 @@ module Asciidoctor
         return "roman" if style == "lowerroman"
         return "roman_upper" if style == "upperroman"
         return "alphabet_upper" if style == "upperalpha"
-        return style
+        style
       end
 
       def olist(node)
@@ -191,7 +198,7 @@ module Asciidoctor
       def colist(node)
         noko do |xml|
           node.items.each_with_index do |item, i|
-            xml_ul.annotation **attr_code(id: i + 1) do |xml_li|
+            xml.annotation **attr_code(id: i + 1) do |xml_li|
               style(item, item.text)
               xml_li.p { |p| p << item.text }
             end

data/lib/asciidoctor/iso/macros.rb

@@ -1,4 +1,4 @@
-require 'asciidoctor/extensions'
+require "asciidoctor/extensions"
 module Asciidoctor
   module ISO
     class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
@@ -7,19 +7,22 @@ module Asciidoctor
       parse_content_as :text
       using_format :short
 
-      def process parent, target, attrs
-        %{<admitted>#{Asciidoctor::Inline.new(parent, :quoted, attrs['text']).convert}</admitted>}
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<admitted>#{out}</admitted>}
       end
     end
 
-    class DeprecatedTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class DeprecatedTermInlineMacro <
+      Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :deprecated
       parse_content_as :text
       using_format :short
 
-      def process parent, target, attrs
-        %{<deprecates>#{attrs["text"]}</deprecates>}
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<deprecates>#{out}</deprecates>}
       end
     end
 
@@ -29,8 +32,9 @@ module Asciidoctor
       parse_content_as :text
       using_format :short
 
-      def process parent, target, attrs
-        %{<domain>#{attrs["text"]}</domain>}
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<domain>#{out}</domain>}
       end
     end
   end

data/lib/asciidoctor/iso/section.rb

@@ -4,15 +4,10 @@ require "uri"
 module Asciidoctor
   module ISO
     module Section
-      @scope = false
       @biblio = false
       @term_def = false
       @norm_ref = false
 
-      def in_scope
-        @scope
-      end
-
       def in_biblio
         @biblio
       end
@@ -25,31 +20,33 @@ module Asciidoctor
         @norm_ref
       end
 
+      def sectiontype(node)
+        node&.attr("heading")&.downcase || node.title.downcase
+      end
+
       def section(node)
         a = { id: Utils::anchor_or_uuid(node) }
         noko do |xml|
-          case node.title.downcase
+          case sectiontype(node)
           when "introduction" then
-            if node.level == 1
-              introduction_parse(a, xml, node)
+            if node.level == 1 then introduction_parse(a, xml, node)
             else
               clause_parse(a, xml, node)
             end
           when "patent notice" then patent_notice_parse(xml, node)
           when "scope" then scope_parse(a, xml, node)
           when "normative references" then norm_ref_parse(a, xml, node)
-          when "terms and definitions" 
-            term_def_parse(a, xml, node, node.title.downcase)
-          when "terms, definitions, symbols and abbreviations"
-            term_def_parse(a, xml, node, node.title.downcase)
-          when "symbols and abbreviated terms" 
+          when "terms and definitions",
+            "terms, definitions, symbols and abbreviated terms"
+            @term_def = true
+            term_def_parse(a, xml, node, true)
+            @term_def = false
+          when "symbols and abbreviated terms"
             symbols_parse(a, xml, node)
           when "bibliography" then bibliography_parse(a, xml, node)
           else
-            if @term_def
-              term_def_subclause_parse(a, xml, node)
-            elsif @biblio
-              bibliography_parse(a, xml, node)
+            if @term_def then term_def_subclause_parse(a, xml, node)
+            elsif @biblio then bibliography_parse(a, xml, node)
             elsif node.attr("style") == "appendix" && node.level == 1
               annex_parse(a, xml, node)
             else
@@ -59,12 +56,24 @@ module Asciidoctor
         end.join("\n")
       end
 
+      def set_obligation(attrs, node)
+        attrs[:obligation] = if node.attributes.has_key?("obligation")
+                               node.attr("obligation")
+                             elsif node.parent.attributes.has_key?("obligation")
+                               node.parent.attr("obligation")
+                             else
+                               "normative"
+                             end
+      end
+
+      SCOPE_WARN = "Scope contains subsections: should be succint".freeze
+
+      # Not testing max depth of sections: Asciidoctor already limits
+      # it to 5 levels of nesting
       def clause_parse(attrs, xml, node)
-        attrs["inline-header".to_sym] = true if node.option? "inline-header"
-        w = "Scope contains subsections: should be succint"
-        style_warning(node, w, nil) if @scope
-        # Not testing max depth of sections: Asciidoctor already limits
-        # it to 5 levels of nesting
+        attrs["inline-header".to_sym] = node.option? "inline-header"
+        set_obligation(attrs, node)
+        style_warning(node, SCOPE_WARN, nil) if @scope
         sect = node.level == 1 ? "clause" : "subsection"
         xml.send sect, **attr_code(attrs) do |xml_section|
           xml_section.title { |n| n << node.title } unless node.title.nil?
@@ -73,11 +82,8 @@ module Asciidoctor
       end
 
       def annex_parse(attrs, xml, node)
-        attrs["inline-header".to_sym] = true if node.option? "inline-header"
-        attrs[:subtype] = "informative"
-        if node.attributes.has_key?("subtype")
-          attrs[:subtype] = node.attr("subtype")
-        end
+        attrs["inline-header".to_sym] = node.option? "inline-header"
+        set_obligation(attrs, node)
         xml.annex **attr_code(attrs) do |xml_section|
           xml_section.title { |name| name << node.title }
           xml_section << node.content
@@ -101,24 +107,34 @@ module Asciidoctor
       end
 
       def term_def_subclause_parse(attrs, xml, node)
+        # subclause contains subclauses
+        sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
+        sub.empty? || (return term_def_parse(attrs, xml, node, false))
+        node.title.casecmp("symbols and abbreviated terms").zero? &&
+          (return symbols_parse(attrs, xml, node))
         xml.term **attr_code(attrs) do |xml_section|
           xml_section.preferred { |name| name << node.title }
           xml_section << node.content
         end
       end
 
-      def term_def_parse(attrs, xml, node, title)
-        @term_def = true
-        xml.terms **attr_code(attrs) do |xml_section|
-          if title == "terms, definitions, symbols and abbreviations"
-            title = "Terms, Definitions, Symbols and Abbreviations"
-          else
-            title = "Terms and Definitions"
+      def term_def_title(toplevel, node)
+        return node.title unless toplevel
+        sub = node.find_by(context: :section) do |s|
+          s.title.casecmp("symbols and abbreviated terms").zero?
+        end
+        return "Terms and Definitions" if sub.empty?
+        "Terms, Definitions, Symbols and Abbreviated Terms"
+      end
+
+      def term_def_parse(attrs, xml, node, toplevel)
+        xml.terms **attr_code(attrs) do |section|
+          section.title { |t| t << term_def_title(toplevel, node) }
+          (s = node.attr("source")) && s.split(/,/).each do |s1|
+            section.source(nil, **attr_code(target: s1, type: "inline"))
           end
-          xml_section.title { |t| t << title }
-          xml_section << node.content
+          section << node.content
         end
-        @term_def = false
       end
 
       def norm_ref_parse(attrs, xml, node)