[xslt] [patch] libexslt man page ideas

[Jonathan Wakely <redi uklinux net>]

This patch would add function prototype and header info to the
libexslt(3) man page, and give more information on linking to and
using the library.  I also tidied up the formatting a bit, following
man(7) conventions and removed parentheses from EXSLT extensions that
are elements not functions.
It would be nice if the paths in FILES were set according to --prefix
but I didn't manage that much.

jon

-- 
Prediction is very difficult, especially about the future.
	- Niels Bohr
Index: libexslt/libexslt.3
===================================================================
RCS file: /cvs/gnome/libxslt/libexslt/libexslt.3,v
retrieving revision 1.1
diff -u -p -r1.1 libexslt.3
--- libexslt/libexslt.3	13 Jun 2003 14:57:43 -0000	1.1
+++ libexslt/libexslt.3	8 Nov 2003 01:27:52 -0000
@@ -1,35 +1,69 @@
-.TH libexslt 3 "15 May 2002"
+.TH LIBEXSLT 3 "04 November 2003" libxslt
 .SH NAME
 libexslt \- extension library for XSLT
+.SH SYNOPSIS
+.B #include <libexslt/exslt.h>
+.sp
+.B void exsltCommonRegister(void);
+.br
+.B void exsltDateRegister(void);
+.br
+.B void exsltDynRegister(void);
+.br
+.B void exsltFuncRegister(void);
+.br
+.B void exsltMathRegister(void);
+.br
+.B void exsltSetsRegister(void);
+.br
+.B void exsltStrRegister(void);
+.br
+.B void exsltRegisterAll(void);
+.br
+.B void exsltSaxonRegister(void);
 .SH DESCRIPTION
 The 
-.I libexslt
-library is used to provide extensions to XSLT functions.
-These extensions come from the EXSLT project (http://www.exslt.org/)
+.B libexslt
+library is used to provide extensions to
+.SM XSLT
+functions. These extensions come from the
+.SM EXSLT
+project <http://www.exslt.org/>
 .LP
-.SH CALLING
-To make use of these functions XSLT, these need to be declared with the
-proper name space
-.SH SUPPORTED FUNCTIONS
-.B COMMON
+.SH USAGE
+To make use of these functions in
+.SM XSLT
+the appropriate namespace must be defined on the
+.B xsl:stylesheet
+element.  To enable support for them in 
+.BR libxslt (3)
+you must call the appropriate functions (listed in the
+.B SYNOPSIS
+section) to register the extensions.  The
+.I xslt-config
+shell script can be used to obtain the necessary flags for
+the pre-processor and linker.
+The supported extensions are:
+.SS COMMON
 .TP 2.2i
 Namespace: http://exslt.org/common
 .TP 2.2i
+See http://www.exslt.org/exsl/index.html for a description.
+.TP 2.2i
 .B node-set()
-convert the given RTF into a node-set
+convert the given RTF into a node-set.
 .TP
 .B object-type()
-returns the type of the given argument
+returns the type of the given argument.
 .TP
-.B document()
+.B document
 Create multiple output documents. See http://www.exslt.org/exsl/elements/document/index.html
-.TP 2.2o
 
-.B MATH
+.SS MATH
 .TP 2.2i
-Namespace: http://exslt/math
+Namespace: http://exslt.org/math
 .TP 2.2i
-For a description see http://www.exslt.org/math/index.html
+See http://www.exslt.org/math/index.html for a description.
 .TP 2.2i
 .B min()
 returns the minimum value of the given node-set
@@ -84,13 +118,12 @@ returns the arc tangent function of the 
 .TP
 .B exp()
 returns the exponential function of the argument.
-.TP 2.2o
 
-.B SETS
+.SS SETS
 .TP 2.2i
-Namespace http://exslt.org/sets
+Namespace: http://exslt.org/sets
 .TP 2.2i
-For a description see http://www.exslt.org/set/index.html
+See http://www.exslt.org/set/index.html for a description.
 .TP 2.2i
 .B difference()
 returns the difference between the two given node-sets.
@@ -109,14 +142,12 @@ returns a node-set of all nodes in the f
 .TP
 .B trailing()
 returns a node-set of all nodes in the first argument that follow the first node in the second argument.
-.TP
-.TP 2.2o
 
-.B DATES and TIMES
+.SS "DATES and TIMES"
 .TP 2.2i
-Namespace http://exslt.org/date-and-times
+Namespace: http://exslt.org/date-and-times
 .TP 2.2i
-For a description see http://www.exslt.org/date/date.html
+See http://www.exslt.org/date/date.html for a description.
 .TP 2.2i
 .B date-time()
 returns the current date and time as a date/time string.
@@ -154,7 +185,7 @@ returns the month of a date as a number.
 .B day-in-month()
 returns the day of a date as a number.
 .TP
-.B day-in-week-in-month()
+.B day-of-week-in-month()
 returns the day-of-the-week in a month of a date as a number.
 .TP
 .B day-in-week()
@@ -189,13 +220,12 @@ returns the duration between the first d
 .TP
 .B duration()
 returns a duration string that represents the given number of seconds since 1970-01-01T00:00:00.
-.TP 2.2o
 
-.B STRINGS
+.SS STRINGS
 .TP 2.2i
-Namespace http://exslt.org/strings
+Namespace: http://exslt.org/strings
 .TP 2.2i
-For a description see http://www.exslt.org/str/index.html
+See http://www.exslt.org/str/index.html for a description.
 .TP 2.2i
 .B tokenize()
 returns a node set of token elements, each containing one token from the string.
@@ -208,33 +238,33 @@ returns a string aligned within another 
 .TP
 .B concat()
 returns the concatenation of the string values of the nodes in that node set.
-.TP 2.2o
 
-.B FUNCTIONS
+.SS FUNCTIONS
 .TP 2.2i
-Namespace http://exslt.org/functions
+Namespace: http://exslt.org/functions
 .TP 2.2i
-For a description see http://www.exslt.org/func/index.html
+See http://www.exslt.org/func/index.html for a description.
 .TP 2.2i
-.B function()
+.B function
 declares an extension function.
 .TP
-.B result()
+.B result
 returns the result of an extension function declared in function().
-.TP 2.2o
-
 .SH FILES
-.TP 2.2i
-.B /usr/lib/libexslt.a
+.TP
+.I /usr/bin/xslt-config
+shell script giving pre-processor and linker flags.
+.TP
+.I /usr/lib/libexslt.a
 static library
 .TP
-.B /usr/lib/libexslt.so
+.I /usr/lib/libexslt.so
 sharable library
 .SH AUTHORS
 Manual page by Heiko W. Rupp (hwr@pilhuhn.de)
-.SH SEE ALSO
-.IR libxslt (3), 
-.IR libxml (3), 
-.IR xsltproc (1), 
-.IR xmllint (1)
+.SH "SEE ALSO"
+.BR libxml (3), 
+.BR libxslt (3), 
+.BR xmllint (1)
+.BR xsltproc (1), 
 .\" end of manual page