Rename "contentsTree" element to "contents"

ulm · ulm · commit 754d52d8106c · 2024-11-09T07:56:59.000+01:00
For consistency; this was the only element using camelCase.

Signed-off-by: Ulrich Müller &lt;ulm@gentoo.org&gt;
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml
@@ -125,7 +125,7 @@ tag. Note that the trailing slash in the <c>href</c> value is mandatory.
 </p>
 
 <p>
-A table of contents can be generated with <c>&lt;contentsTree&gt;</c>.
+A table of contents can be generated with <c>&lt;contents/&gt;</c>.
 Typically, this would be the only element in its own section body, as in
 the following example:
 </p>
@@ -134,7 +134,7 @@ the following example:
 &lt;section&gt;
 &lt;title&gt;Contents&lt;/title&gt;
 &lt;body&gt;
-&lt;contentsTree/&gt;
+&lt;contents/&gt;
 &lt;/body&gt;
 &lt;/section&gt;
 </codesample>
diff --git a/appendices/editor-configuration/text.xml b/appendices/editor-configuration/text.xml
@@ -14,7 +14,7 @@ with ebuilds.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/appendices/text.xml b/appendices/text.xml
@@ -12,7 +12,7 @@ This section incorporates various auxiliary documents which may be useful as a r
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/appendices/todo-list/text.xml b/appendices/todo-list/text.xml
@@ -7,7 +7,7 @@
 This TODO list is automatically generated from the <c>&lt;todo&gt;</c> directives in other documents.
 </p>
 
-<contentsTree root="" extraction="todo"/>
+<contents root="" extraction="todo"/>
 </body>
 </chapter>
 </devbook>
diff --git a/archs/text.xml b/archs/text.xml
@@ -22,7 +22,7 @@ happens to work best in any situation.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/depend.xsl b/depend.xsl
@@ -12,7 +12,7 @@
 <xsl:template match="/">
   <xsl:variable name="refs">
     <!-- all descendants -->
-    <xsl:call-template name="contentsTree"/>
+    <xsl:call-template name="contents"/>
     <!-- all ancestors -->
     <xsl:call-template name="printParentDocs"/>
     <!-- previous and next documents -->
diff --git a/devbook.rnc b/devbook.rnc
@@ -33,7 +33,7 @@ subsubsection = element subsubsection { title, body }
 # Title texts are used as anchors, so allow only text attributes
 title = element title { attrib }
 
-body = element body { (authors | contentsTree | block.class)+ }
+body = element body { (authors | contents | block.class)+ }
 
 authors = element authors { author+ | authorlist+ }
 
@@ -48,7 +48,7 @@ authorlist = element authorlist {
   attribute href { text }
 }
 
