Minor documentation improvements.

[pub/USBasp.git] / LUFA / StudioIntegration / HV1 / lufa_docbook_transform.xslt

diff --git a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
index 9026dd6..680cea5 100644 (file)
--- a/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
+++ b/LUFA/StudioIntegration/HV1/lufa_docbook_transform.xslt
@@ -62,6 +62,7 @@
                        <!-- Add index chapter -->
                        <xsl:call-template name="generate.top.level.page">
                                <xsl:with-param name="top.level.page" select="compounddef[@kind = 'page' and @id = 'indexpage']"/>
                        <!-- Add index chapter -->
                        <xsl:call-template name="generate.top.level.page">
                                <xsl:with-param name="top.level.page" select="compounddef[@kind = 'page' and @id = 'indexpage']"/>

+                               <xsl:with-param name="top.level.page.title" select="'Library Information'"/>

                        </xsl:call-template>
 
                        <!-- Add free-floating chapters -->
                        </xsl:call-template>
 
                        <!-- Add free-floating chapters -->


@@ -73,7 +74,7 @@
                                </xsl:if>
                        </xsl:for-each>
 
                                </xsl:if>
                        </xsl:for-each>
 

-                       <!-- Add Module chapter -->
+                       <!-- Add Modules chapter -->

                        <chapter>
                                <title>Modules</title>
                                <xsl:for-each select="compounddef[@kind = 'group']">
                        <chapter>
                                <title>Modules</title>
                                <xsl:for-each select="compounddef[@kind = 'group']">


@@ -87,10 +88,11 @@
 
        <xsl:template name="generate.top.level.page">
                <xsl:param name="top.level.page"/>
 
        <xsl:template name="generate.top.level.page">
                <xsl:param name="top.level.page"/>

+               <xsl:param name="top.level.page.title" select="$top.level.page/title"/>

 
                <chapter id="{$top.level.page/@id}">
                        <title>
 
                <chapter id="{$top.level.page/@id}">
                        <title>

-                               <xsl:value-of select="$top.level.page/title"/>
+                               <xsl:value-of select="$top.level.page.title"/>

                        </title>
 
                        <xsl:apply-templates select="$top.level.page/detaileddescription"/>
                        </title>
 
                        <xsl:apply-templates select="$top.level.page/detaileddescription"/>


@@ -101,10 +103,6 @@
                </chapter>
        </xsl:template>
 
                </chapter>
        </xsl:template>
 

-       <xsl:template match="compounddef">
-               <!-- Discard compounddef elements unless a later template matches -->
-       </xsl:template>
-

        <xsl:template match="compounddef[@kind = 'page']">
                <section id="{@id}">
                        <title>
        <xsl:template match="compounddef[@kind = 'page']">
                <section id="{@id}">
                        <title>


@@ -228,7 +226,7 @@
                                                        <xsl:for-each select="memberdef">
                                                                <row id="{@id}" xreflabel="{name}">
                                                                        <entry>
                                                        <xsl:for-each select="memberdef">
                                                                <row id="{@id}" xreflabel="{name}">
                                                                        <entry>

-                                                                               <xsl:apply-templates select="type"/>
+                                                                               <xsl:value-of select="type"/>

                                                                        </entry>
                                                                        <entry>
                                                                                <xsl:value-of select="name"/>
                                                                        </entry>
                                                                        <entry>
                                                                                <xsl:value-of select="name"/>


@@ -285,7 +283,7 @@
                                                        <xsl:if test="position() > 1">
                                                                <xsl:text>,</xsl:text>
                                                        </xsl:if>
                                                        <xsl:if test="position() > 1">
                                                                <xsl:text>,</xsl:text>
                                                        </xsl:if>

-                                                       <xsl:text>&#10;&#9;&#9;</xsl:text>
+                                                       <xsl:text>&#10;&#9;</xsl:text>

                                                        <emphasis role="keyword">
                                                                <xsl:value-of select="type"/>
                                                        </emphasis>
                                                        <emphasis role="keyword">
                                                                <xsl:value-of select="type"/>
                                                        </emphasis>


@@ -303,16 +301,14 @@
        </xsl:template>
 
        <xsl:template match="memberdef[@kind = 'enum']">
        </xsl:template>
 
        <xsl:template match="memberdef[@kind = 'enum']">

-               <xsl:variable name="name" select="name"/>
-

                <section id="{@id}" xreflabel="{name}">
                        <title>
                                <xsl:text>Enum </xsl:text>
                <section id="{@id}" xreflabel="{name}">
                        <title>
                                <xsl:text>Enum </xsl:text>

-                               <xsl:value-of select="$name"/>
+                               <xsl:value-of select="name"/>

                        </title>
 
                        <xsl:call-template name="generate.index.id">
                        </title>
 
                        <xsl:call-template name="generate.index.id">

-                               <xsl:with-param name="name" select="$name"/>
+                               <xsl:with-param name="name" select="name"/>

                        </xsl:call-template>
 
                        <xsl:apply-templates select="detaileddescription"/>
                        </xsl:call-template>
 
                        <xsl:apply-templates select="detaileddescription"/>


