metanorma-standoc 1.10.6 → 1.10.7

data/lib/asciidoctor/standoc/macros.rb

@@ -6,6 +6,7 @@ require "csv"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
 require_relative "./macros_form"
+require_relative "./macros_note"
 require_relative "./datamodel/attributes_table_preprocessor"
 require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"
@@ -41,7 +42,7 @@ module Asciidoctor
       def process(_parent, target, attr)
         args = preprocess_attrs(attr) or return
         ret = "<index-xref also='#{target == 'also'}'>"\
-          "<primary>#{args[:primary]}</primary>"
+              "<primary>#{args[:primary]}</primary>"
         ret += "<secondary>#{args[:secondary]}</secondary>" if args[:secondary]
         ret += "<tertiary>#{args[:tertiary]}</tertiary>" if args[:tertiary]
         ret + "<target>#{args[:target]}</target></index-xref>"
@@ -50,7 +51,7 @@ module Asciidoctor
 
     class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
-      named "index-range".to_sym
+      named :"index-range"
       parse_content_as :text
 
       def process(parent, target, attr)
@@ -121,35 +122,6 @@ module Asciidoctor
       end
     end
 
-    class ToDoAdmonitionBlock < Extensions::BlockProcessor
-      use_dsl
-      named :TODO
-      on_contexts :example, :paragraph
-
-      def process(parent, reader, attrs)
-        attrs["name"] = "todo"
-        attrs["caption"] = "TODO"
-        create_block(parent, :admonition, reader.lines, attrs,
-                     content_model: :compound)
-      end
-    end
-
-    class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
-      def process(document)
-        (document.find_by context: :paragraph).each do |para|
-          next unless /^TODO: /.match? para.lines[0]
-
-          parent = para.parent
-          para.set_attr("name", "todo")
-          para.set_attr("caption", "TODO")
-          para.lines[0].sub!(/^TODO: /, "")
-          todo = Block.new(parent, :admonition, attributes: para.attributes,
-                                                source: para.lines, content_model: :compound)
-          parent.blocks[parent.blocks.index(para)] = todo
-        end
-      end
-    end
-
     class AutonumberInlineMacro < Extensions::InlineMacroProcessor
       use_dsl
       named :autonumber
@@ -177,18 +149,6 @@ module Asciidoctor
       end
     end
 
-    class FootnoteBlockInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :footnoteblock
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<footnoteblock>#{out}</footnoteblock>}
-      end
-    end
-
     class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :add
@@ -229,5 +189,16 @@ module Asciidoctor
         "<toc>#{content}</toc>"
       end
     end
