metanorma-iso 1.4.3 → 1.5.0

data/spec/isodoc/ref_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
 RSpec.describe IsoDoc do
-  it "processes IsoXML bibliographies" do
-    expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({}).convert("test", <<~"INPUT", true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+   it "processes IsoXML bibliographies (Presentation XML)" do
+     input = <<~INPUT
     <iso-standard xmlns="http://riboseinc.com/isoxml">
     <bibdata>
     <language>en</language>
@@ -120,6 +120,176 @@ RSpec.describe IsoDoc do
 </bibliography>
     </iso-standard>
     INPUT
+    presxml = <<~OUTPUT
+       <iso-standard xmlns='http://riboseinc.com/isoxml'>
+         <bibdata>
+           <language>en</language>
+         </bibdata>
+         <preface>
+           <foreword>
+             <p id='_f06fd0d1-a203-4f3d-a515-0bdba0f8d83f'>
+               <eref bibitemid='ISO712'>ISO 712</eref>
+               <eref bibitemid='ISBN'>[1]</eref>
+               <eref bibitemid='ISSN'>[2]</eref>
+               <eref bibitemid='ISO16634'>ISO 16634:--</eref>
+               <eref bibitemid='ref1'>ICC 167</eref>
+               <eref bibitemid='ref10'>[10]</eref>
+               <eref bibitemid='ref12'>Citn</eref>
+             </p>
+           </foreword>
+         </preface>
+         <bibliography>
+           <references id='_normative_references' obligation='informative' normative='true'>
+            <title depth='1'>1<tab/>Normative References</title>
+             <p>
+               The following documents are referred to in the text in such a way that
+               some or all of their content constitutes requirements of this document.
+               For dated references, only the edition cited applies. For undated
+               references, the latest edition of the referenced document (including any
+               amendments) applies.
+             </p>
+             <bibitem id='ISO712' type='standard'>
+               <title format='text/plain'>Cereals or cereal products</title>
+               <title type='main' format='text/plain'>Cereals and cereal products</title>
+               <docidentifier type='ISO'>ISO 712</docidentifier>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <name>International Organization for Standardization</name>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <bibitem id='ISO16634' type='standard'>
+               <title language='x' format='text/plain'>
+                 Cereals, pulses, milled cereal products, xxxx, oilseeds and animal
+                 feeding stuffs
+               </title>
+               <title language='en' format='text/plain'>Cereals, pulses, milled cereal products, oilseeds and animal feeding stuffs</title>
+               <docidentifier type='ISO'>ISO 16634:-- (all parts)</docidentifier>
+               <date type='published'>
+                 <on>--</on>
+               </date>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <abbreviation>ISO</abbreviation>
+                 </organization>
+               </contributor>
+               <note format='text/plain' reference='1' type='ISO DATE'>Under preparation. (Stage at the time of publication ISO/DIS 16634)</note>
+               <extent type='part'>
+                 <referenceFrom>all</referenceFrom>
+               </extent>
+             </bibitem>
+             <bibitem id='ISO20483' type='standard'>
+               <title format='text/plain'>Cereals and pulses</title>
+               <docidentifier type='ISO'>ISO 20483:2013-2014</docidentifier>
+               <date type='published'>
+                 <from>2013</from>
+                 <to>2014</to>
+               </date>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <name>International Organization for Standardization</name>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <bibitem id='ref1'>
+               <formattedref format='application/x-isodoc+xml'>
+                 <smallcap>Standard No I.C.C 167</smallcap>
+                 .
+                 <em>
+                   Determination of the protein content in cereal and cereal products
+                   for food and animal feeding stuffs according to the Dumas combustion
+                   method
+                 </em>
+                  (see
+                 <link target='http://www.icc.or.at'/>
+                 )
+               </formattedref>
+               <docidentifier type='ICC'>167</docidentifier>
+             </bibitem>
+             <note>
+               <name>NOTE</name>
+               <p>This is an annotation of ISO 20483:2013-2014</p>
+             </note>
+           </references>
+           <references id='_bibliography' obligation='informative' normative='false'>
+             <title depth="1">Bibliography</title>
+             <bibitem id='ISBN' type='ISBN'>
+               <title format='text/plain'>Chemicals for analytical laboratory use</title>
+               <docidentifier type='ISBN'>ISBN</docidentifier>
+               <docidentifier type='metanorma'>[1]</docidentifier>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <abbreviation>ISBN</abbreviation>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <bibitem id='ISSN' type='ISSN'>
+               <title format='text/plain'>Instruments for analytical laboratory use</title>
+               <docidentifier type='ISSN'>ISSN</docidentifier>
+               <docidentifier type='metanorma'>[2]</docidentifier>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <abbreviation>ISSN</abbreviation>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <note>
+               <name>NOTE</name>
+               <p>This is an annotation of document ISSN.</p>
+             </note>
+             <note>
+               <name>NOTE</name>
+               <p>This is another annotation of document ISSN.</p>
+             </note>
+             <bibitem id='ISO3696' type='standard'>
+               <title format='text/plain'>Water for analytical laboratory use</title>
+               <docidentifier type='ISO'>ISO 3696</docidentifier>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <abbreviation>ISO</abbreviation>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <bibitem id='ref10'>
+               <formattedref format='application/x-isodoc+xml'>
+                 <smallcap>Standard No I.C.C 167</smallcap>
+                 .
+                 <em>
+                   Determination of the protein content in cereal and cereal products
+                   for food and animal feeding stuffs according to the Dumas combustion
+                   method
+                 </em>
+                  (see
+                 <link target='http://www.icc.or.at'/>
+                 )
+               </formattedref>
+               <docidentifier type='metanorma'>[10]</docidentifier>
+             </bibitem>
+             <bibitem id='ref11'>
+               <title>Internet Calendaring and Scheduling Core Object Specification (iCalendar)</title>
+               <docidentifier type='IETF'>RFC 10</docidentifier>
+             </bibitem>
+             <bibitem id='ref12'>
+               <formattedref format='application/x-isodoc+xml'>
+                 CitationWorks. 2019.
+                 <em>How to cite a reference</em>
+                 .
+               </formattedref>
+               <docidentifier type='metanorma'>[Citn]</docidentifier>
+               <docidentifier type='IETF'>RFC 20</docidentifier>
+             </bibitem>
+           </references>
+         </bibliography>
+       </iso-standard>
+OUTPUT
+
+html = <<~OUTPUT
     #{HTML_HDR}
              <br/>
              <div>
@@ -136,7 +306,7 @@ RSpec.describe IsoDoc do
              </div>
              <p class="zzSTDTitle1"/>
              <div>
-               <h1>1&#160; Normative references</h1>
+               <h1>1&#160; Normative References</h1>
                <p>The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
                <p id="ISO712" class="NormRef">ISO 712, <i>Cereals and cereal products</i></p>
                <p id="ISO16634" class="NormRef">ISO 16634:-- (all parts)<a class="FootnoteRef" href="#fn:1"><sup>1</sup></a>, <i>Cereals, pulses, milled cereal products, oilseeds and animal feeding stuffs</i></p>
@@ -169,6 +339,8 @@ RSpec.describe IsoDoc do
          </body>
        </html>
     OUTPUT
+    expect(xmlpp(IsoDoc::Iso::PresentationXMLConvert.new({}).convert("test", input, true))).to be_equivalent_to xmlpp(presxml)
+    expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({}).convert("test", presxml, true))).to be_equivalent_to xmlpp(html)
   end
 
 end