@@ -332,7 +328,7 @@
                                                                <entry>
                                                                        <para id="{@id}" xreflabel="{name}">
                                                                                <xsl:value-of select="name"/>
                                                                <entry>
                                                                        <para id="{@id}" xreflabel="{name}">
                                                                                <xsl:value-of select="name"/>

-                                                                               <indexterm id="{$keyword.namespace}.{$name}.{name}"/>
+                                                                               <indexterm id="{$keyword.namespace}.{name}"/>

                                                                        </para>
                                                                </entry>
                                                                <entry>
                                                                        </para>
                                                                </entry>
                                                                <entry>


@@ -375,7 +371,7 @@
 
                                        <!-- Split long macro definitions across multiple lines -->
                                        <xsl:if test="(string-length(initializer) > 50) or (count(param) > 0)">
 
                                        <!-- Split long macro definitions across multiple lines -->
                                        <xsl:if test="(string-length(initializer) > 50) or (count(param) > 0)">

-                                               <xsl:text>\&#10;&#09;&#9;</xsl:text>
+                                               <xsl:text>\&#10;&#9;</xsl:text>

                                        </xsl:if>
 
                                        <xsl:value-of select="initializer"/>
                                        </xsl:if>
 
                                        <xsl:value-of select="initializer"/>


@@ -439,7 +435,7 @@
                </section>
        </xsl:template>
 
                </section>
        </xsl:template>
 

-       <xsl:template match="linebreak">
+       <xsl:template match="linebreak | simplesectsep">

                <literallayout>
                </literallayout>
        </xsl:template>
                <literallayout>
                </literallayout>
        </xsl:template>


@@ -471,42 +467,42 @@
                                        <title>
                                                <xsl:value-of select="title"/>
                                        </title>
                                        <title>
                                                <xsl:value-of select="title"/>
                                        </title>

-                                       <xsl:apply-templates select="para"/>
+                                       <xsl:apply-templates/>

                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'return'">
                                <note>
                                        <title>Returns</title>
                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'return'">
                                <note>
                                        <title>Returns</title>

-                                       <xsl:apply-templates select="para"/>
+                                       <xsl:apply-templates/>

                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'warning'">
                                <warning>
                                        <title>Warning</title>
                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'warning'">
                                <warning>
                                        <title>Warning</title>

-                                       <xsl:apply-templates select="para"/>
+                                       <xsl:apply-templates/>

                                </warning>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'pre'">
                                <note>
                                        <title>Precondition</title>
                                </warning>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'pre'">
                                <note>
                                        <title>Precondition</title>

-                                       <xsl:apply-templates select="para"/>
+                                       <xsl:apply-templates/>

                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'see'">
                                <note>
                                        <title>See also</title>
                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'see'">
                                <note>
                                        <title>See also</title>

-                                       <xsl:apply-templates select="para"/>
+                                       <xsl:apply-templates/>

                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'note'">
                                <note>
                                        <title>Note</title>
                                </note>
                        </xsl:when>
 
                        <xsl:when test="@kind = 'note'">
                                <note>
                                        <title>Note</title>

-                                       <xsl:apply-templates select="para"/>
+                                       <xsl:apply-templates/>

                                </note>
                        </xsl:when>
 
                                </note>
                        </xsl:when>
 


@@ -586,64 +582,70 @@
                </entry>
        </xsl:template>
 
                </entry>
        </xsl:template>
 

-       <xsl:template match="type">
-               <xsl:apply-templates/>
-       </xsl:template>
-
-       <xsl:template match="para">
+       <xsl:template match="parameterdescription">

                <para>
                        <xsl:apply-templates/>
                </para>
        </xsl:template>
 
                <para>
                        <xsl:apply-templates/>
                </para>
        </xsl:template>
 

+       <xsl:template match="type">
+               <xsl:apply-templates/>
+       </xsl:template>
+

        <xsl:template match="bold">
                <emphasis role="bold">
        <xsl:template match="bold">
                <emphasis role="bold">

-                       <xsl:value-of select="."/>
+                       <xsl:apply-templates/>

                </emphasis>
        </xsl:template>
 
        <xsl:template match="emphasis">
                <emphasis role="italic">
                </emphasis>
        </xsl:template>
 
        <xsl:template match="emphasis">
                <emphasis role="italic">

-                       <xsl:value-of select="."/>
+                       <xsl:apply-templates/>

                </emphasis>
        </xsl:template>
 
                </emphasis>
        </xsl:template>
 

-       <xsl:template match="computeroutput">
-               <computeroutput>
-                       <xsl:value-of select="."/>
-               </computeroutput>
+       <xsl:template match="small">
+               <xsl:apply-templates/>

        </xsl:template>
 
        </xsl:template>
 

-       <xsl:template match="ulink">
-               <ulink url="{@url}">
-                       <xsl:value-of select="."/>
-               </ulink>
+       <xsl:template match="mdash | ndash">
+               <xsl:text>--</xsl:text>

        </xsl:template>
 
        </xsl:template>
 