-contentsTree = element contentsTree {
+contents = element contents {
   attribute maxdepth { xsd:unsignedInt }?,
   attribute root { text }?,
   attribute extraction { text }?
diff --git a/devbook.rng b/devbook.rng
@@ -136,7 +136,7 @@
       <oneOrMore>
         <choice>
           <ref name="authors"/>
-          <ref name="contentsTree"/>
+          <ref name="contents"/>
           <ref name="block.class"/>
         </choice>
       </oneOrMore>
@@ -169,8 +169,8 @@
       <attribute name="href"/>
     </element>
   </define>
-  <define name="contentsTree">
-    <element name="contentsTree">
+  <define name="contents">
+    <element name="contents">
       <optional>
         <attribute name="maxdepth">
           <data type="unsignedInt"/>
diff --git a/devbook.xsl b/devbook.xsl
@@ -429,7 +429,7 @@
 </xsl:template>
 
 <!-- TOC Tree -->
-<xsl:template match="contentsTree" name="contentsTree">
+<xsl:template match="contents" name="contents">
   <xsl:param name="depth" select="0"/>
   <xsl:param name="maxdepth">
     <xsl:choose>
@@ -463,7 +463,7 @@
         <xsl:for-each select="document($doc_self)/devbook/include">
           <count value="{count(document(concat($path, @href, 'text.xml'))//*[name()=$extraction])}"
                  path="{concat($path, @href)}">
-            <xsl:call-template name="contentsTree">
+            <xsl:call-template name="contents">
               <xsl:with-param name="depth" select="$depth + 1"/>
               <xsl:with-param name="maxdepth" select="$maxdepth"/>
               <xsl:with-param name="path" select="concat($path, @href)"/>
@@ -479,7 +479,7 @@
         <ul>
           <xsl:for-each select="document($doc_self)/devbook/include">
             <xsl:variable name="extraction_counter_node">
-              <xsl:call-template name="contentsTree">
+              <xsl:call-template name="contents">
                 <xsl:with-param name="depth" select="$depth + 1"/>
                 <xsl:with-param name="maxdepth" select="$maxdepth"/>
                 <xsl:with-param name="path" select="concat($path, @href)"/>
@@ -513,7 +513,7 @@
                     </xsl:for-each>
                   </ul>
                 </xsl:if>
-                <xsl:call-template name="contentsTree">
+                <xsl:call-template name="contents">
                   <xsl:with-param name="depth" select="$depth + 1"/>
                   <xsl:with-param name="maxdepth" select="$maxdepth"/>
                   <xsl:with-param name="path" select="concat($path, @href)"/>
@@ -637,11 +637,11 @@
                             <xsl:if test="/devbook/include">
                               <li class="divider"><xsl:comment/></li>
                               <!-- List any sub-documents included at first level.
-                                   We cannot call "contentsTree" directly, because it would
+                                   We cannot call "contents" directly, because it would
                                    insert another "ul" element. So, assign it to a variable,
                                    then copy only the "li" nodes. -->
                               <xsl:variable name="contents">
-                                <xsl:call-template name="contentsTree">
+                                <xsl:call-template name="contents">
                                   <xsl:with-param name="maxdepth" select="1"/>
                                 </xsl:call-template>
                               </xsl:variable>
diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml
@@ -15,7 +15,7 @@ familiar with.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/ebuild-writing/functions/src_compile/text.xml b/ebuild-writing/functions/src_compile/text.xml
@@ -79,7 +79,7 @@ The following subsections cover different topics which often occur when writing
 <c>src_compile</c> functions.
 </p>
 
-<contentsTree/>
+<contents/>
 </body>
 </section>
 
diff --git a/ebuild-writing/functions/src_configure/text.xml b/ebuild-writing/functions/src_configure/text.xml
@@ -78,7 +78,7 @@ The following subsections cover different topics which often occur when writing
 <c>src_configure</c> functions.
 </p>
 
-<contentsTree/>
+<contents/>
 </body>
 </section>
 
diff --git a/ebuild-writing/functions/src_install/text.xml b/ebuild-writing/functions/src_install/text.xml
@@ -229,7 +229,7 @@ The following subsections cover different topics which often occur when writing
 <c>src_install</c> functions.
 </p>
 
-<contentsTree/>
+<contents/>
 
 </body>
 </section>
diff --git a/ebuild-writing/functions/src_prepare/text.xml b/ebuild-writing/functions/src_prepare/text.xml
@@ -90,7 +90,7 @@ The following subsections cover different topics which often occur
 when writing <c>src_prepare</c> functions.
 </p>
 
-<contentsTree/>
+<contents/>
 </body>
 </section>
 
diff --git a/ebuild-writing/functions/src_unpack/text.xml b/ebuild-writing/functions/src_unpack/text.xml
@@ -116,7 +116,7 @@ The following subsections cover different topics which often occur when writing
 <c>src_unpack</c> functions.
 </p>
 
-<contentsTree/>
+<contents/>
 </body>
 </section>
 
diff --git a/ebuild-writing/functions/text.xml b/ebuild-writing/functions/text.xml
@@ -109,7 +109,7 @@ during the <c>src_compile</c> phase is equivalent to a call to the
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/ebuild-writing/misc-files/text.xml b/ebuild-writing/misc-files/text.xml
@@ -12,7 +12,7 @@ This section contains some notes on various miscellaneous files.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/ebuild-writing/text.xml b/ebuild-writing/text.xml
@@ -14,7 +14,7 @@ with some general notes and extended examples.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/function-reference/text.xml b/function-reference/text.xml
@@ -12,7 +12,7 @@ The following functions are available for use in ebuilds:
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/general-concepts/text.xml b/general-concepts/text.xml
@@ -13,7 +13,7 @@ writing ebuilds or working with the Gentoo repository.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 
diff --git a/profiles/text.xml b/profiles/text.xml
@@ -19,7 +19,7 @@ Portage-specific behaviour must not be relied upon in the repository.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/tasks-reference/text.xml b/tasks-reference/text.xml
@@ -13,7 +13,7 @@ ebuilds.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/text.xml b/text.xml
@@ -25,14 +25,14 @@ section lists specific contributions to this manual.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree maxdepth="1"/>
+<contents maxdepth="1"/>
 </body>
 </section>
 
 <section>
 <title>Full contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
diff --git a/tools-reference/text.xml b/tools-reference/text.xml
@@ -20,7 +20,7 @@ when using these tools in ebuilds.
 <section>
 <title>Contents</title>
 <body>
-<contentsTree/>
+<contents/>
 </body>
 </section>
 </chapter>
