svn commit - mysqldoc@docsrva: r4464 - in trunk: . xsl.d

[paul]

Author: paul
Date: 2007-01-12 15:48:59 +0100 (Fri, 12 Jan 2007)
New Revision: 4464

Log:
 r17990@polar:  paul | 2007-01-12 08:46:14 -0600
 Revise tagging structure for GUI help TOC files.


Modified:
   trunk/xsl.d/mysql-guihelp-toc.xsl

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:17985
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:14416
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:13015
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:17990
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:14416
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:13015


Modified: trunk/xsl.d/mysql-guihelp-toc.xsl
===================================================================
--- trunk/xsl.d/mysql-guihelp-toc.xsl	2007-01-12 14:13:50 UTC (rev 4463)
+++ trunk/xsl.d/mysql-guihelp-toc.xsl	2007-01-12 14:48:59 UTC (rev 4464)
Changed blocks: 4, Lines Added: 34, Lines Deleted: 6; 2393 bytes

@@ -3,10 +3,38 @@
 <!--
   mysql-guihelp-toc.xsl - generate XML "TOC" files for GUI help files
 
-  extract.list.items should be 1 if the output should contain
+  extract.list.items should be non-zero if the output should contain
   entries extracted from list items. This is used for extracting
   information from individual function descriptions in the functions
   file.
+
+  The input -> output mapping looks like this:
+
+  <section> (top level)  -> <functiongroup>
+
+    <section> (nested)   -> <functionsubgroup>
+
+      <itemizedlist>
+        <li>
+          <para id="xxx> -> <function>
+
+  <function> tags are enabled only if extract.list.items is non-zero.
+  The are produced *only* for <para> elements in lists that have an
+  id attribute.
+    
+  The root element is <functionindex>, so the output file looks like
+  this:
+
+  <functionindex>
+    <functiongroup>
+      <functionsubgroup> (possibly multiple levels)
+		  <function/>
+          ...
+      </functionsubgroup>
+      ...
+    </functiongroup>
+    ...
+  </functionindex>
 -->
 
 <xsl:stylesheet

@@ -36,7 +64,7 @@
       <xsl:value-of select="$newline"/>
     </xsl:when>
     <xsl:otherwise>
-      <function>
+      <functionsubgroup>
         <xsl:attribute name="id">
           <xsl:value-of select="@id"/>
         </xsl:attribute>

@@ -47,7 +75,7 @@
           <xsl:value-of select="$newline"/>
           <xsl:apply-templates select="section|itemizedlist"/>
         </xsl:if>
-      </function>
+      </functionsubgroup>
       <xsl:value-of select="$newline"/>
     </xsl:otherwise>
   </xsl:choose>

@@ -74,16 +102,16 @@
 -->
 
 <xsl:template match="para[1]" mode="extract">
-  <!-- ignore para unless it has an @id attribute and a literal element -->
+  <!-- ignore para unless it has an id attribute and a literal element -->
   <xsl:if test="@id and literal">
-    <functionx>
+    <function>
       <xsl:attribute name="caption">
         <xsl:value-of select="normalize-space(literal[1])"/>
       </xsl:attribute>
       <xsl:attribute name="id">
         <xsl:value-of select="@id"/>
       </xsl:attribute>
-    </functionx>
+    </function>
     <xsl:value-of select="$newline"/>
   </xsl:if>
 </xsl:template>