diff options
| author | Daniel Veillard <veillard@src.gnome.org> | 2005-09-12 13:10:09 +0000 |
|---|---|---|
| committer | Daniel Veillard <veillard@src.gnome.org> | 2005-09-12 13:10:09 +0000 |
| commit | 1db4a66b9aadf87939b2cd956a3e54bb95f41107 (patch) | |
| tree | 68017a00ee843bfbfc017ff3e1bab8bf343385d2 /doc/devhelp/devhelp.xsl | |
| parent | 2ce51c0646dd499b260f4f647169680634998244 (diff) | |
| download | libxml2-1db4a66b9aadf87939b2cd956a3e54bb95f41107.tar.gz | |
finished the integration with devhelp, completing the index and inserted
* libxml.spec.in doc/devhelp/*: finished the integration with
devhelp, completing the index and inserted into the gtk-doc
database at "make install" stage
Daniel
Diffstat (limited to 'doc/devhelp/devhelp.xsl')
| -rw-r--r-- | doc/devhelp/devhelp.xsl | 504 |
1 files changed, 25 insertions, 479 deletions
diff --git a/doc/devhelp/devhelp.xsl b/doc/devhelp/devhelp.xsl index c0928682..f19c3f1a 100644 --- a/doc/devhelp/devhelp.xsl +++ b/doc/devhelp/devhelp.xsl @@ -5,47 +5,21 @@ xmlns:str="http://exslt.org/strings" extension-element-prefixes="exsl str" exclude-result-prefixes="exsl str"> + <!-- The stylesheet for the html pages --> + <xsl:import href="html.xsl"/> + <xsl:output method="xml" encoding="UTF-8" indent="yes"/> <!-- Build keys for all symbols --> <xsl:key name="symbols" match="/api/symbols/*" use="@name"/> - <!-- This is convoluted but needed to force the current document to - be the API one and not the result tree from the tokenize() result, - because the keys are only defined on the main document --> - <xsl:template mode="dumptoken" match='*' xmlns=""> - <xsl:param name="token"/> - <xsl:variable name="ref" select="key('symbols', $token)"/> - <xsl:choose> - <xsl:when test="$ref"> - <a href="libxml-{$ref/@file}.html#{$ref/@name}"><xsl:value-of select="$token"/></a> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="$token"/> - </xsl:otherwise> - </xsl:choose> - </xsl:template> - - <!-- dumps a string, making cross-reference links --> - <xsl:template name="dumptext" xmlns=""> - <xsl:param name="text"/> - <xsl:variable name="ctxt" select='.'/> - <!-- <xsl:value-of select="$text"/> --> - <xsl:for-each select="str:tokenize($text, ' 	')"> - <xsl:apply-templates select="$ctxt" mode='dumptoken'> - <xsl:with-param name="token" select="string(.)"/> - </xsl:apply-templates> - <xsl:if test="position() != last()"> - <xsl:text> </xsl:text> - </xsl:if> - </xsl:for-each> - </xsl:template> - <xsl:template match="/api"> <book title="{@name} Reference Manual" link="index.html" author="" name="{@name}"> <xsl:apply-templates select="files"/> <xsl:apply-templates select="symbols"/> </book> + <xsl:call-template name="generate_index"/> + <xsl:call-template name="generate_general"/> </xsl:template> <xsl:template match="/api/files"> <chapters> @@ -117,465 +91,37 @@ </xsl:template> <xsl:template match="/api/symbols"> <functions> + <xsl:apply-templates select="macro"/> + <xsl:apply-templates select="enum"/> + <xsl:apply-templates select="typedef"/> + <xsl:apply-templates select="struct"/> + <xsl:apply-templates select="functype"/> + <xsl:apply-templates select="variable"/> <xsl:apply-templates select="function"/> </functions> </xsl:template> - <xsl:template match="/api/symbols/function"> - <function name="{@name} ()" link="libxml2-{@module}.html#{@name}"/> - </xsl:template> - -<!-- - - The following builds the Synopsis section - ---> - <xsl:template mode="synopsis" match="function" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <xsl:variable name="nlen" select="string-length($name)"/> - <xsl:variable name="tlen" select="string-length(return/@type)"/> - <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="return/@type"/> - </xsl:call-template> - <xsl:text>	</xsl:text> - <a href="#{@name}"><xsl:value-of select="@name"/></a> - <xsl:if test="$blen - 40 < -8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 < 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>	(</xsl:text> - <xsl:if test="not(arg)"> - <xsl:text>void</xsl:text> - </xsl:if> - <xsl:for-each select="arg"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@type"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="position() != last()"> - <xsl:text>, </xsl:text><br/> - <xsl:if test="$blen - 40 > 8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 > 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>					 </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>);</xsl:text> - <xsl:text> -</xsl:text> - </xsl:template> - - <xsl:template mode="synopsis" match="functype" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <xsl:variable name="nlen" select="string-length($name)"/> - <xsl:variable name="tlen" select="string-length(return/@type)"/> - <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> - <xsl:text>typedef </xsl:text> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="return/@type"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <a href="#{@name}"><xsl:value-of select="@name"/></a> - <xsl:if test="$blen - 40 < -8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 < 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>	(</xsl:text> - <xsl:if test="not(arg)"> - <xsl:text>void</xsl:text> - </xsl:if> - <xsl:for-each select="arg"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@type"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="position() != last()"> - <xsl:text>, </xsl:text><br/> - <xsl:if test="$blen - 40 > 8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 > 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>					 </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>);</xsl:text> - <xsl:text> -</xsl:text> - </xsl:template> - - <xsl:template mode="synopsis" match="exports[@type='function']" xmlns=""> - <xsl:variable name="def" select="key('symbols',@symbol)"/> - <xsl:apply-templates mode="synopsis" select="$def"/> - </xsl:template> - - <xsl:template mode="synopsis" match="exports[@type='typedef']" xmlns=""> - <xsl:text>typedef </xsl:text> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="string(key('symbols',@symbol)/@type)"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <a href="#{@symbol}"><xsl:value-of select="@symbol"/></a> - <xsl:text>; -</xsl:text> - </xsl:template> - - <xsl:template mode="synopsis" match="exports[@type='macro']" xmlns=""> - <xsl:variable name="def" select="key('symbols',@symbol)"/> - <xsl:text>#define </xsl:text> - <a href="#{@symbol}"><xsl:value-of select="@symbol"/></a> - <xsl:if test="$def/arg"> - <xsl:text>(</xsl:text> - <xsl:for-each select="$def/arg"> - <xsl:value-of select="@name"/> - <xsl:if test="position() != last()"> - <xsl:text>, </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>)</xsl:text> - </xsl:if> - <xsl:text>; -</xsl:text> - </xsl:template> - <xsl:template mode="synopsis" match="exports[@type='enum']" xmlns=""> + <xsl:template match="/api/symbols/functype"> + <function name="{@name}" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - <xsl:template mode="synopsis" match="exports[@type='struct']" xmlns=""> - </xsl:template> - -<!-- - - The following builds the Details section - ---> - <xsl:template mode="details" match="struct" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}">Structure </a><xsl:value-of select="$name"/></h3> - <pre class="programlisting"> - <xsl:value-of select="@type"/><xsl:text> { -</xsl:text> - <xsl:if test="not(field)"> - <xsl:text>The content of this structure is not made public by the API. -</xsl:text> - </xsl:if> - <xsl:for-each select="field"> - <xsl:text> </xsl:text> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@type"/> - </xsl:call-template> - <xsl:text>	</xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="@info != ''"> - <xsl:text>	: </xsl:text> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="substring(@info, 1, 70)"/> - </xsl:call-template> - </xsl:if> - <xsl:text> -</xsl:text> - </xsl:for-each> - <xsl:text>} </xsl:text> - <xsl:value-of select="$name"/> - <xsl:text>; -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p><xsl:text> -</xsl:text> - </div><hr/> + <xsl:template match="/api/symbols/function"> + <function name="{@name} ()" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - - <xsl:template mode="details" match="typedef[@type != 'enum']" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}">Typedef </a><xsl:value-of select="$name"/></h3> - <pre class="programlisting"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="string(@type)"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <xsl:value-of select="$name"/> - <xsl:text>; -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p><xsl:text> -</xsl:text> - </div><hr/> + <xsl:template match="/api/symbols/typedef"> + <function name="{@name}" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - - <xsl:template mode="details" match="variable" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}">Variable </a><xsl:value-of select="$name"/></h3> - <pre class="programlisting"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="string(@type)"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <xsl:value-of select="$name"/> - <xsl:text>; -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p><xsl:text> -</xsl:text> - </div><hr/> + <xsl:template match="/api/symbols/enum"> + <function name="{@name}" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - - <xsl:template mode="details" match="typedef[@type = 'enum']" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}">Enum </a><xsl:value-of select="$name"/></h3> - <pre class="programlisting"> - <xsl:text>enum </xsl:text> - <a href="#{$name}"><xsl:value-of select="$name"/></a> - <xsl:text> { -</xsl:text> - <xsl:for-each select="/api/symbols/enum[@type=$name]"> - <xsl:sort select="@value" data-type="number" order="ascending"/> - <xsl:text> </xsl:text> - <a name="{@name}"><xsl:value-of select="@name"/></a> - <xsl:if test="@value"> - <xsl:text> = </xsl:text> - <xsl:value-of select="@value"/> - </xsl:if> - <xsl:if test="@info"> - <xsl:text> /* </xsl:text> - <xsl:value-of select="@info"/> - <xsl:text> */</xsl:text> - </xsl:if> - <xsl:text> -</xsl:text> - </xsl:for-each> - <xsl:text>}; -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p><xsl:text> -</xsl:text> - </div><hr/> + <xsl:template match="/api/symbols/struct"> + <function name="{@name}" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - - <xsl:template mode="details" match="macro" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}">Macro </a><xsl:value-of select="$name"/></h3> - <pre class="programlisting"> - <xsl:text>#define </xsl:text> - <a href="#{$name}"><xsl:value-of select="$name"/></a> - <xsl:if test="arg"> - <xsl:text>(</xsl:text> - <xsl:for-each select="arg"> - <xsl:value-of select="@name"/> - <xsl:if test="position() != last()"> - <xsl:text>, </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>)</xsl:text> - </xsl:if> - <xsl:text>; -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p> - <xsl:if test="arg"> - <div class="variablelist"><table border="0"><col align="left"/><tbody> - <xsl:for-each select="arg"> - <tr> - <td><span class="term"><i><tt><xsl:value-of select="@name"/></tt></i>:</span></td> - <td> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@info"/> - </xsl:call-template> - </td> - </tr> - </xsl:for-each> - </tbody></table></div> - </xsl:if> - <xsl:text> -</xsl:text> - </div><hr/> + <xsl:template match="/api/symbols/macro"> + <function name="{@name}" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - - <xsl:template mode="details" match="function" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <xsl:variable name="nlen" select="string-length($name)"/> - <xsl:variable name="tlen" select="string-length(return/@type)"/> - <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}"></a><xsl:value-of select="$name"/> ()</h3> - <pre class="programlisting"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="return/@type"/> - </xsl:call-template> - <xsl:text>	</xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="$blen - 40 < -8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 < 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>	(</xsl:text> - <xsl:if test="not(arg)"> - <xsl:text>void</xsl:text> - </xsl:if> - <xsl:for-each select="arg"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@type"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="position() != last()"> - <xsl:text>, </xsl:text><br/> - <xsl:if test="$blen - 40 > 8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 > 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>					 </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>)</xsl:text><br/> - <xsl:text> -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p><xsl:text> -</xsl:text> - <xsl:if test="arg | return/@info"> - <div class="variablelist"><table border="0"><col align="left"/><tbody> - <xsl:for-each select="arg"> - <tr> - <td><span class="term"><i><tt><xsl:value-of select="@name"/></tt></i>:</span></td> - <td> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@info"/> - </xsl:call-template> - </td> - </tr> - </xsl:for-each> - <xsl:if test="return/@info"> - <tr> - <td><span class="term"><i><tt>Returns</tt></i>:</span></td> - <td> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="return/@info"/> - </xsl:call-template> - </td> - </tr> - </xsl:if> - </tbody></table></div> - </xsl:if> - </div><hr/> + <xsl:template match="/api/symbols/variable"> + <function name="{@name}" link="libxml2-{@file}.html#{@name}"/> </xsl:template> - <xsl:template mode="details" match="functype" xmlns=""> - <xsl:variable name="name" select="string(@name)"/> - <xsl:variable name="nlen" select="string-length($name)"/> - <xsl:variable name="tlen" select="string-length(return/@type)"/> - <xsl:variable name="blen" select="(($nlen + 8) - (($nlen + 8) mod 8)) + (($tlen + 8) - (($tlen + 8) mod 8))"/> - <div class="refsect2" lang="en"> - <h3><a name="{$name}"></a>Function type <xsl:value-of select="$name"/> </h3> - <pre class="programlisting"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="return/@type"/> - </xsl:call-template> - <xsl:text>	</xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="$blen - 40 < -8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 < 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>	(</xsl:text> - <xsl:if test="not(arg)"> - <xsl:text>void</xsl:text> - </xsl:if> - <xsl:for-each select="arg"> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@type"/> - </xsl:call-template> - <xsl:text> </xsl:text> - <xsl:value-of select="@name"/> - <xsl:if test="position() != last()"> - <xsl:text>, </xsl:text><br/> - <xsl:if test="$blen - 40 > 8"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:if test="$blen - 40 > 0"> - <xsl:text>	</xsl:text> - </xsl:if> - <xsl:text>					 </xsl:text> - </xsl:if> - </xsl:for-each> - <xsl:text>)</xsl:text><br/> - <xsl:text> -</xsl:text> - </pre> - <p> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="info"/> - </xsl:call-template> - </p><xsl:text> -</xsl:text> - <xsl:if test="arg | return/@info"> - <div class="variablelist"><table border="0"><col align="left"/><tbody> - <xsl:for-each select="arg"> - <tr> - <td><span class="term"><i><tt><xsl:value-of select="@name"/></tt></i>:</span></td> - <td> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="@info"/> - </xsl:call-template> - </td> - </tr> - </xsl:for-each> - <xsl:if test="return/@info"> - <tr> - <td><span class="term"><i><tt>Returns</tt></i>:</span></td> - <td> - <xsl:call-template name="dumptext"> - <xsl:with-param name="text" select="return/@info"/> - </xsl:call-template> - </td> - </tr> - </xsl:if> - </tbody></table></div> - </xsl:if> - </div><hr/> - </xsl:template> </xsl:stylesheet> |