metanorma-standoc 1.10.5 → 1.11.0

data/spec/asciidoctor/macros_spec.rb

@@ -4,9 +4,10 @@ RSpec.describe Asciidoctor::Standoc do
   it "processes the Asciidoctor::Standoc inline macros" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
+      preferred:[term0]
       alt:[term1]
-      deprecated:[term1]
-      domain:[term1]
+      deprecated:[term2]
+      domain:[term3]
       inherit:[<<ref1>>]
       autonumber:table[3]
       add:[a <<clause>>] del:[B]
@@ -20,9 +21,10 @@ RSpec.describe Asciidoctor::Standoc do
       <preface>
           <foreword id='_' obligation='informative'>
           <title>Foreword</title>
-          <admitted>term1</admitted>
-          <deprecates>term1</deprecates>
-          <domain>term1</domain>
+          <preferred><expression><name>term0</name></expression></preferred>
+          <admitted><expression><name>term1</name></expression></admitted>
+          <deprecates><expression><name>term2</name></expression></deprecates>
+          <domain>term3</domain>
           <inherit>
             <eref type='inline' bibitemid='ref1' citeas='XYZ 123'/>
           </inherit>
@@ -161,9 +163,10 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "processes the Asciidoctor::Standoc concept macros" do
+  it "processes the Asciidoctor::Standoc concept and related macros" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
+
       {{clause1}}
       term:[clause1]
       {{clause1,w\[o\]rd}}
@@ -175,7 +178,10 @@ RSpec.describe Asciidoctor::Standoc do
       term:[blah,word]
       {{blah,term,word}}
       {{blah,term,word,xref}}
-      {{blah,term,word,xref,option="noital,noref"}}
+      {{blah,term,word,xref,options="noital,noref,nolinkmention,nolinkref"}}
+      {{blah,term,word,xref,options="ital,ref,linkmention,linkref"}}
+
+      related:contrast[blah]
 
       [[clause1]]
       == Clause
@@ -283,7 +289,7 @@ RSpec.describe Asciidoctor::Standoc do
                    <tt>blah</tt>
                  </strong>
                </concept>
-               <concept ital='false' ref='false'>
+               <concept ital='false' ref='false' linkmention='false' linkref='false'>
                  <strong>
                    term
                    <tt>blah</tt>
@@ -293,7 +299,25 @@ RSpec.describe Asciidoctor::Standoc do
                    <tt>blah</tt>
                  </strong>
                </concept>
-          </p>
+               <concept ital='true' ref='true' linkmention='true' linkref='true'>
+                 <strong>
+                   term
+                   <tt>blah</tt>
+                   , display
+                   <tt>term</tt>
+                    not resolved via ID
+                   <tt>blah</tt>
+                 </strong>
+               </concept>
+               </p>
+      <related type='contrast'>
+        <strong>
+          term
+          <tt>blah</tt>
+           not resolved via ID
+          <tt>blah</tt>
+        </strong>
+      </related>
         </foreword>
       </preface>
       <sections>
@@ -311,20 +335,23 @@ RSpec.describe Asciidoctor::Standoc do
   it "processes the Asciidoctor::Standoc concept macros for acronyms" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
+
       {{Clause1}}
       {{Clause1,Clause 1}}
       {{Clause 2}}
       {{Clause 2,Clause 1}}
       {{<<Clause2>>,Clause 2}}
+
       symbol:[Clause1]
       symbol:[Clause1,word]
       symbol:[Clause 2]
       symbol:[Clause 2,word]
+
       {{<<Clause2>>,word}}
       {{<<Clause2>>,word,term}}
       {{<<Clause2>>,word,term,xref}}
-      {{<<Clause2>>,word,term,xref,option="noital,noref"}}
-      {{<<Clause2>>,word,term,xref,option="ital,ref"}}
+      {{<<Clause2>>,word,term,xref,options="noital,noref,nolinkmention,nolinkref"}}
+      {{<<Clause2>>,word,term,xref,options="ital,ref,linkmention,linkref"}}
 
       == Terms and definitions
       === Clause1
@@ -363,6 +390,7 @@ RSpec.describe Asciidoctor::Standoc do
                  <renderterm>Clause 2</renderterm>
                  <xref target='Clause2'/>
                </concept>
+               </p><p id="_">
                <concept>
                  <refterm>Clause1</refterm>
                  <renderterm>Clause1</renderterm>
@@ -383,6 +411,7 @@ RSpec.describe Asciidoctor::Standoc do
                  <renderterm>word</renderterm>
                  <xref target='Clause2'/>
                </concept>
+               </p><p id="_">
                <concept>
                  <refterm>word</refterm>
                  <renderterm>word</renderterm>
