kc3-lang/libxml2/doc/wiki.xsl
-
Show log
Commit
-
Hash : e92bf5d6
Author :
Date : 2005-02-04T17:28:19
fixed one internal function applied patch from Joel Reed regenerated * xmlschemas.c: fixed one internal function * doc/Makefile.am doc/wiki.xsl: applied patch from Joel Reed * testapi.c doc/libxml2-api.xml doc/libxml2-refs.xml: regenerated daniel
-
doc/wiki.xsl
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 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="ISO-8859-1" 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="ISO-8859-1" 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="ISO-8859-1" 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>