single base tag in metanorma: metanorma/metanorma#440

metanorma · Feb 4, 2025 · 4b9f957 · 4b9f957
1 parent 247ee9f
commit 4b9f957
Show file tree

Hide file tree

Showing 10 changed files with 946 additions and 948 deletions.
diff --git a/Gemfile.devel b/Gemfile.devel
@@ -0,0 +1 @@
+gem "metanorma-standoc", git: "https://github.com/metanorma/metanorma-standoc", branch: "fix/single-root-tag"
diff --git a/lib/metanorma/ieee/ieee.rng b/lib/metanorma/ieee/ieee.rng
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns='https://www.metanorma.org/ns/ieee' xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
   <!--
     VERSION v1.2.1
     Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
@@ -8,9 +8,6 @@
   -->
   <include href="relaton-ieee.rng"/>
   <include href="isodoc.rng">
-    <start>
-      <ref name="ieee-standard"/>
-    </start>
     <define name="sections">
       <element name="sections">
         <optional>
@@ -27,31 +24,31 @@
         </oneOrMore>
       </element>
     </define>
+    <define name="standard-document">
+      <element name="metanorma">
+        <ref name="Root-Attributes"/>
+        <ref name="bibdata"/>
+        <zeroOrMore>
+          <ref name="termdocsource"/>
+        </zeroOrMore>
+        <optional>
+          <ref name="misccontainer"/>
+        </optional>
+        <optional>
+          <ref name="boilerplate"/>
+        </optional>
+        <ref name="preface"/>
+        <oneOrMore>
+          <ref name="sections"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="annex"/>
+        </zeroOrMore>
+        <ref name="bibliography"/>
+        <zeroOrMore>
+          <ref name="indexsect"/>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
-  <define name="ieee-standard">
-    <element name="ieee-standard">
-      <ref name="Root-Attributes"/>
-      <ref name="bibdata"/>
-      <zeroOrMore>
-        <ref name="termdocsource"/>
-      </zeroOrMore>
-      <optional>
-        <ref name="misccontainer"/>
-      </optional>
-      <optional>
-        <ref name="boilerplate"/>
-      </optional>
-      <ref name="preface"/>
-      <oneOrMore>
-        <ref name="sections"/>
-      </oneOrMore>
-      <zeroOrMore>
-        <ref name="annex"/>
-      </zeroOrMore>
-      <ref name="bibliography"/>
-      <zeroOrMore>
-        <ref name="indexsect"/>
-      </zeroOrMore>
-    </element>
-  </define>
 </grammar>
diff --git a/lib/metanorma/ieee/isodoc.rng b/lib/metanorma/ieee/isodoc.rng
@@ -1208,7 +1208,7 @@ numbers</a:documentation>
   </define>
   <define name="standard-document">
     <a:documentation>Representation of a standardisation document</a:documentation>
-    <element name="standard-document">
+    <element name="metanorma">
       <ref name="Root-Attributes"/>
       <ref name="bibdata">
         <a:documentation>Bibliographic description of the document itself, expressed in the Relaton model</a:documentation>