-       <xsl:template match="registered">
-               <xsl:text>&#174;</xsl:text>
+       <xsl:template match="computeroutput | preformatted">
+               <computeroutput>
+                       <xsl:apply-templates/>
+               </computeroutput>

        </xsl:template>
 
        </xsl:template>
 

-       <xsl:template match="copy">
-               <xsl:text>&#169;</xsl:text>
+       <xsl:template match="codeline">
+                       <xsl:apply-templates/>

        </xsl:template>
 
        </xsl:template>
 

-       <xsl:template match="trademark">
-               <xsl:text>&#8482;</xsl:text>
+       <xsl:template match="ulink">
+               <ulink url="{@url}">
+                       <xsl:value-of select="."/>
+               </ulink>

        </xsl:template>
 
        <xsl:template match="superscript">
                <superscript>
        </xsl:template>
 
        <xsl:template match="superscript">
                <superscript>

-                       <xsl:value-of select="."/>
+                       <xsl:apply-templates/>

                </superscript>
        </xsl:template>
 
        <xsl:template match="subscript">
                <subscript>
                </superscript>
        </xsl:template>
 
        <xsl:template match="subscript">
                <subscript>

-                       <xsl:value-of select="."/>
+                       <xsl:apply-templates/>

                </subscript>
        </xsl:template>
 
                </subscript>
        </xsl:template>
 

+       <xsl:template match="para">
+               <para>
+                       <xsl:apply-templates/>
+               </para>
+       </xsl:template>
+

        <xsl:template match="ref">
                <xsl:choose>
                        <!-- Don't show links inside program listings -->
        <xsl:template match="ref">
                <xsl:choose>
                        <!-- Don't show links inside program listings -->


@@ -665,6 +667,12 @@
                </xsl:choose>
        </xsl:template>
 
                </xsl:choose>
        </xsl:template>
 

+       <xsl:template match="entry">
+               <entry>
+                       <xsl:apply-templates/>
+               </entry>
+       </xsl:template>
+

        <xsl:template match="table">
                <xsl:choose>
                        <xsl:when test="caption">
        <xsl:template match="table">
                <xsl:choose>
                        <xsl:when test="caption">


@@ -672,6 +680,7 @@
                                        <title>
                                                <xsl:value-of select="caption"/>
                                        </title>
                                        <title>
                                                <xsl:value-of select="caption"/>
                                        </title>

+

                                        <xsl:call-template name="write.table.content"/>
                                </table>
                        </xsl:when>
                                        <xsl:call-template name="write.table.content"/>
                                </table>
                        </xsl:when>


@@ -689,22 +698,14 @@
                        <thead>
                                <xsl:for-each select="row[1]">
                                        <row>
                        <thead>
                                <xsl:for-each select="row[1]">
                                        <row>

-                                               <xsl:for-each select="entry">
-                                                       <entry>
-                                                               <xsl:apply-templates select="."/>
-                                                       </entry>
-                                               </xsl:for-each>
+                                               <xsl:apply-templates select="entry"/>

                                        </row>
                                </xsl:for-each>
                        </thead>
                        <tbody>
                                <xsl:for-each select="row[position() != 1]">
                                        <row>
                                        </row>
                                </xsl:for-each>
                        </thead>
                        <tbody>
                                <xsl:for-each select="row[position() != 1]">
                                        <row>

-                                               <xsl:for-each select="entry">
-                                                       <entry>
-                                                               <xsl:apply-templates select="."/>
-                                                       </entry>
-                                               </xsl:for-each>
+                                               <xsl:apply-templates select="entry"/>

                                        </row>
                                </xsl:for-each>
                        </tbody>
                                        </row>
                                </xsl:for-each>
                        </tbody>


@@ -739,9 +740,9 @@
        </xsl:template>
 
        <xsl:template match="highlight">
        </xsl:template>
 
        <xsl:template match="highlight">

-<!--           <emphasis role="{@class}"> -->
+               <emphasis role="{@class}">

                        <xsl:apply-templates/>
                        <xsl:apply-templates/>

-<!--           </emphasis> -->
+               </emphasis>

        </xsl:template>
 
        <xsl:template match="sp[ancestor::codeline]">
        </xsl:template>
 
        <xsl:template match="sp[ancestor::codeline]">


@@ -751,7 +752,7 @@
        <xsl:template match="image">
                <mediaobject>
                        <imageobject>
        <xsl:template match="image">
                <mediaobject>
                        <imageobject>

-                               <imagedata>
+                               <imagedata align="center">

                                        <xsl:attribute name="fileref">
                                                <xsl:text>images/</xsl:text>
                                                <xsl:value-of select="@name"/>
                                        <xsl:attribute name="fileref">
                                                <xsl:text>images/</xsl:text>
                                                <xsl:value-of select="@name"/>


@@ -789,4 +790,8 @@
 
        <xsl:template match="title"/>
 
 
        <xsl:template match="title"/>
 

+       <xsl:template match="*">
+               <xsl:message>NO XSL TEMPLATE MATCH: <xsl:value-of select="name()"/></xsl:message>
+       </xsl:template>
+

 </xsl:stylesheet>
 </xsl:stylesheet>