@@ -398,12 +427,12 @@ RSpec.describe Asciidoctor::Standoc do
                  <renderterm>term</renderterm>
                  <xref target='Clause2'>xref</xref>
                </concept>
-                <concept ital='false' ref='false'>
+                <concept ital='false' ref='false' linkmention='false' linkref='false'>
                   <refterm>word</refterm>
                   <renderterm>term</renderterm>
                   <xref target='Clause2'>xref</xref>
                 </concept>
-                <concept ital='true' ref='true'>
+                <concept ital='true' ref='true' linkmention='true' linkref='true'>
                  <refterm>word</refterm>
                  <renderterm>term</renderterm>
                  <xref target='Clause2'>xref</xref>
@@ -416,7 +445,7 @@ RSpec.describe Asciidoctor::Standoc do
                    <title>Terms and definitions</title>
                    <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
                    <term id='term-clause1'>
-                     <preferred>Clause1</preferred>
+                     <preferred><expression><name>Clause1</name></expression></preferred>
                    </term>
                  </terms>
                  <definitions id='_' obligation='normative'>
@@ -439,7 +468,7 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "processes the concept macros with xrefs" do
+  it "processes the concept and related macros with xrefs" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       {{<<clause1>>}}
@@ -447,6 +476,8 @@ RSpec.describe Asciidoctor::Standoc do
       {{<<clause1>>,term,w\[o\]rd}}
       {{<<clause1>>,term,w\[o\]rd,Clause #1}}
 
+      related:supersedes[<<clause1>>,term]
+
       [[clause1]]
       == Clause
       Terms are defined here
@@ -476,6 +507,14 @@ RSpec.describe Asciidoctor::Standoc do
                  <xref target='clause1'>Clause #1</xref>
                </concept>
              </p>
+                   <related type='supersedes'>
+        <preferred>
+          <expression>
+            <name>term</name>
+          </expression>
+        </preferred>
+        <xref target='clause1'/>
+      </related>
            </foreword>
       </preface>
       <sections>
@@ -490,7 +529,7 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "processes the concept macros with erefs" do
+  it "processes the concept and related macros with erefs" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       {{<<blah>>}}
@@ -504,6 +543,8 @@ RSpec.describe Asciidoctor::Standoc do
       {{<<blah,clause=3.1,figure=a>>,word}}
       {{<<blah,clause=3.1,figure=a>>,term,word,Clause #1}}
 
+      related:narrower[<<blah,clause=3.1,figure=a>>,term]
+
       [bibliography]
       == Bibliography
       * [[[blah,blah]]] _Blah_
@@ -605,6 +646,23 @@ RSpec.describe Asciidoctor::Standoc do
                  </eref>
                </concept>
              </p>
+                   <related type='narrower'>
+        <preferred>
+          <expression>
+            <name>term</name>
+          </expression>
+        </preferred>
+        <eref bibitemid='blah'>
+          <localityStack>
+            <locality type='clause'>
+              <referenceFrom>3.1</referenceFrom>
+            </locality>
+            <locality type='figure'>
+              <referenceFrom>a</referenceFrom>
+            </locality>
+          </localityStack>
+        </eref>
+      </related>
            </foreword>
          </preface>
          <sections> </sections>
@@ -625,39 +683,49 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "processes the concept macros with termbase" do
+  it "processes the concept and related macros with termbase" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       {{<<IEV:135-13-13>>}}
       {{<<IEV:135-13-13>>,word}}
       {{<<IEV:135-13-13>>,term,word}}
       {{<<IEV:135-13-13>>,term,word,Clause #1}}
+
+      related:see[<<IEV:135-13-13>>,term]
     INPUT
     output = <<~OUTPUT
-            #{BLANK_HDR}
-            <sections>
-        <p id='_'>
-             <concept>
-               <termref base='IEV' target='135-13-13'/>
-             </concept>
-             <concept>
-               <refterm>word</refterm>
-               <renderterm>word</renderterm>
-               <termref base='IEV' target='135-13-13'/>
-             </concept>
-             <concept>
-               <refterm>term</refterm>
-               <renderterm>word</renderterm>
-               <termref base='IEV' target='135-13-13'/>
-             </concept>
-             <concept>
-               <refterm>term</refterm>
-               <renderterm>word</renderterm>
-               <termref base='IEV' target='135-13-13'>Clause #1</termref>
-             </concept>
-        </p>
-      </sections>
-          </standard-document>
+      #{BLANK_HDR}
+        <sections>
+              <p id='_'>
+                   <concept>
+                     <termref base='IEV' target='135-13-13'/>
+                   </concept>
+                   <concept>
+                     <refterm>word</refterm>
+                     <renderterm>word</renderterm>
+                     <termref base='IEV' target='135-13-13'/>
+                   </concept>
+                   <concept>
+                     <refterm>term</refterm>
+                     <renderterm>word</renderterm>
+                     <termref base='IEV' target='135-13-13'/>
+                   </concept>
+                   <concept>
+                     <refterm>term</refterm>
+                     <renderterm>word</renderterm>
+                     <termref base='IEV' target='135-13-13'>Clause #1</termref>
+                   </concept>
+              </p>
+          <related type='see'>
+            <preferred>
+              <expression>
+                <name>term</name>
+              </expression>
+            </preferred>
+            <termref base='IEV' target='135-13-13'/>
+          </related>
+        </sections>
+      </standard-document>
     OUTPUT
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
@@ -678,7 +746,7 @@ RSpec.describe Asciidoctor::Standoc do
         <definitions id='clause1' obligation='normative'>
           <title>Symbols and abbreviated terms</title>
           <dl id='_'>
-            <dt id='symbol-_-_x_-'>
+            <dt id='symbol-_-__x230a_x__x230b_-'>
               <stem type='MathML'>
                 <math xmlns='http://www.w3.org/1998/Math/MathML'>
                   <mo>&#8970;</mo>
@@ -700,7 +768,7 @@ RSpec.describe Asciidoctor::Standoc do
                  function.
               </p>
             </dd>
-            <dt id='symbol-_-_x_--1'>
+            <dt id='symbol-_-__x2308_x__x2309_-'>
               <stem type='MathML'>
                 <math xmlns='http://www.w3.org/1998/Math/MathML'>
                   <mo>&#8968;</mo>
@@ -1073,7 +1141,7 @@ RSpec.describe Asciidoctor::Standoc do
     output = <<~OUTPUT
         #{BLANK_HDR}
         <sections>
-        <form id='_' name='N1' action='/action_page.php' class="checkboxes">
+        <form id='N0' name='N1' action='/action_page.php' class="checkboxes">
         <p id='_'>
           <label for='fname'>First name:</label>
           <br/>
@@ -1176,7 +1244,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'>
@@ -1256,6 +1324,8 @@ RSpec.describe Asciidoctor::Standoc do
         term:[name,name2] is a term
 
         {{name,name2}} is a term
+
+        related:equivalent[name]
       XML
     end
     let(:output) do
@@ -1266,7 +1336,7 @@ RSpec.describe Asciidoctor::Standoc do
             <title>Terms and definitions</title>
             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
             <term id='term-name'>
-              <preferred>name</preferred>
+              <preferred><expression><name>name</name></expression></preferred>
             </term>
           </terms>
           <clause id='_' inline-header='false' obligation='normative'>
@@ -1287,6 +1357,14 @@ RSpec.describe Asciidoctor::Standoc do
             </concept>
              is a term
             </p>
+          <related type='equivalent'>
+          <preferred>
+          <expression>
+            <name>name</name>
+          </expression>
+        </preferred>
+          <xref target='term-name'>name</xref>
+          </related>
           </clause>
         </sections>
         </standard-document>
@@ -1321,7 +1399,7 @@ RSpec.describe Asciidoctor::Standoc do
               <title>Terms and definitions</title>
               <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
               <term id='term-name'>
-                <preferred>name</preferred>
+                <preferred><expression><name>name</name></expression></preferred>
               </term>
             </terms>
             <clause id='_' inline-header='false' obligation='normative'>
@@ -1385,10 +1463,10 @@ RSpec.describe Asciidoctor::Standoc do
               <title>Terms and definitions</title>
               <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
               <term id='term-name-1'>
-                 <preferred>name</preferred>
+                 <preferred><expression><name>name</name></expression></preferred>
               </term>
               <term id='term-name2-1'>
-                <preferred>name2</preferred>
+                <preferred><expression><name>name2</name></expression></preferred>
               </term>
             </terms>
             <clause id='term-name' inline-header='false' obligation='normative'>
@@ -1460,83 +1538,93 @@ RSpec.describe Asciidoctor::Standoc do
           {{name identity}} is a term
 
           Moreover, {{missing}} is a term
+
+          related:equivalent[missing]
         XML
       end
       let(:output) do
         <<~XML
-             #{BLANK_HDR}
-                    <sections>
-              <terms id='_' obligation='normative'>
-                <title>Terms and definitions</title>
-                <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
-                <term id='term-name-identity'>
-                  <preferred>name identity</preferred>
-                </term>
-                <term id='name-check'>
-                  <preferred>name check</preferred>
-                  <definition>
-                    <p id='_'>paragraph</p>
-                    <p id='_'>
-                      <concept>
-                        <refterm>name check</refterm>
-                        <renderterm>name check</renderterm>
-                        <xref target='name-check'/>
-                      </concept>
-                       is a term
-                    </p>
-                    <p id='_'>
-                      <concept>
-                        <refterm>name identity</refterm>
-                        <renderterm>name identity</renderterm>
-                        <xref target='term-name-identity'/>
-                      </concept>
-                       is a term
-                    </p>
-                    <p id='_'>
-                      Moreover,
-                      <concept>
-                        <strong>
-                          term
-                          <tt>missing</tt>
-                           not resolved via ID
-                          <tt>missing</tt>
-                        </strong>
-                      </concept>
-                       is a term
-                    </p>
-                    <p id='_'>
-                      <concept>
-                        <refterm>name check</refterm>
-                        <renderterm>name check</renderterm>
-                        <xref target='name-check'/>
-                      </concept>
-                       is a term
-                    </p>
-                    <p id='_'>
-                      <concept>
-                        <refterm>name identity</refterm>
-                        <renderterm>name identity</renderterm>
-                        <xref target='term-name-identity'/>
-                      </concept>
-                       is a term
-                    </p>
-                    <p id='_'>
-                      Moreover,
-                      <concept>
-                        <strong>
-                          term
-                          <tt>missing</tt>
-                           not resolved via ID
-                          <tt>missing</tt>
-                        </strong>
-                      </concept>
-                       is a term
-                    </p>
-                  </definition>
-                </term>
-              </terms>
-            </sections>
-          </standard-document>
+               #{BLANK_HDR}
+                      <sections>
+                <terms id='_' obligation='normative'>
+                  <title>Terms and definitions</title>
+                  <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
+                  <term id='term-name-identity'>
+                    <preferred><expression><name>name identity</name></expression></preferred>
+                  </term>
+                  <term id='name-check'>
+                    <preferred><expression><name>name check</name></expression></preferred>
+          <related type='equivalent'>
+            <strong>
+              term
+              <tt>missing</tt>
+               not resolved via ID
+              <tt>missing</tt>
+            </strong>
+          </related>
+                    <definition><verbaldefinition>
+                      <p id='_'>paragraph</p>
+                      <p id='_'>
+                        <concept>
+                          <refterm>name check</refterm>
+                          <renderterm>name check</renderterm>
+                          <xref target='name-check'/>
+                        </concept>
+                         is a term
+                      </p>
+                      <p id='_'>
+                        <concept>
+                          <refterm>name identity</refterm>
+                          <renderterm>name identity</renderterm>
+                          <xref target='term-name-identity'/>
+                        </concept>
+                         is a term
+                      </p>
+                      <p id='_'>
+                        Moreover,
+                        <concept>
+                          <strong>
+                            term
+                            <tt>missing</tt>
+                             not resolved via ID
+                            <tt>missing</tt>
+                          </strong>
+                        </concept>
+                         is a term
+                      </p>
+                      <p id='_'>
+                        <concept>
+                          <refterm>name check</refterm>
+                          <renderterm>name check</renderterm>
+                          <xref target='name-check'/>
+                        </concept>
+                         is a term
+                      </p>
+                      <p id='_'>
+                        <concept>
+                          <refterm>name identity</refterm>
+                          <renderterm>name identity</renderterm>
+                          <xref target='term-name-identity'/>
+                        </concept>
+                         is a term
+                      </p>
+                      <p id='_'>
+                        Moreover,
+                        <concept>
+                          <strong>
+                            term
+                            <tt>missing</tt>
+                             not resolved via ID
+                            <tt>missing</tt>
+                          </strong>
+                        </concept>
+                         is a term
+                      </p>
+                    </verbaldefinition></definition>
+                  </term>
+                </terms>
+              </sections>
+            </standard-document>
         XML
       end
 
@@ -1600,44 +1688,44 @@ RSpec.describe Asciidoctor::Standoc do
         [lutaml_uml_datamodel_description,#{example_file}]
         --
         [.diagram_include_block, base_path="requirements/"]
-        ...
+        .....
         Diagram text
-        ...
+        .....
 
         [.include_block, package="Another", base_path="spec/fixtures/"]
-        ...
+        .....
         my text
-        ...
+        .....
 
         [.include_block, base_path="spec/fixtures/"]
-        ...
+        .....
         my text
-        ...
+        .....
 
         [.before]
-        ...
+        .....
         mine text
-        ...
+        .....
 
         [.before, package="Another"]
-        ...
+        .....
         text before Another package
-        ...
+        .....
 
         [.after, package="Another"]
-        ...
+        .....
         text after Another package
-        ...
+        .....
 
         [.after, package="CityGML"]
-        ...
+        .....
         text after CityGML package
-        ...
+        .....
 
         [.after]
-        ...
+        .....
         footer text
-        ...
+        .....
         --
       TEXT
     end