Re: [xslt] [patch] improve libexslt man page

[Jonathan Wakely <cow compsoc man ac uk>]

On Wed, Apr 23, 2003 at 03:17:40AM -0400, Daniel Veillard wrote:

> On Tue, Apr 22, 2003 at 10:08:57PM +0100, Jonathan Wakely wrote:
> > 
> > Following on from this mail
> > http://mail.gnome.org/archives/xslt/2003-January/msg00038.html
> > (a mere 3 months later!) here is a patch to improve the libexslt man
> > page.

And after another delay here's the patch. This improves the libexslt man
page and installs it in section 3 (Libraries). The libexslt.4 file must
be renamed to libexslt.3 when libexslt/Makefile.am is patched.

A second patch is attached to do the same for the libxslt.4 man page,
which already claims to be in section 3, but is actualy installed in
section 4.  Again, the libxslt.4 file will need to be renamed to
libxslt.3 after libxslt/Makefile.am is patched.

Sorry for the delay in getting back to this. I hope the patches are OK,

jon

Index: libexslt/Makefile.am
===================================================================
RCS file: /cvs/gnome/libxslt/libexslt/Makefile.am,v
retrieving revision 1.17
diff -u -p -r1.17 Makefile.am
--- libexslt/Makefile.am	30 May 2002 21:36:57 -0000	1.17
+++ libexslt/Makefile.am	5 May 2003 20:14:39 -0000
@@ -30,6 +30,6 @@ libexslt_la_SOURCES =                   
 libexslt_la_LIBADD = $(INSTALLED_XSLT_LIB) $(EXTRA_LIBS)
 libexslt_la_LDFLAGS = -version-info @LIBEXSLT_VERSION_INFO@
 
-man_MANS = libexslt.4
+man_MANS = libexslt.3
 
 EXTRA_DIST = $(man_MANS)
Index: libexslt/libexslt.4
===================================================================
RCS file: /cvs/gnome/libxslt/libexslt/libexslt.4,v
retrieving revision 1.3
diff -u -p -r1.3 libexslt.4
--- libexslt/libexslt.4	21 May 2002 06:42:59 -0000	1.3
+++ libexslt/libexslt.4	5 May 2003 20:14:39 -0000
@@ -1,17 +1,49 @@
 .TH libexslt 4 "15 May 2002"
 .SH NAME
 libexslt \- extension library for XSLT
+.SH SYNOPSIS
+.B #include <libxslt/libexslt.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);
+.sp
+.B cc
+.I file.c
+.B \-lexslt
 .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/)
+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
+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 
+.IR libxslt(3)
+you must call the appropriate functions to register the extensions.
 .SH SUPPORTED FUNCTIONS
-.B COMMON
+.SS COMMON
 .TP 2.2i
 Namespace: http://exslt.org/common
 .TP 2.2i
@@ -23,13 +55,12 @@ returns the type of the given argument
 .TP
 .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 +115,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 +139,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.
@@ -189,13 +217,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,20 +235,18 @@ 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()
 declares an extension function.
 .TP
 .B result()
 returns the result of an extension function declared in function().
-.TP 2.2o
 
 .SH FILES
 .TP 2.2i
Index: libxslt/Makefile.am
===================================================================
RCS file: /cvs/gnome/libxslt/libxslt/Makefile.am,v
retrieving revision 1.31
diff -u -p -r1.31 Makefile.am
--- libxslt/Makefile.am	10 Oct 2002 15:26:25 -0000	1.31
+++ libxslt/Makefile.am	5 May 2003 20:14:15 -0000
@@ -51,7 +51,7 @@ libxslt_la_SOURCES = 			\
 libxslt_la_LIBADD = $(EXTRA_LIBS)
 libxslt_la_LDFLAGS = -version-info @LIBXSLT_VERSION_INFO@
 
-man_MANS = libxslt.4
+man_MANS = libxslt.3
 
 EXTRA_DIST = $(man_MANS)