From ce4a32fe52ef09d8f5ff1dd22c001110902b60a2 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- kdoctools/docbook/xsl/lib/ChangeLog | 74 ++++ kdoctools/docbook/xsl/lib/lib.xml | 750 +++++++++++++++++++++++++++++++++++ kdoctools/docbook/xsl/lib/lib.xsl | 355 +++++++++++++++++ kdoctools/docbook/xsl/lib/lib.xweb | 772 ++++++++++++++++++++++++++++++++++++ 4 files changed, 1951 insertions(+) create mode 100644 kdoctools/docbook/xsl/lib/ChangeLog create mode 100644 kdoctools/docbook/xsl/lib/lib.xml create mode 100644 kdoctools/docbook/xsl/lib/lib.xsl create mode 100644 kdoctools/docbook/xsl/lib/lib.xweb (limited to 'kdoctools/docbook/xsl/lib') diff --git a/kdoctools/docbook/xsl/lib/ChangeLog b/kdoctools/docbook/xsl/lib/ChangeLog new file mode 100644 index 000000000..ccd788403 --- /dev/null +++ b/kdoctools/docbook/xsl/lib/ChangeLog @@ -0,0 +1,74 @@ +2004-09-24 Robert Stayton + + * lib.xweb: Fixed param prototype to remove Saxon8 warning. + +2004-08-11 Robert Stayton + + * lib.xweb: Fixed problem of PI name suffix being matched instead of whole name. + +2003-04-05 Adam Di Carlo + + * lib.xweb: a pica is 12 points, rather than a sixth of an inch + +2003-03-26 Michael Smith + + * Makefile: wdocbook.xsl obsoleted by w2docbook.xsl, updated globally + +2003-03-25 Michael Smith + + * Makefile: reverting wdocbook.xsl -> w2docbook.xsl changes + +2003-03-05 Michael Smith + + * Makefile: + + Wrong filename was breaking build, fixed. + + Had ../../litprog/wdocbook.xsl but needed ../../litprog/w2docbook.xsl + +2002-09-15 Norman Walsh + + * lib.xweb: Fix bug where PIs match the suffix of a name instead of the whole name + +2002-06-09 Norman Walsh + + * lib.xweb: Fix bug #496453: make sure comments don't contain illegal chars + +2002-05-12 Norman Walsh + + * lib.xweb: Changed default units to px; added length-in-points template + +2002-03-25 Norman Walsh + + * .cvsignore: Ignore lib.xsl too + + * .cvsignore, Makefile, lib.xsl, lib.xweb: Use Literate XML to generate lib.xsl + + * Makefile: Update documentation build to reflect use of lib.xweb + +2002-03-18 Norman Walsh + + * lib.xsl: Replace generate.*.toc and generate.*.lot with single generate.toc parameter. + +2002-03-14 Norman Walsh + + * lib.xsl: Whitespace only: change CR/LF back to LF. Norm was a total moron. + + * lib.xsl: Whitespace changes only: use PC-style CR/LF because Unix clients choke on this far less often than PC clients choke on the reverse. Grrr. + +2002-01-09 Norman Walsh + + * lib.xsl: Added length-units template to extract units from lengths + +2001-11-28 Norman Walsh + + * lib.xsl: Added pi-attribute template + +2001-04-03 Norman Walsh + + * lib.xsl: Documentation fixes + +2001-04-02 Norman Walsh + + * lib.xsl: New file. + diff --git a/kdoctools/docbook/xsl/lib/lib.xml b/kdoctools/docbook/xsl/lib/lib.xml new file mode 100644 index 000000000..117438daf --- /dev/null +++ b/kdoctools/docbook/xsl/lib/lib.xml @@ -0,0 +1,750 @@ + + + + +XSL Library Template Reference +$Id$ + +DocBook Open Repository Team + + 1999 + 2000 + 2001 + 2002 + Norman Walsh + + + +Introduction + +This is technical reference documentation for the DocBook XSL +Stylesheets; it documents (some of) the parameters, templates, and +other elements of the stylesheets. + +This is not intended to be user documentation. +It is provided for developers writing customization layers for the +stylesheets, and for anyone who's interested in how it +works. + +Although I am trying to be thorough, this documentation is known +to be incomplete. Don't forget to read the source, too :-) + + + + +General Library Templates + + + +dot.count +Returns the number of . characters in a string + + +Description + + +<xsl:template name="dot.count"> + <!-- Returns the number of "." characters in a string --> + <xsl:param name="string"></xsl:param> + <xsl:param name="count" select="0"></xsl:param> + <xsl:choose> + <xsl:when test="contains($string, '.')"> + <xsl:call-template name="dot.count"> + <xsl:with-param name="string" select="substring-after($string, '.')"></xsl:with-param> + <xsl:with-param name="count" select="$count+1"></xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$count"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +copy-string +Returns count copies of a string + + +Description + + +<xsl:template name="copy-string"> + <!-- returns 'count' copies of 'string' --> + <xsl:param name="string"></xsl:param> + <xsl:param name="count" select="0"></xsl:param> + <xsl:param name="result"></xsl:param> + + <xsl:choose> + <xsl:when test="$count>0"> + <xsl:call-template name="copy-string"> + <xsl:with-param name="string" select="$string"></xsl:with-param> + <xsl:with-param name="count" select="$count - 1"></xsl:with-param> + <xsl:with-param name="result"> + <xsl:value-of select="$result"></xsl:value-of> + <xsl:value-of select="$string"></xsl:value-of> + </xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$result"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +string.subst +Substitute one text string for another in a string + + +Description + +The string.subst template replaces all +occurances of target in string +with replacement and returns the result. + + + +<xsl:template name="string.subst"> + <xsl:param name="string"></xsl:param> + <xsl:param name="target"></xsl:param> + <xsl:param name="replacement"></xsl:param> + + <xsl:choose> + <xsl:when test="contains($string, $target)"> + <xsl:variable name="rest"> + <xsl:call-template name="string.subst"> + <xsl:with-param name="string" select="substring-after($string, $target)"></xsl:with-param> + <xsl:with-param name="target" select="$target"></xsl:with-param> + <xsl:with-param name="replacement" select="$replacement"></xsl:with-param> + </xsl:call-template> + </xsl:variable> + <xsl:value-of select="concat(substring-before($string, $target), $replacement, $rest)"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +xpointer.idref +Extract IDREF from an XPointer + + +Description + +The xpointer.idref template returns the +ID portion of an XPointer which is a pointer to an ID within the current +document, or the empty string if it is not. +In other words, xpointer.idref returns +foo when passed either #foo +or #xpointer(id('foo')), otherwise it returns +the empty string. + + +<xsl:template name="xpointer.idref"> + <xsl:param name="xpointer">http://...</xsl:param> + <xsl:choose> + <xsl:when test="starts-with($xpointer, '#xpointer(id(')"> + <xsl:variable name="rest" select="substring-after($xpointer, '#xpointer(id(')"></xsl:variable> + <xsl:variable name="quote" select="substring($rest, 1, 1)"></xsl:variable> + <xsl:value-of select="substring-before(substring-after($xpointer, $quote), $quote)"></xsl:value-of> + </xsl:when> + <xsl:when test="starts-with($xpointer, '#')"> + <xsl:value-of select="substring-after($xpointer, '#')"></xsl:value-of> + </xsl:when> + <!-- otherwise it's a pointer to some other document --> + </xsl:choose> +</xsl:template> + + + + + + + + + + +length-magnitude +Return the unqualified dimension from a length specification + + +Description + +The length-magnitude template returns the +unqualified length ("20" for "20pt") from a dimension. + + + +<xsl:template name="length-magnitude"> + <xsl:param name="length" select="'0pt'"></xsl:param> + + <xsl:choose> + <xsl:when test="string-length($length) = 0"></xsl:when> + <xsl:when test="substring($length,1,1) = '0' or substring($length,1,1) = '1' or substring($length,1,1) = '2' or substring($length,1,1) = '3' or substring($length,1,1) = '4' or substring($length,1,1) = '5' or substring($length,1,1) = '6' or substring($length,1,1) = '7' or substring($length,1,1) = '8' or substring($length,1,1) = '9' or substring($length,1,1) = '.'"> + <xsl:value-of select="substring($length,1,1)"></xsl:value-of> + <xsl:call-template name="length-magnitude"> + <xsl:with-param name="length" select="substring($length,2)"></xsl:with-param> + </xsl:call-template> + </xsl:when> + </xsl:choose> +</xsl:template> + + + + + + + + + +length-units +Return the units from a length specification + + +Description + +The length-units template returns the +units ("pt" for "20pt") from a length. If no units are supplied on the +length, the defauilt.units are returned. + + +<xsl:template name="length-units"> + <xsl:param name="length" select="'0pt'"></xsl:param> + <xsl:param name="default.units" select="'px'"></xsl:param> + <xsl:variable name="magnitude"> + <xsl:call-template name="length-magnitude"> + <xsl:with-param name="length" select="$length"></xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="units"> + <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$units = ''"> + <xsl:value-of select="$default.units"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$units"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +length-spec +Return a fully qualified length specification + + +Description + +The length-spec template returns the +qualified length from a dimension. If an unqualified length is given, +the default.units will be added to it. + + + +<xsl:template name="length-spec"> + <xsl:param name="length" select="'0pt'"></xsl:param> + <xsl:param name="default.units" select="'px'"></xsl:param> + + <xsl:variable name="magnitude"> + <xsl:call-template name="length-magnitude"> + <xsl:with-param name="length" select="$length"></xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="units"> + <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of> + </xsl:variable> + + <xsl:value-of select="$magnitude"></xsl:value-of> + <xsl:choose> + <xsl:when test="$units='cm' or $units='mm' or $units='in' or $units='pt' or $units='pc' or $units='px' or $units='em'"> + <xsl:value-of select="$units"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = ''"> + <xsl:value-of select="$default.units"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:message> + <xsl:text>Unrecognized unit of measure: </xsl:text> + <xsl:value-of select="$units"></xsl:value-of> + <xsl:text>.</xsl:text> + </xsl:message> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +length-in-points +Returns the size, in points, of a specified length + + +Description + +The length-in-points template converts a length +specification to points and returns that value as an unqualified +number. + + + +There is no way for the template to infer the size of an +em. It relies on the default em.size +which is initially 10 (for 10pt). + +Similarly, converting pixesl to points relies on the +pixels.per.inch parameter which is initially +90. + + + + +<xsl:template name="length-in-points"> + <xsl:param name="length" select="'0pt'"></xsl:param> + <xsl:param name="em.size" select="10"></xsl:param> + <xsl:param name="pixels.per.inch" select="90"></xsl:param> + + <xsl:variable name="magnitude"> + <xsl:call-template name="length-magnitude"> + <xsl:with-param name="length" select="$length"></xsl:with-param> + </xsl:call-template> + </xsl:variable> + + <xsl:variable name="units"> + <xsl:value-of select="substring($length, string-length($magnitude)+1)"></xsl:value-of> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$units = 'pt'"> + <xsl:value-of select="$magnitude"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = 'cm'"> + <xsl:value-of select="$magnitude div 2.54 * 72.0"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = 'mm'"> + <xsl:value-of select="$magnitude div 25.4 * 72.0"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = 'in'"> + <xsl:value-of select="$magnitude * 72.0"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = 'pc'"> + <xsl:value-of select="$magnitude * 12.0"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = 'px'"> + <xsl:value-of select="$magnitude div $pixels.per.inch * 72.0"></xsl:value-of> + </xsl:when> + <xsl:when test="$units = 'em'"> + <xsl:value-of select="$magnitude * $em.size"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:message> + <xsl:text>Unrecognized unit of measure: </xsl:text> + <xsl:value-of select="$units"></xsl:value-of> + <xsl:text>.</xsl:text> + </xsl:message> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +pi-attribute +Extract a pseudo-attribute from a PI + + +Description + +The pi-attribute template extracts a pseudo-attribute +from a processing instruction. For example, given the PI +<?foo bar="1" baz='red'?>, +<xsl:call-template name="pi-attribute"> + <xsl:with-param name="pis" select="processing-instruction('foo')"/> + <xsl:with-param name="attribute" select="'baz'"/> +</xsl:call-template> +will return red. This template returns the first matching +attribute that it finds. Presented with processing instructions that +contain badly formed pseudo-attributes (missing or unbalanced quotes, +for example), the template may silently return erroneous results. + + +<xsl:template name="pi-attribute"> + <xsl:param name="pis" select="processing-instruction('BOGUS_PI')"></xsl:param> + <xsl:param name="attribute">filename</xsl:param> + <xsl:param name="count">1</xsl:param> + + <xsl:choose> + <xsl:when test="$count>count($pis)"> + <!-- not found --> + </xsl:when> + <xsl:otherwise> + <xsl:variable name="pi"> + <xsl:value-of select="$pis[$count]"></xsl:value-of> + </xsl:variable> + <xsl:variable name="pivalue"> + <xsl:value-of select="concat(' ', normalize-space($pi))"></xsl:value-of> + </xsl:variable> + <xsl:choose> + <xsl:when test="contains($pivalue,concat(' ', $attribute, '='))"> + <xsl:variable name="rest" select="substring-after($pivalue,concat(' ', $attribute,'='))"></xsl:variable> + <xsl:variable name="quote" select="substring($rest,1,1)"></xsl:variable> + <xsl:value-of select="substring-before(substring($rest,2),$quote)"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="pi-attribute"> + <xsl:with-param name="pis" select="$pis"></xsl:with-param> + <xsl:with-param name="attribute" select="$attribute"></xsl:with-param> + <xsl:with-param name="count" select="$count + 1"></xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +lookup.key +Retrieve the value associated with a particular key in a table + + +Description + +Given a table of space-delimited key/value pairs, +the lookup.key template extracts the value associated +with a particular key. + + +<xsl:template name="lookup.key"> + <xsl:param name="key" select="''"></xsl:param> + <xsl:param name="table" select="''"></xsl:param> + + <xsl:if test="contains($table, ' ')"> + <xsl:choose> + <xsl:when test="substring-before($table, ' ') = $key"> + <xsl:variable name="rest" select="substring-after($table, ' ')"></xsl:variable> + <xsl:choose> + <xsl:when test="contains($rest, ' ')"> + <xsl:value-of select="substring-before($rest, ' ')"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$rest"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="lookup.key"> + <xsl:with-param name="key" select="$key"></xsl:with-param> + <xsl:with-param name="table" select="substring-after(substring-after($table,' '), ' ')"></xsl:with-param> + </xsl:call-template> + </xsl:otherwise> + </xsl:choose> + </xsl:if> +</xsl:template> + + + + + + + + + +xpath.location +Calculate the XPath child-sequence to the current node + + +Description + +The xpath.location template calculates the +absolute path from the root of the tree to the current element node. + + + +<xsl:template name="xpath.location"> + <xsl:param name="node" select="."></xsl:param> + <xsl:param name="path" select="''"></xsl:param> + + <xsl:variable name="next.path"> + <xsl:value-of select="local-name($node)"></xsl:value-of> + <xsl:if test="$path != ''">/</xsl:if> + <xsl:value-of select="$path"></xsl:value-of> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$node/parent::*"> + <xsl:call-template name="xpath.location"> + <xsl:with-param name="node" select="$node/parent::*"></xsl:with-param> + <xsl:with-param name="path" select="$next.path"></xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:text>/</xsl:text> + <xsl:value-of select="$next.path"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + + + +comment-escape-string +Prepare a string for inclusion in an XML comment + + +Description + +The comment-escape-string template returns a string +that has been transformed so that it can safely be output as an XML comment. +Internal occurrences of "--" will be replaced with "- -" and a leading and/or +trailing space will be added to the string, if necessary. + + +<xsl:template name="comment-escape-string"> + <xsl:param name="string" select="''"></xsl:param> + + <xsl:if test="starts-with($string, '-')"> + <xsl:text> </xsl:text> + </xsl:if> + + <xsl:call-template name="comment-escape-string.recursive"> + <xsl:with-param name="string" select="$string"></xsl:with-param> + </xsl:call-template> + + <xsl:if test="substring($string, string-length($string), 1) = '-'"> + <xsl:text> </xsl:text> + </xsl:if> +</xsl:template> + + + + + + + +comment-escape-string.recursive +Internal function used by comment-escape-string + + +Description + +The comment-escape-string.recursive template is used +by comment-escape-string. + + +<xsl:template name="comment-escape-string.recursive"> + <xsl:param name="string" select="''"></xsl:param> + <xsl:choose> + <xsl:when test="contains($string, '--')"> + <xsl:value-of select="substring-before($string, '--')"></xsl:value-of> + <xsl:value-of select="'- -'"></xsl:value-of> + <xsl:call-template name="comment-escape-string.recursive"> + <xsl:with-param name="string" select="substring-after($string, '--')"></xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$string"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + +Relative URI Functions + +Introduction + +These functions manipulate relative URI references. + +The following assumptions must hold true: + + + +All URIs are relative. + + +No URI contains the ../ sequence +which would effectively move up the hierarchy. + + + +If these assumptions do not hold, the results are unpredictable. + + + + + +count.uri.path.depth +Count the number of path components in a relative URI + + +Description + +This function counts the number of path components in a relative URI. + + +<xsl:template name="count.uri.path.depth"> + <xsl:param name="filename" select="''"></xsl:param> + <xsl:param name="count" select="0"></xsl:param> + + <xsl:choose> + <xsl:when test="contains($filename, '/')"> + <xsl:call-template name="count.uri.path.depth"> + <xsl:with-param name="filename" select="substring-after($filename, '/')"></xsl:with-param> + <xsl:with-param name="count" select="$count + 1"></xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$count"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + +trim.common.uri.paths +Trim common leading path components from a relative URI + + +Description + +This function trims common leading path components from a relative URI. + + +<xsl:template name="trim.common.uri.paths"> + <xsl:param name="uriA" select="''"></xsl:param> + <xsl:param name="uriB" select="''"></xsl:param> + <xsl:param name="return" select="'A'"></xsl:param> + + <xsl:choose> + <xsl:when test="contains($uriA, '/') and contains($uriB, '/') and substring-before($uriA, '/') = substring-before($uriB, '/')"> + <xsl:call-template name="trim.common.uri.paths"> + <xsl:with-param name="uriA" select="substring-after($uriA, '/')"></xsl:with-param> + <xsl:with-param name="uriB" select="substring-after($uriB, '/')"></xsl:with-param> + <xsl:with-param name="return" select="$return"></xsl:with-param> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:choose> + <xsl:when test="$return = 'A'"> + <xsl:value-of select="$uriA"></xsl:value-of> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$uriB"></xsl:value-of> + </xsl:otherwise> + </xsl:choose> + </xsl:otherwise> + </xsl:choose> +</xsl:template> + + + + + + + +The Stylesheet + +The lib.xsl stylesheet is just a wrapper +around these functions. + + + +<!-- ******************************************************************** + $Id$ + ******************************************************************** + + This file is part of the XSL DocBook Stylesheet distribution. + See ../README or http://nwalsh.com/docbook/xsl/ for copyright + and other information. + + This module implements DTD-independent functions + + ******************************************************************** --> + +<xsl:stylesheet exclude-result-prefixes="src" version="1.0"> + +<src:fragref linkend="dot.count.frag"></src:fragref> +<src:fragref linkend="copy-string.frag"></src:fragref> +<src:fragref linkend="string.subst.frag"></src:fragref> +<src:fragref linkend="xpointer.idref.frag"></src:fragref> +<src:fragref linkend="length-magnitude.frag"></src:fragref> +<src:fragref linkend="length-units.frag"></src:fragref> +<src:fragref linkend="length-spec.frag"></src:fragref> +<src:fragref linkend="length-in-points.frag"></src:fragref> +<src:fragref linkend="pi-attribute.frag"></src:fragref> +<src:fragref linkend="lookup.key.frag"></src:fragref> +<src:fragref linkend="xpath.location.frag"></src:fragref> +<src:fragref linkend="comment-escape-string"></src:fragref> +<src:fragref linkend="comment-escape-string.recursive"></src:fragref> +<src:fragref linkend="count.uri.path.depth.frag"></src:fragref> +<src:fragref linkend="trim.common.uri.paths.frag"></src:fragref> + +</xsl:stylesheet> + + + + \ No newline at end of file diff --git a/kdoctools/docbook/xsl/lib/lib.xsl b/kdoctools/docbook/xsl/lib/lib.xsl new file mode 100644 index 000000000..f9f2bb4d4 --- /dev/null +++ b/kdoctools/docbook/xsl/lib/lib.xsl @@ -0,0 +1,355 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + http://... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Unrecognized unit of measure: + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Unrecognized unit of measure: + + . + + + + + + + filename + 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + / + + + + + + + + + + + + / + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/kdoctools/docbook/xsl/lib/lib.xweb b/kdoctools/docbook/xsl/lib/lib.xweb new file mode 100644 index 000000000..e8ee75c0c --- /dev/null +++ b/kdoctools/docbook/xsl/lib/lib.xweb @@ -0,0 +1,772 @@ + + +XSL Library Template Reference +$Id$ + +DocBook Open Repository Team + + 1999 + 2000 + 2001 + 2002 + Norman Walsh + + + +Introduction + +This is technical reference documentation for the DocBook XSL +Stylesheets; it documents (some of) the parameters, templates, and +other elements of the stylesheets. + +This is not intended to be user documentation. +It is provided for developers writing customization layers for the +stylesheets, and for anyone who's interested in how it +works. + +Although I am trying to be thorough, this documentation is known +to be incomplete. Don't forget to read the source, too :-) + + + + +General Library Templates + + + +dot.count +Returns the number of . characters in a string + + +Description + + + + + + + + + + + + + + + + + + + + + + + + + + + +copy-string +Returns count copies of a string + + +Description + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +string.subst +Substitute one text string for another in a string + + +Description + +The string.subst template replaces all +occurances of target in string +with replacement and returns the result. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +xpointer.idref +Extract IDREF from an XPointer + + +Description + +The xpointer.idref template returns the +ID portion of an XPointer which is a pointer to an ID within the current +document, or the empty string if it is not. +In other words, xpointer.idref returns +foo when passed either #foo +or #xpointer(id('foo')), otherwise it returns +the empty string. + + + + http://... + + + + + + + + + + + + + + + + + + + + + + +length-magnitude +Return the unqualified dimension from a length specification + + +Description + +The length-magnitude template returns the +unqualified length ("20" for "20pt") from a dimension. + + + + + + + + + + + + + + + + + + + + + + + + + +length-units +Return the units from a length specification + + +Description + +The length-units template returns the +units ("pt" for "20pt") from a length. If no units are supplied on the +length, the defauilt.units are returned. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +length-spec +Return a fully qualified length specification + + +Description + +The length-spec template returns the +qualified length from a dimension. If an unqualified length is given, +the default.units will be added to it. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Unrecognized unit of measure: + + . + + + + + + + + + + + + + +length-in-points +Returns the size, in points, of a specified length + + +Description + +The length-in-points template converts a length +specification to points and returns that value as an unqualified +number. + + + +There is no way for the template to infer the size of an +em. It relies on the default em.size +which is initially 10 (for 10pt). + +Similarly, converting pixesl to points relies on the +pixels.per.inch parameter which is initially +90. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Unrecognized unit of measure: + + . + + + + + + + + + + + + + +pi-attribute +Extract a pseudo-attribute from a PI + + +Description + +The pi-attribute template extracts a pseudo-attribute +from a processing instruction. For example, given the PI +<?foo bar="1" baz='red'?>, + + + +]]> +will return red. This template returns the first matching +attribute that it finds. Presented with processing instructions that +contain badly formed pseudo-attributes (missing or unbalanced quotes, +for example), the template may silently return erroneous results. + + + + + filename + 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +lookup.key +Retrieve the value associated with a particular key in a table + + +Description + +Given a table of space-delimited key/value pairs, +the lookup.key template extracts the value associated +with a particular key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +xpath.location +Calculate the XPath child-sequence to the current node + + +Description + +The xpath.location template calculates the +absolute path from the root of the tree to the current element node. + + + + + + + + + + / + + + + + + + + + + + + / + + + + + + + + + + + + + +comment-escape-string +Prepare a string for inclusion in an XML comment + + +Description + +The comment-escape-string template returns a string +that has been transformed so that it can safely be output as an XML comment. +Internal occurrences of "--" will be replaced with "- -" and a leading and/or +trailing space will be added to the string, if necessary. + + + + + + + + + + + + + + + + + + + + + + + + +comment-escape-string.recursive +Internal function used by comment-escape-string + + +Description + +The comment-escape-string.recursive template is used +by comment-escape-string. + + + + + + + + + + + + + + + + + + + + + + + + +Relative URI Functions + +Introduction + +These functions manipulate relative URI references. + +The following assumptions must hold true: + + + +All URIs are relative. + + +No URI contains the ../ sequence +which would effectively move up the hierarchy. + + + +If these assumptions do not hold, the results are unpredictable. + + + + + +count.uri.path.depth +Count the number of path components in a relative URI + + +Description + +This function counts the number of path components in a relative URI. + + + + + + + + + + + + + + + + + + + + + + + + + +trim.common.uri.paths +Trim common leading path components from a relative URI + + +Description + +This function trims common leading path components from a relative URI. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +The Stylesheet + +The lib.xsl stylesheet is just a wrapper +around these functions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.1