diff --git a/spec/metanorma/base_spec.rb b/spec/metanorma/base_spec.rb
@@ -17,7 +17,7 @@
     output = <<~OUTPUT
       #{@blank_hdr}
       <sections/>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     expect(Xml::C14n.format(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to Xml::C14n.format(output)
@@ -33,7 +33,7 @@
     output = <<~OUTPUT
         #{@blank_hdr}
         <sections/>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     expect(Xml::C14n.format(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to Xml::C14n.format(output)
@@ -672,7 +672,7 @@
                <indexsect id='_' type='thematic'>
                  <title>Thematic Index</title>
                </indexsect>
-             </ieee-standard>
+             </metanorma>
     OUTPUT
     expect(Xml::C14n.format(strip_guid(Asciidoctor.convert(input, *OPTIONS)
       .sub(%r{<boilerplate>.*</boilerplate>}m, ""))))
@@ -924,7 +924,7 @@
                <indexsect id='_' type='thematic'>
                  <title>Thematic Index</title>
                </indexsect>
-             </ieee-standard>
+             </metanorma>
     OUTPUT
     expect(Xml::C14n.format(strip_guid(Asciidoctor.convert(input, *OPTIONS)
       .sub(%r{<boilerplate>.*</boilerplate>}m, ""))))

diff --git a/spec/metanorma/cleanup_spec.rb b/spec/metanorma/cleanup_spec.rb
@@ -668,13 +668,13 @@
       == Clause 1
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
         <sections>
           <clause id='_' inline-header='false' obligation='normative'>
             <title>Clause 1</title>
           </clause>
         </sections>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.xpath("//xmlns:bibdata | //xmlns:metanorma-extension").each(&:remove)
@@ -710,7 +710,7 @@
       * [[[ABC,DEF]]]
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
              <preface>
          <introduction id='_' obligation='informative'>
            <title>Introduction</title>
@@ -755,7 +755,7 @@
            </bibitem>
          </references>
        </bibliography>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.at("//xmlns:bibdata").remove
@@ -780,7 +780,7 @@
 
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
          <sections>
            <note id='boilerplate_front' type="boilerplate">
              <p id='_'>
@@ -829,7 +829,7 @@
              <title>Clause</title>
            </clause>
          </sections>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.at("//xmlns:bibdata").remove
@@ -855,7 +855,7 @@
       * [[[ABC,DEF]]]
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
          <sections> </sections>
          <annex id='_' inline-header='false' obligation='normative'>
            <title>Appendix C</title>
@@ -868,7 +868,7 @@
              </bibitem>
            </references>
          </annex>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.at("//xmlns:bibdata").remove
@@ -896,7 +896,7 @@
 
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
                <sections>
            <clause id='_' type='overview' inline-header='false' obligation='normative'>
              <title>Overview</title>
@@ -917,7 +917,7 @@
              <title>Overview</title>
            </clause>
          </sections>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.at("//xmlns:bibdata").remove
@@ -950,7 +950,7 @@
 
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
          <sections>
            <clause id='_' type='overview' inline-header='false' obligation='normative'>
              <title>Overview</title>
@@ -983,7 +983,7 @@
              <title>Overview</title>
            </clause>
          </sections>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.at("//xmlns:bibdata").remove
@@ -1383,7 +1383,7 @@
       Text
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
          <preface>
            <abstract id='_'>
              <title>Abstract</title>
@@ -1424,7 +1424,7 @@
              </clause>
            </clause>
          </sections>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     ret = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     ret.xpath("//xmlns:bibdata | //xmlns:metanorma-extension").each(&:remove)

diff --git a/spec/metanorma/processor_spec.rb b/spec/metanorma/processor_spec.rb
@@ -7,7 +7,7 @@
   processor = registry.find_processor(:ieee)
 
   inputxml = <<~INPUT
-      <ieee-standard xmlns="http://riboseinc.com/isoxml">
+      <metanorma xmlns="http://riboseinc.com/isoxml">
       <sections>
         <terms id="H" obligation="normative" displayorder="1"><fmt-title>Terms</fmt-title>
           <term id="J">
@@ -17,7 +17,7 @@
         </terms>
         <preface/>
       </sections>
-    </ieee-standard>
+    </metanorma>
   INPUT
 
   it "registers against metanorma" do
@@ -41,7 +41,7 @@
     output = <<~OUTPUT
         #{blank_hdr_gen}
         <sections/>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     expect(Xml::C14n.format(strip_guid(processor.input_to_isodoc(input, nil))))
       .to be_equivalent_to Xml::C14n.format(output)

diff --git a/spec/metanorma/refs_spec.rb b/spec/metanorma/refs_spec.rb
@@ -180,7 +180,7 @@
 
       INPUT
       output = <<~OUTPUT
-            <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+            <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
            <sections/>
            <bibliography>
             <references id="_" normative="false" obligation="informative">
@@ -411,7 +411,7 @@
               </bibitem>
             </references>
           </bibliography>
-        </ieee-standard>
+        </metanorma>
       OUTPUT
       out = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
       out.xpath("//xmlns:bibdata | //xmlns:boilerplate | //xmlns:note | " \
@@ -467,7 +467,7 @@
         * [[[ref3,IEEE 802.1D-1990]]] REF2
       INPUT
       output = <<~OUTPUT
-          <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+          <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
                    <preface>
             <introduction id='_' obligation='informative'>
               <title>Introduction</title>
@@ -514,7 +514,7 @@
             </p>
           </annex>
           <bibliography/>
-        </ieee-standard>
+        </metanorma>
       OUTPUT
       out = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
       out.xpath("//xmlns:bibdata | //xmlns:boilerplate | " \
@@ -955,7 +955,7 @@
              </bibitem>
            </references>
          </bibliography>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     expect(Xml::C14n.format(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to Xml::C14n.format(output)

diff --git a/spec/metanorma/terms_spec.rb b/spec/metanorma/terms_spec.rb
@@ -22,7 +22,7 @@
       <<ISO2191,section=1>>,
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
                <sections>
            <terms id='_' obligation='normative'>
              <title>Definitions</title>
@@ -86,7 +86,7 @@
              </term>
            </terms>
          </sections>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     out = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     out.xpath("//xmlns:bibdata | //xmlns:boilerplate | //xmlns:references | " \
@@ -136,7 +136,7 @@
 
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
          <sections>
            <terms id='_' obligation='normative'>
              <title>Definitions</title>
@@ -263,7 +263,7 @@
              </term>
            </terms>
          </sections>
-       </ieee-standard>
+       </metanorma>
     OUTPUT
     out = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     out.xpath("//xmlns:bibdata | //xmlns:boilerplate | //xmlns:references | " \
@@ -284,7 +284,7 @@
       symbol:[thing1]
     INPUT
     output = <<~OUTPUT
-      <ieee-standard xmlns='https://www.metanorma.org/ns/ieee' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
+      <metanorma xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Ieee::VERSION}'>
         <sections>
           <terms id='_' obligation='normative'>
             <title>Definitions</title>
@@ -329,7 +329,7 @@
             </term>
           </terms>
         </sections>
-      </ieee-standard>
+      </metanorma>
     OUTPUT
     out = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
     out.xpath("//xmlns:bibdata | //xmlns:boilerplate | //xmlns:references | " \
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		gem "metanorma-standoc", git: "https://github.com/metanorma/metanorma-standoc", branch: "fix/single-root-tag"