data/spec/isodoc/section_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 RSpec.describe IsoDoc do
   it "processes section names" do
-    expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({}).convert("test", <<~"INPUT", true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       <iso-standard xmlns="http://riboseinc.com/isoxml">
       <preface>
       <foreword obligation="informative">
@@ -14,7 +14,7 @@ RSpec.describe IsoDoc do
        </clause>
        <p>This is patent boilerplate</p>
        </introduction></preface><sections>
-       <clause id="D" obligation="normative">
+       <clause id="D" obligation="normative" type="scope">
          <title>Scope</title>
          <p id="E">Text</p>
        </clause>
@@ -68,6 +68,98 @@ RSpec.describe IsoDoc do
        </bibliography>
        </iso-standard>
     INPUT
+
+    presxml = <<~OUTPUT
+     <iso-standard xmlns='http://riboseinc.com/isoxml'>
+   <preface>
+     <foreword obligation='informative'>
+       <title>Foreword</title>
+       <p id='A'>This is a preamble</p>
+     </foreword>
+     <introduction id='B' obligation='informative'>
+     <title depth='1'>0<tab/>Introduction</title>
+       <clause id='C' inline-header='false' obligation='informative'>
+         <title depth='2'>0.1<tab/>Introduction Subsection</title>
+       </clause>
+       <p>This is patent boilerplate</p>
+     </introduction>
+   </preface>
+   <sections>
+     <clause id='D' obligation='normative' type="scope">
+       <title depth='1'>1<tab/>Scope</title>
+       <p id='E'>Text</p>
+     </clause>
+     <clause id='H' obligation='normative'>
+       <title depth='1'>3<tab/>Terms, Definitions, Symbols and Abbreviated Terms</title>
+       <terms id='I' obligation='normative'>
+         <title depth='2'>3.1<tab/>Normal Terms</title>
+         <term id='J'>
+           <name>3.1.1</name>
+           <preferred>Term2</preferred>
+         </term>
+       </terms>
+       <definitions id='K' inline-header='true'>
+         <title>3.2</title>
+         <dl>
+           <dt>Symbol</dt>
+           <dd>Definition</dd>
+         </dl>
+       </definitions>
+     </clause>
+     <definitions id='L'>
+       <title>4</title>
+       <dl>
+         <dt>Symbol</dt>
+         <dd>Definition</dd>
+       </dl>
+     </definitions>
+     <clause id='M' inline-header='false' obligation='normative'>
+       <title depth='1'>5<tab/>Clause 4</title>
+       <clause id='N' inline-header='false' obligation='normative'>
+         <title depth='2'>5.1<tab/>Introduction</title>
+       </clause>
+       <clause id='O' inline-header='false' obligation='normative'>
+         <title depth='2'>5.2<tab/>Clause 4.2</title>
+       </clause>
+     </clause>
+   </sections>
+   <annex id='P' inline-header='false' obligation='normative'>
+     <title>
+       <strong>Annex A</strong>
+       <br/>
+       (normative)
+       <br/>
+       <br/>
+       <strong>Annex</strong>
+     </title>
+     <clause id='Q' inline-header='false' obligation='normative'>
+       <title depth='2'>A.1<tab/>Annex A.1</title>
+       <clause id='Q1' inline-header='false' obligation='normative'>
+         <title depth='3'>A.1.1<tab/>Annex A.1a</title>
+       </clause>
+     </clause>
+     <appendix id='Q2' inline-header='false' obligation='normative'>
+     <title depth='2'>Appendix 1<tab/>An Appendix</title>
+     </appendix>
+     <references id='Q3' normative='false'>
+       <title depth='2'>A.2<tab/>Annex Bibliography</title>
+     </references>
+   </annex>
+   <bibliography>
+     <references id='R' obligation='informative' normative='true'>
+       <title depth='1'>2<tab/>Normative References</title>
+     </references>
+     <clause id='S' obligation='informative'>
+       <title depth='1'>Bibliography</title>
+       <references id='T' obligation='informative' normative='false'>
+         <title depth='2'>Bibliography Subsection</title>
+       </references>
+     </clause>
+   </bibliography>
+ </iso-standard>
+ OUTPUT
+
+    html = <<~OUTPUT
     #{HTML_HDR}
                 <br/>
                 <div>
@@ -88,7 +180,7 @@ RSpec.describe IsoDoc do
                   <p id="E">Text</p>
                 </div>
                 <div>
-                  <h1>2&#160; Normative references</h1>
+                  <h1>2&#160; Normative References</h1>
                 </div>
                 <div id="H"><h1>3&#160; Terms, Definitions, Symbols and Abbreviated Terms</h1>
         <div id="I">
@@ -96,11 +188,13 @@ RSpec.describe IsoDoc do
            <p class="TermNum" id="J">3.1.1</p>
            <p class="Terms" style="text-align:left;">Term2</p>
       
-         </div><div id="K"><h2>3.2&#160; Symbols and abbreviated terms</h2>
+         </div><div id="K"><span class='zzMoveToFollowing'>
+  <b>3.2&#160; </b>
+</span>
            <dl><dt><p>Symbol</p></dt><dd>Definition</dd></dl>
          </div></div>
                 <div id="L" class="Symbols">
-                  <h1>4&#160; Symbols and abbreviated terms</h1>
+                  <h1>4</h1>
                   <dl>
                     <dt>
                       <p>Symbol</p>
@@ -130,7 +224,7 @@ RSpec.describe IsoDoc do
                 <h2>Appendix 1&#160; An Appendix</h2>
                 </div>
                  <div>
-                <h2>A.2&#160; Annex Bibliography</h2>
+                <h2 class="Section3">A.2&#160; Annex Bibliography</h2>
                 </div>
 
                 </div>
@@ -145,74 +239,8 @@ RSpec.describe IsoDoc do
             </body>
         </html>
 OUTPUT
-  end
-
-  it "processes section names (Word)" do
-    expect(xmlpp(IsoDoc::Iso::WordConvert.new({}).convert("test", <<~"INPUT", true).sub(/^.*<body /m, "<body ").sub(%r{</body>.*$}m, "</body>"))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-      <iso-standard xmlns="http://riboseinc.com/isoxml">
-      <preface>
-      <foreword obligation="informative">
-         <title>Foreword</title>
-         <p id="A">This is a preamble</p>
-       </foreword>
-        <introduction id="B" obligation="informative"><title>Introduction</title><clause id="C" inline-header="false" obligation="informative">
-         <title>Introduction Subsection</title>
-       </clause>
-       <p>This is patent boilerplate</p>
-       </introduction></preface><sections>
-       <clause id="D" obligation="normative">
-         <title>Scope</title>
-         <p id="E">Text</p>
-       </clause>
-
-       <clause id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title><terms id="I" obligation="normative">
-         <title>Normal Terms</title>
-         <term id="J">
-         <preferred>Term2</preferred>
-       </term>
-       </terms>
-       <definitions id="K">
-         <dl>
-         <dt>Symbol</dt>
-         <dd>Definition</dd>
-         </dl>
-       </definitions>
-       </clause>
-       <definitions id="L">
-         <dl>
-         <dt>Symbol</dt>
-         <dd>Definition</dd>
-         </dl>
-       </definitions>
-       <clause id="M" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="N" inline-header="false" obligation="normative">
-         <title>Introduction</title>
-       </clause>
-       <clause id="O" inline-header="false" obligation="normative">
-         <title>Clause 4.2</title>
-       </clause></clause>
 
-       </sections><annex id="P" inline-header="false" obligation="normative">
-         <title>Annex</title>
-         <clause id="Q" inline-header="false" obligation="normative">
-         <title>Annex A.1</title>
-         <clause id="Q1" inline-header="false" obligation="normative">
-         <title>Annex A.1a</title>
-         </clause>
-       </clause>
-              <appendix id="Q2" inline-header="false" obligation="normative">
-         <title>An Appendix</title>
-       </appendix>
-       </annex><bibliography><references id="R" obligation="informative" normative="true">
-         <title>Normative References</title>
-       </references><clause id="S" obligation="informative">
-         <title>Bibliography</title>
-         <references id="T" obligation="informative" normative="false">
-         <title>Bibliography Subsection</title>
-       </references>
-       </clause>
-       </bibliography>
-       </iso-standard>
-    INPUT
+    word = <<~OUTPUT
            <body lang="EN-US" link="blue" vlink="#954F72">
              <div class="WordSection1">
                <p>&#160;</p>
@@ -242,7 +270,7 @@ OUTPUT
                  <p id="E">Text</p>
                </div>
                <div>
-                 <h1>2<span style="mso-tab-count:1">&#160; </span>Normative references</h1>
+                 <h1>2<span style="mso-tab-count:1">&#160; </span>Normative References</h1>
                </div>
                <div id="H"><h1>3<span style="mso-tab-count:1">&#160; </span>Terms, Definitions, Symbols and Abbreviated Terms</h1>
        <div id="I">
@@ -250,11 +278,17 @@ OUTPUT
           <p class="TermNum" id="J">3.1.1</p>
           <p class="Terms" style="text-align:left;">Term2</p>
 
-        </div><div id="K"><h2>3.2<span style="mso-tab-count:1">&#160; </span>Symbols and abbreviated terms</h2>
+        </div><div id="K">
+<span class='zzMoveToFollowing'>
+  <b>
+    3.2
+    <span style='mso-tab-count:1'>&#160; </span>
+  </b>
+</span>
           <table class="dl"><tr><td valign="top" align="left"><p align="left" style="margin-left:0pt;text-align:left;">Symbol</p></td><td valign="top">Definition</td></tr></table>
         </div></div>
                <div id="L" class="Symbols">
-                 <h1>4<span style="mso-tab-count:1">&#160; </span>Symbols and abbreviated terms</h1>
+                 <h1>4</h1>
                  <table class="dl">
                    <tr>
                      <td valign="top" align="left">
@@ -284,6 +318,13 @@ OUTPUT
         </div>
                  <div id="Q2">
           <h2>Appendix 1<span style="mso-tab-count:1">&#160; </span>An Appendix</h2>
+          </div>
+<div>
+  <h2 class='Section3'>
+    A.2
+    <span style='mso-tab-count:1'>&#160; </span>
+    Annex Bibliography
+</h2>
         </div>
                </div>
                <p><br clear="all" style="mso-special-character:line-break;page-break-before:always"/></p>
@@ -298,10 +339,13 @@ OUTPUT
              <div class="colophon"/>
            </body>
 OUTPUT
+    expect(xmlpp(IsoDoc::Iso::PresentationXMLConvert.new({}).convert("test", input, true))).to be_equivalent_to xmlpp(presxml)
+    expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({}).convert("test", presxml, true))).to be_equivalent_to xmlpp(html)
+    expect(xmlpp(IsoDoc::Iso::WordConvert.new({}).convert("test", presxml, true).sub(/^.*<body /m, "<body ").sub(%r{</body>.*$}m, "</body>"))).to be_equivalent_to xmlpp(word)
   end
 
     it "processes subclauses with and without titles" do
