third_party/libxslt/libexslt/libexslt.3

   1 .TH LIBEXSLT 3 "04 November 2003" libxslt
   2 .SH NAME
   3 libexslt \- extension library for XSLT
   4 .SH SYNOPSIS
   5 .B #include <libexslt/exslt.h>
   6 .sp
   7 .B void exsltCommonRegister(void);
   8 .br
   9 .B void exsltDateRegister(void);
  10 .br
  11 .B void exsltDynRegister(void);
  12 .br
  13 .B void exsltFuncRegister(void);
  14 .br
  15 .B void exsltMathRegister(void);
  16 .br
  17 .B void exsltSetsRegister(void);
  18 .br
  19 .B void exsltStrRegister(void);
  20 .br
  21 .B void exsltRegisterAll(void);
  22 .br
  23 .B void exsltSaxonRegister(void);
  24 .SH DESCRIPTION
  25 The
  26 .B libexslt
  27 library is used to provide extensions to
  28 .SM XSLT
  29 functions. These extensions come from the
  30 .SM EXSLT
  31 project <http://www.exslt.org/>
  32 .LP
  33 .SH USAGE
  34 To make use of these functions in
  35 .SM XSLT
  36 the appropriate namespace must be defined on the
  37 .B xsl:stylesheet
  38 element.  To enable support for them in
  39 .BR libxslt (3)
  40 you must call the appropriate functions (listed in the
  41 .B SYNOPSIS
  42 section) to register the extensions.  The
  43 .I xslt-config
  44 shell script can be used to obtain the necessary flags for
  45 the pre-processor and linker.
  46 The supported extensions are:
  47 .SS COMMON
  48 .TP 2.2i
  49 Namespace: http://exslt.org/common
  50 .TP 2.2i
  51 See http://www.exslt.org/exsl/index.html for a description.
  52 .TP 2.2i
  53 .B node-set()
  54 convert the given RTF into a node-set.
  55 .TP
  56 .B object-type()
  57 returns the type of the given argument.
  58 .TP
  59 .B document
  60 Create multiple output documents. See http://www.exslt.org/exsl/elements/document/index.html
  61
  62 .SS MATH
  63 .TP 2.2i
  64 Namespace: http://exslt.org/math
  65 .TP 2.2i
  66 See http://www.exslt.org/math/index.html for a description.
  67 .TP 2.2i
  68 .B min()
  69 returns the minimum value of the given node-set
  70 .TP
  71 .B max()
  72 returns the maximum value of the given node-set
  73 .TP
  74 .B highest()
  75 returns the nodes in the node-set whose value is the maximum value for the node-set.
  76 .TP
  77 .B lowest()
  78 returns the nodes in the node-set whose value is the minimum value for the node-set.
  79 .TP
  80 .B constant()
  81 returns a number value of the given constant with the given precision. The constants are PI, E, SQRRT2, LN2, LN10, LOG2E, and SQRT1_2.
  82 .TP
  83 .B random()
  84 returns a random number between 0 and 1 inclusive.
  85 .TP
  86 .B abs()
  87 returns the absolute value of the argument.
  88 .TP
  89 .B sqrt()
  90 returns the square root of the argument.
  91 .TP
  92 .B power()
  93 returns the power base and power arguments.
  94 .TP
  95 .B log()
  96 returns the natural log of the argument.
  97 .TP
  98 .B sin()
  99 returns the sine of the argument.
 100 .TP
 101 .B cos()
 102 returns the cosine of the argument.
 103 .TP
 104 .B tan()
 105 returns the tangent of the argument.
 106 .TP
 107 .B asin()
 108 returns the arc sine of the argument.
 109 .TP
 110 .B acos()
 111 returns the arc cosine of the argument.
 112 .TP
 113 .B atan()
 114 returns the arc tangent of the argument.
 115 .TP
 116 .B atan2()
 117 returns the arc tangent function of the y/x arguments.
 118 .TP
 119 .B exp()
 120 returns the exponential function of the argument.
 121
 122 .SS SETS
 123 .TP 2.2i
 124 Namespace: http://exslt.org/sets
 125 .TP 2.2i
 126 See http://www.exslt.org/set/index.html for a description.
 127 .TP 2.2i
 128 .B difference()
 129 returns the difference between the two given node-sets.
 130 .TP
 131 .B intersection()
 132 returns a node-set of the nodes within both given node-sets.
 133 .TP
 134 .B distinct()
 135 returns a node-set of all nodes in the first argument that are not in the seconds argument.
 136 .TP
 137 .B has-same-node()
 138 returns TRUE if there is an intersection between the two given node-sets.
 139 .TP
 140 .B leading()
 141 returns a node-set of all nodes in the first argument that precede the first node in the second argument.
 142 .TP
 143 .B trailing()
 144 returns a node-set of all nodes in the first argument that follow the first node in the second argument.
 145
 146 .SS "DATES and TIMES"
 147 .TP 2.2i
 148 Namespace: http://exslt.org/dates-and-times
 149 .TP 2.2i
 150 See http://www.exslt.org/date/date.html for a description.
 151 .TP 2.2i
 152 .B date-time()
 153 returns the current date and time as a date/time string.
 154 .TP
 155 .B date()
 156 returns the date specified in the given date/time string.
 157 .TP
 158 .B time()
 159 returns the time specified in the date/time string given as the argument.
 160 .TP
 161 .B year()
 162 returns the year of a date as a number.
 163 .TP
 164 .B leap-year()
 165 returns true if the year given in a date is a leap year.
 166 .TP
 167 .B month-in-year()
 168 returns the month of a date as a number.
 169 .TP
 170 .B month-name()
 171 returns the full name of the month of a date.
 172 .TP
 173 .B month-abbreviation()
 174 returns the abbreviation of the month of a date.
 175 .TP
 176 .B week-in-year()
 177 returns the week of the year as a number.
 178 .TP
 179 .B week-in-month()
 180 returns the week in a month of a date as a number.
 181 .TP
 182 .B day-in-year()
 183 returns the month of a date as a number.
 184 .TP
 185 .B day-in-month()
 186 returns the day of a date as a number.
 187 .TP
 188 .B day-of-week-in-month()
 189 returns the day-of-the-week in a month of a date as a number.
 190 .TP
 191 .B day-in-week()
 192 returns the day of the week given in a date as a number.
 193 .TP
 194 .B day-name()
 195 returns the full name of the day of the week of a date.
 196 .TP
 197 .B day-abbreviation()
 198 returns the abbreviation of the day of the week of a date.
 199 .TP
 200 .B hour-in-day()
 201 returns the hour of the day as a number.
 202 .TP
 203 .B minute-in-hour()
 204 returns the minute of the hour as a number.
 205 .TP
 206 .B second-in-minute()
 207 returns the second of the minute as a number.
 208 .TP
 209 .B seconds()
 210 returns the number of seconds specified by the argument string.
 211 .TP
 212 .B add()
 213 returns the date/time resulting from adding a duration to a date/time.
 214 .TP
 215 .B add-duration()
 216 returns the duration resulting from adding two given durations together.
 217 .TP
 218 .B difference()
 219 returns the duration between the first date and the second date.
 220 .TP
 221 .B duration()
 222 returns a duration string that represents the given number of seconds since 1970-01-01T00:00:00.
 223
 224 .SS STRINGS
 225 .TP 2.2i
 226 Namespace: http://exslt.org/strings
 227 .TP 2.2i
 228 See http://www.exslt.org/str/index.html for a description.
 229 .TP 2.2i
 230 .B tokenize()
 231 returns a node set of token elements, each containing one token from the string.
 232 .TP
 233 .B padding()
 234 returns a string padded to a certain length.
 235 .TP
 236 .B align()
 237 returns a string aligned within another string.
 238 .TP
 239 .B concat()
 240 returns the concatenation of the string values of the nodes in that node set.
 241
 242 .SS FUNCTIONS
 243 .TP 2.2i
 244 Namespace: http://exslt.org/functions
 245 .TP 2.2i
 246 See http://www.exslt.org/func/index.html for a description.
 247 .TP 2.2i
 248 .B function
 249 declares an extension function.
 250 .TP
 251 .B result
 252 returns the result of an extension function declared in function().
 253 .SH FILES
 254 .TP
 255 .I /usr/bin/xslt-config
 256 shell script giving pre-processor and linker flags.
 257 .TP
 258 .I /usr/lib/libexslt.a
 259 static library
 260 .TP
 261 .I /usr/lib/libexslt.so
 262 sharable library
 263 .SH AUTHORS
 264 Manual page by Heiko W. Rupp (hwr@pilhuhn.de)
 265 .SH "SEE ALSO"
 266 .BR libxml (3),
 267 .BR libxslt (3),
 268 .BR xmllint (1)
 269 .BR xsltproc (1),
 270 .\" end of manual page