diff options
Diffstat (limited to 'doc/wiki.xsl')
| -rw-r--r-- | doc/wiki.xsl | 589 |
1 files changed, 589 insertions, 0 deletions
diff --git a/doc/wiki.xsl b/doc/wiki.xsl new file mode 100644 index 0000000..c072d20 --- /dev/null +++ b/doc/wiki.xsl @@ -0,0 +1,589 @@ +<?xml version="1.0"?> +<!-- + Stylesheet to generate the HTML documentation from an XML API descriptions: + xsltproc wiki.xsl libxml2-api.xml + + Daniel Veillard +--> +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exsl="http://exslt.org/common" + xmlns:str="http://exslt.org/strings" + extension-element-prefixes="exsl str" + exclude-result-prefixes="exsl str"> + + <!-- Generate XHTML-1.0 transitional --> + <xsl:output method="xml" encoding="UTF-8" indent="yes" + doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN" + doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"/> + + <!-- Build keys for all symbols --> + <xsl:key name="symbols" match="/api/symbols/*" use="@name"/> + + <!-- the target directory for the HTML output --> + <xsl:variable name="htmldir">wiki</xsl:variable> + <xsl:variable name="href_base">../</xsl:variable> + + <xsl:template name="style"> + <link rel="SHORTCUT ICON" href="/favicon.ico"/> + <style type="text/css"> +TD {font-family: Verdana,Arial,Helvetica} +BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em} +H1 {font-family: Verdana,Arial,Helvetica} +H2 {font-family: Verdana,Arial,Helvetica} +H3 {font-family: Verdana,Arial,Helvetica} +A:link, A:visited, A:active { text-decoration: underline } +</style> + </xsl:template> + + <xsl:template name="docstyle"> + <style type="text/css"> + div.deprecated pre.programlisting {border-style: double;border-color:red} + pre.programlisting {border-style: double;} + </style> + </xsl:template> + + <!-- 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='*'> + <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"> + <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="macro" mode="toc"> + <pre class="programlisting"> + <xsl:text>#define </xsl:text><a href="#{@name}"><xsl:value-of select="@name"/></a> + </pre> + </xsl:template> + + <xsl:template match="variable" mode="toc"> + <pre class="programlisting"> + <xsl:text>Variable </xsl:text> + <xsl:call-template name="dumptext"> + <xsl:with-param name="text" select="string(@type)"/> + </xsl:call-template> + <xsl:text> </xsl:text> + <a name="{@name}"></a> + <xsl:value-of select="@name"/> + <xsl:text> + +</xsl:text> + </pre> + </xsl:template> + + <xsl:template match="typedef" mode="toc"> + <xsl:variable name="name" select="string(@name)"/> + <pre class="programlisting"> + <xsl:choose> + <xsl:when test="@type = 'enum'"> + <xsl:text>Enum </xsl:text> + <a href="#{$name}"><xsl:value-of select="$name"/></a> + <xsl:text> +</xsl:text> + </xsl:when> + <xsl:otherwise> + <xsl:text>Typedef </xsl:text> + <xsl:call-template name="dumptext"> + <xsl:with-param name="text" select="@type"/> + </xsl:call-template> + <xsl:text> </xsl:text> + <a name="{$name}"><xsl:value-of select="$name"/></a> + <xsl:text> +</xsl:text> + </xsl:otherwise> + </xsl:choose> + </pre> + </xsl:template> + + <xsl:template match="typedef[@type = 'enum']"> + <xsl:variable name="name" select="string(@name)"/> + <h3>Enum <a name="{$name}"><xsl:value-of select="$name"/></a></h3> + <pre class="programlisting"> + <xsl:text>Enum </xsl:text> + <xsl:value-of select="$name"/> + <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:text> = </xsl:text> + <xsl:value-of select="@value"/> + <xsl:if test="@info != ''"> + <xsl:text> : </xsl:text> + <xsl:call-template name="dumptext"> + <xsl:with-param name="text" select="@info"/> + </xsl:call-template> + </xsl:if> + <xsl:text> +</xsl:text> + </xsl:for-each> + <xsl:text>} +</xsl:text> + </pre> + </xsl:template> + + <xsl:template match="struct" mode="toc"> + <pre class="programlisting"> + <xsl:text>Structure </xsl:text><a href="#{@name}"><xsl:value-of select="@name"/></a><br/> + <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> + </pre> + </xsl:template> + + <xsl:template match="struct"> + <h3><a name="{@name}">Structure <xsl:value-of select="@name"/></a></h3> + <pre class="programlisting"> + <xsl:text>Structure </xsl:text><xsl:value-of select="@name"/><br/> + <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, 40)"/> + </xsl:call-template> + </xsl:if> + <xsl:text> +</xsl:text> + </xsl:for-each> + <xsl:text>}</xsl:text> + </pre> + </xsl:template> + + <xsl:template match="macro"> + <xsl:variable name="name" select="string(@name)"/> + <h3><a name="{$name}"></a>Macro: <xsl:value-of select="$name"/></h3> + <pre><xsl:text>#define </xsl:text><xsl:value-of select="$name"/></pre> + <p> + <xsl:call-template name="dumptext"> + <xsl:with-param name="text" select="info"/> + </xsl:call-template> + </p><xsl:text> +</xsl:text> + </xsl:template> + + <xsl:template match="function" mode="toc"> + <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))"/> + <pre class="programlisting"> + <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> + </pre><xsl:text> +</xsl:text> + </xsl:template> + + <xsl:template match="functype" mode="toc"> + <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))"/> + <pre class="programlisting"> + <xsl:text>Function type: </xsl:text> + <a href="#{$name}"><xsl:value-of select="$name"/></a> + <xsl:text> +</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> + </pre> + <xsl:text> +</xsl:text> + </xsl:template> + + <xsl:template match="functype"> + <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))"/> + <h3> + <a name="{$name}"></a> + <xsl:text>Function type: </xsl:text> + <xsl:value-of select="$name"/> + </h3> + <pre class="programlisting"> + <xsl:text>Function type: </xsl:text> + <xsl:value-of select="$name"/> + <xsl:text> +</xsl:text> + <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> + </pre> + <p> + <xsl:call-template name="dumptext"> + <xsl:with-param name="text" select="info"/> + </xsl:call-template> + </p> + <xsl:if test="arg | return"> + <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> + <br/> + <xsl:text> +</xsl:text> + </xsl:template> + + <xsl:template match="function"> + <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))"/> + <h3><a name="{$name}"></a>Function: <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> + </xsl:template> + + <xsl:template match="exports" mode="toc"> + <xsl:apply-templates select="key('symbols', string(@symbol))[1]" mode="toc"/> + </xsl:template> + + <xsl:template match="exports"> + <xsl:apply-templates select="key('symbols', string(@symbol))[1]"/> + </xsl:template> + + <xsl:template name="description"> + <xsl:if test="deprecated"> + <h2 style="font-weight:bold;color:red;text-align:center">This module is deprecated</h2> + </xsl:if> + <xsl:if test="description"> + <p><xsl:value-of select="description"/></p> + </xsl:if> + </xsl:template> + + <xsl:template name="docomponents"> + <xsl:param name="mode"/> + <xsl:apply-templates select="exports[@type='macro']" mode="$mode"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='enum']" mode="$mode"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='typedef']" mode="$mode"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='struct']" mode="$mode"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='function']" mode="$mode"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + </xsl:template> + + <xsl:template match="file"> + <xsl:variable name="name" select="@name"/> + <xsl:variable name="title">Module <xsl:value-of select="$name"/> from <xsl:value-of select="/api/@name"/></xsl:variable> + <xsl:document href="{$htmldir}/libxml-{$name}.html" method="xml" encoding="UTF-8" + doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN" + doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + <xsl:call-template name="style"/> + <xsl:call-template name="docstyle"/> + <table border="0" cellpadding="3" cellspacing="1" width="100%"> + <tr> + <td> + <xsl:call-template name="description"/> + <xsl:choose> + <xsl:when test="deprecated"> + <div class="deprecated"> + <h2>Table of Contents</h2> + <xsl:apply-templates select="exports" mode="toc"/> + <h2>Description</h2> + <xsl:text> +</xsl:text> + <xsl:apply-templates select="exports"/> + </div> + </xsl:when> + <xsl:otherwise> + <h2>Table of Contents</h2> + <xsl:apply-templates select="exports[@type='macro']" mode="toc"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='enum']" mode="toc"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='typedef']" mode="toc"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='struct']" mode="toc"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='function']" mode="toc"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <h2>Description</h2> + <xsl:text> +</xsl:text> + <xsl:apply-templates select="exports[@type='macro']"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='enum']"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='typedef']"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='struct']"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + <xsl:apply-templates select="exports[@type='function']"> + <xsl:sort select='@symbol'/> + </xsl:apply-templates> + </xsl:otherwise> + </xsl:choose> + </td> + </tr> +</table> + </xsl:document> + </xsl:template> + + <xsl:template match="file" mode="toc"> + <xsl:variable name="name" select="@name"/> + <b><a href="http://xmlsoft.org/wiki/index.php?title=Libxml2:Api:{$name}"><xsl:value-of select="$name"/></a></b><br/> + <xsl:value-of select="summary"/> + <br/><br/> + </xsl:template> + + <xsl:template name="mainpage"> + <xsl:param name="file" select="concat($htmldir, '/libxml-index.html')"/> + <xsl:variable name="title">Reference Manual for <xsl:value-of select="/api/@name"/></xsl:variable> + <xsl:document href="{$file}" method="xml" encoding="UTF-8" + doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN" + doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + <xsl:call-template name="style"/> + <xsl:call-template name="docstyle"/> + <table border="0" cellpadding="3" cellspacing="1" width="100%"> + <tr> + <td> + <xsl:apply-templates select="/api/files/file" mode="toc"/> + </td> + </tr> + </table> + </xsl:document> + </xsl:template> + + <xsl:template match="/"> + <!-- Save the main libxml-index.html as well as a couple of copies --> + <xsl:call-template name="mainpage"/> + <!-- now build the file for each of the modules --> + <xsl:apply-templates select="/api/files/file"/> + </xsl:template> + +</xsl:stylesheet> |