-    expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({}).convert("test", <<~"INPUT", true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      input = <<~INPUT
       <iso-standard xmlns="http://riboseinc.com/isoxml">
        <sections>
        <clause id="D" obligation="normative">
@@ -315,6 +359,24 @@ OUTPUT
        </sections>
        </iso-standard>
 INPUT
+
+presxml = <<~OUTPUT
+<iso-standard xmlns='http://riboseinc.com/isoxml'>
+  <sections>
+    <clause id='D' obligation='normative'>
+      <title depth='1'>1<tab/>Scope</title>
+      <clause id='D1' obligation='normative'>
+        <title depth='2'>1.1<tab/>Scope 1</title>
+      </clause>
+      <clause id='D2' obligation='normative' inline-header="true">
+        <title>1.2</title>
+      </clause>
+    </clause>
+  </sections>
+</iso-standard>
+OUTPUT
+
+html = <<~OUTPUT
 <html xmlns:epub='http://www.idpf.org/2007/ops' lang='en'>
   <head/>
   <body lang='en'>
@@ -343,6 +405,8 @@ INPUT
   </body>
 </html>
 OUTPUT
+    expect(xmlpp(IsoDoc::Iso::PresentationXMLConvert.new({}).convert("test", input, true))).to be_equivalent_to xmlpp(presxml)
+    expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({}).convert("test", presxml, true))).to be_equivalent_to xmlpp(html)
     end
 
   it "processes simple terms & definitions" do