+
+    class PassInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :"pass-format"
+
+      def process(parent, target, attrs)
+        format = target || "metanorma"
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs[1]).convert
+        %{<passthrough formats="#{format}">#{out}</passthrough>}
+      end
+    end
   end
 end

data/lib/asciidoctor/standoc/macros_note.rb

@@ -0,0 +1,45 @@
+module Asciidoctor
+  module Standoc
+    class ToDoAdmonitionBlock < Extensions::BlockProcessor
+      use_dsl
+      named :TODO
+      on_contexts :example, :paragraph
+
+      def process(parent, reader, attrs)
+        attrs["name"] = "todo"
+        attrs["caption"] = "TODO"
+        create_block(parent, :admonition, reader.lines, attrs,
+                     content_model: :compound)
+      end
+    end
+
+    class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
+      def process(document)
+        (document.find_by context: :paragraph).each do |para|
+          next unless /^TODO: /.match? para.lines[0]
+
+          parent = para.parent
+          para.set_attr("name", "todo")
+          para.set_attr("caption", "TODO")
+          para.lines[0].sub!(/^TODO: /, "")
+          todo = Block.new(parent, :admonition, attributes: para.attributes,
+                                                source: para.lines,
+                                                content_model: :compound)
+          parent.blocks[parent.blocks.index(para)] = todo
+        end
+      end
+    end
+
+    class FootnoteBlockInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :footnoteblock
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<footnoteblock>#{out}</footnoteblock>}
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.10.6".freeze
+    VERSION = "1.10.7".freeze
   end
 end

data/spec/asciidoctor/base_spec.rb

@@ -6,39 +6,6 @@ RSpec.describe Asciidoctor::Standoc do
     expect(Metanorma::Standoc::VERSION).not_to be nil
   end
 
-  it "processes a blank document" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-    INPUT
-    output = <<~OUTPUT
-          #{BLANK_HDR}
-      <sections/>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "converts a blank document" do
-    FileUtils.rm_f "test.doc"
-    input = <<~INPUT
-      = Document title
-      Author
-      :docfile: test.adoc
-      :novalid:
-    INPUT
-    output = <<~OUTPUT
-          #{BLANK_HDR}
-      <sections/>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
-      .to be_equivalent_to xmlpp(output)
-    expect(File.exist?("test.doc")).to be true
-    expect(File.exist?("test.pdf")).to be true
-    expect(File.exist?("htmlstyle.css")).to be false
-  end
-
   it "assigns default scripts to major languages" do
     FileUtils.rm_f "test.doc"
     input = <<~INPUT

data/spec/asciidoctor/blank_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Asciidoctor::Standoc do
+  it "processes a blank document" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+    INPUT
+    output = <<~OUTPUT
+          #{BLANK_HDR}
+      <sections/>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "converts a blank document" do
+    FileUtils.rm_f "test.doc"
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :novalid:
+    INPUT
+    output = <<~OUTPUT
+          #{BLANK_HDR}
+      <sections/>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
+      .to be_equivalent_to xmlpp(output)
+    expect(File.exist?("test.doc")).to be true
+    expect(File.exist?("test.pdf")).to be true
+    expect(File.exist?("htmlstyle.css")).to be false
+  end
+end

data/spec/asciidoctor/blocks_spec.rb

@@ -1605,4 +1605,35 @@ RSpec.describe Asciidoctor::Standoc do
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
   end
+
+  it "processes hard breaks" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      [%hardbreaks]
+      One hardbreak
+      Two
+
+      Three hardbreaks +
+      Four
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+            <sections>
+            <p id='_'>
+        One hardbreak
+        <br/>
+         Two
+      </p>
+      <p id='_'>
+        Three hardbreaks
+        <br/>
+         Four
+      </p>
+      </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
 end

data/spec/asciidoctor/cleanup_sections_spec.rb

@@ -1610,7 +1610,7 @@ RSpec.describe Asciidoctor::Standoc do
       == Clause
 
       [.variant-title,type=toc]
-      Clause _A_ stem:[x]
+      Clause _A_ stem:[y]
 
       Text
     INPUT
@@ -1622,8 +1622,8 @@ RSpec.describe Asciidoctor::Standoc do
              <p id='_'>Text</p>
              <clause id='_' inline-header='false' obligation='normative'>
                <title>Subclause</title>
-               <variant-title variant_title='true' type='sub'>&#8220;A&#8221; &#8216;B&#8217;</variant-title>
-               <variant-title variant_title='true' type='toc'>
+               <variant-title type='sub'>&#8220;A&#8221; &#8216;B&#8217;</variant-title>
+               <variant-title type='toc'>
                  Clause
                  <em>A</em>
                  <stem type='MathML'>
@@ -1638,12 +1638,153 @@ RSpec.describe Asciidoctor::Standoc do
          </sections>
          <annex id='_' inline-header='false' obligation='normative'>
            <title>Clause</title>
-           <variant-title variant_title='true' type='toc'>
+           <variant-title type='toc'>
              Clause
              <em>A</em>
              <stem type='MathML'>
                <math xmlns='http://www.w3.org/1998/Math/MathML'>
-                 <mi>x</mi>
+                 <mi>y</mi>
+               </math>
+             </stem>
+           </variant-title>
+           <p id='_'>Text</p>
+         </annex>
+       </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "processes TOC clause" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause
+      Text
+
+      [type=toc]
+      === Table of contents
+
+      Text at the start
+
+      ==== Toc 1
+
+      * <<cl2>>
+      ** <<a1>>
+
+      ==== Toc 2
+
+      * <<cl2,some text>>
+      ** <<a1,some more text>>
+
+      [[cl2]]
+      == Clause2
+
+      [.variant-title,type=toc]
+      Clause _A_ stem:[x]
+
+      [.variant-title,type=sub]
+      "A" 'B'
+
+      Text
+
+      [[a1]]
+      [appendix]
+      == Clause
+
+      [.variant-title,type=toc]
+      Clause _A_ stem:[y]
+
+      Text
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+         <sections>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+             <p id='_'>Text</p>
+             <clause id='_' type='toc' inline-header='false' obligation='normative'>
+               <title>Table of contents</title>
+               <p id='_'>Text at the start</p>
+               <clause id='_' inline-header='false' obligation='normative'>
+                 <title>Toc 1</title>
+                 <toc>
+                   <ul id='_'>
+                     <li>
+                       <p id='_'>
+                         <xref target='cl2'>
+                           Clause 
+                           <em>A</em>
+                           <stem type='MathML'>
+                             <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                               <mi>x</mi>
+                             </math>
+                           </stem>
+                         </xref>
+                       </p>
+                       <ul id='_'>
+                         <li>
+                           <p id='_'>
+                             <xref target='a1'>
+                               Clause 
+                               <em>A</em>
+                               <stem type='MathML'>
+                                 <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                                   <mi>y</mi>
+                                 </math>
+                               </stem>
+                             </xref>
+                           </p>
+                         </li>
+                       </ul>
+                     </li>
+                   </ul>
+                 </toc>
+               </clause>
+               <clause id='_' inline-header='false' obligation='normative'>
+                 <title>Toc 2</title>
+                 <toc>
+                   <ul id='_'>
+                     <li>
+                       <p id='_'>
+                         <xref target='cl2'>some text</xref>
+                       </p>
+                       <ul id='_'>
+                         <li>
+                           <p id='_'>
+                             <xref target='a1'>some more text</xref>
+                           </p>
+                         </li>
+                       </ul>
+                     </li>
+                   </ul>
+                 </toc>
+               </clause>
+             </clause>
+           </clause>
+           <clause id='cl2' inline-header='false' obligation='normative'>
+             <title>Clause2</title>
+             <variant-title type='sub'>&#8220;A&#8221; &#8216;B&#8217;</variant-title>
+             <variant-title type='toc'>
+               Clause 
+               <em>A</em>
+               <stem type='MathML'>
+                 <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                   <mi>x</mi>
+                 </math>
+               </stem>
+             </variant-title>
+             <p id='_'>Text</p>
+           </clause>
+         </sections>
+         <annex id='a1' inline-header='false' obligation='normative'>
+           <title>Clause</title>
+           <variant-title type='toc'>
+             Clause 
+             <em>A</em>
+             <stem type='MathML'>
+               <math xmlns='http://www.w3.org/1998/Math/MathML'>
+                 <mi>y</mi>
                </math>
              </stem>
            </variant-title>

data/spec/asciidoctor/cleanup_spec.rb

@@ -819,7 +819,7 @@ RSpec.describe Asciidoctor::Standoc do
           <abstract format="text/plain" language="en" script="Latn">IEC 60050-103:2009 gives the terminology relative to functions of one or more variables. Together with IEC 60050-102, it covers the mathematical terminology used in the fields of electricity, electronics and telecommunications. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Mathematical symbols are generally in accordance with IEC 60027-1 and ISO 80000-2. This standard cancels and replaces Sections 101-13, 101-14 and 101-15 of International Standard IEC 60050-101:1998. It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
           <status>
             <stage>60</stage>
-            <substage>00</substage>
+            <substage>60</substage>
           </status>
           <copyright>
             <from>2009</from>

data/spec/asciidoctor/inline_spec.rb

@@ -480,4 +480,40 @@ RSpec.describe Asciidoctor::Standoc do
     expect((strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to(output)
   end
+
+  it "processes format-specific inline pass" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      pass-format:rfc,html[<abc>X &gt; Y</abc>]
+    INPUT
+    output = <<~OUTPUT
+       #{BLANK_HDR}
+      <sections>
+      <p id='_'>
+      <passthrough formats='rfc,html'>&lt;abc&gt;X &gt; Y&lt;/abc&gt;</passthrough>
+      </p>
+      </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "processes Metanorma XML inline pass" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      +<abc>X &gt;+ +++Y+++ pass:c[</abc>]
+    INPUT
+    output = <<~OUTPUT
+       #{BLANK_HDR}
+      <sections>
+      <p id='_'>&lt;abc&gt;X &gt; Y &lt;/abc&gt;</p>
+      </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
 end

data/spec/asciidoctor/macros_plantuml_spec.rb

@@ -201,7 +201,7 @@ RSpec.describe Asciidoctor::Standoc do
                   <tr>
                     <th valign='top' align='left'>Name</th>
                     <th valign='top' align='left'>Definition</th>
-                    <th valign='top' align='left'>Mandatory/ Optional/ Conditional</th>
+                    <th valign='top' align='left'>Mandatory / Optional / Conditional</th>
                     <th valign='top' align='left'>Max Occur</th>
                     <th valign='top' align='left'>Data Type</th>
                   </tr>

data/spec/asciidoctor/macros_spec.rb

@@ -1187,7 +1187,7 @@ RSpec.describe Asciidoctor::Standoc do
                   </clause>
                   <clause id='clause1Ab' inline-header='false' obligation='normative'>
                     <title>Clause 1Ab</title>
-                    <variant-title variant_title='true' type='toc'>1Ab Clause</variant-title>
+                    <variant-title type='toc'>1Ab Clause</variant-title>
                   </clause>
                 </clause>
                 <clause id='clause1B' inline-header='false' obligation='normative'>

data/spec/fixtures/datamodel_description_sections_tree.xml

@@ -37,7 +37,7 @@
           <table id='section-EAID_82206E96_8D23_48dd_AC2F_31939C484AF2' width='100%'>
             <name>
               Elements of &#8220;ISO 19135 Procedures for item registration
-              XML::RE_Register&#8221; (class)
+              XML::RE_Register&#8221; (interface)
             </name>
             <tbody>
               <tr>
@@ -288,7 +288,7 @@
                     as its value a set of URI&#8217;s, each referencing
                     information about online resources associated with the
                     register. EXAMPLE
-                    &#239;&#191;&#189;http://www.digest.org/Navigate2.htm&#239;&#191;
+                    &#239;&#191;&#189;http://www.digest.org/Navigate2.htm&#239;&#191;&#189; and &#239;&#191;&#189;http://www.epa.gov/opppmsd1/PPISdata/index.html&#239;&#191;&#189; are sample valuescorresponding value of the attribute 
                     <em>OnLineResource.linkage</em>
                      specifies a resource providing access to the complete
                     content of the register. EXAMPLE
@@ -313,6 +313,7 @@
                 <td colspan='7' valign='top' align='left'>
                   <p id='_'>
                     <tt>count(self.version +self.dateOfLastChange) &gt;= 1</tt>
+                      : ``
                   </p>
                 </td>
               </tr>