@@ -350,7 +414,7 @@ OUTPUT
                <iso-standard xmlns="http://riboseinc.com/isoxml">
        <sections>
        <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
-         <term id="J">
+         <term id="J"><name>1.1</name>
          <preferred>Term2</preferred>
        </term>
         </terms>
@@ -359,7 +423,7 @@ OUTPUT
     INPUT
     #{HTML_HDR}
                <p class="zzSTDTitle1"/>
-               <div id="H"><h1>1&#160; Terms, Definitions, Symbols and Abbreviated Terms</h1>
+               <div id="H"><h1>Terms, Definitions, Symbols and Abbreviated Terms</h1>
        <p class="TermNum" id="J">1.1</p>
          <p class="Terms" style="text-align:left;">Term2</p>
        </div>
@@ -378,6 +442,7 @@ OUTPUT
        </clause>
        <clause id="O" inline-header="true" obligation="normative">
          <title>Clause 4.2</title>
+         <p>Hello</p>
        </clause></clause>
 
        </sections>
@@ -386,12 +451,13 @@ OUTPUT
     #{HTML_HDR}
                <p class="zzSTDTitle1"/>
                <div id="M">
-                 <h1>1&#160; Clause 4</h1>
+                 <h1>Clause 4</h1>
                  <div id="N">
-          <h2>1.1&#160; Introduction</h2>
+          <h2>Introduction</h2>
         </div>
                  <div id="O">
-          <span class="zzMoveToFollowing"><b>1.2&#160; Clause 4.2&#160; </b></span>
+          <span class="zzMoveToFollowing"><b>Clause 4.2&#160; </b></span>
+          <p>Hello</p>
         </div>
                </div>
              </div>