Contents of /cduce/trunk/README

README - CDuce

This package is distributed under the terms of the Q Public License
version 1.0 (see the LICENSE file).


------------------------------------------------------------------------------
Abstract
------------------------------------------------------------------------------

CDuce is a programming language adapted to the manipulation of XML
documents.  It has been designed and developped as a joint research
project between the Languages group at ENS (Paris) and the Database
group at LRI (Orsay).

 [1] http://www.di.ens.fr/~castagna/EQUIPE
 [2] http://www.lri.fr/bd


The current implementation has been written to demonstrate the
innovatives features of the language and to validate design choices.
It is not intended to meet industrial quality criteria.

------------------------------------------------------------------------------
Overview of the distribution
------------------------------------------------------------------------------

See the INSTALL file for Installation instructions.

1. CDuce command-line interpreter

For performance reasons, it is advised to build it using OCaml native
compiler (goal cduce.opt in the Makefile). 

Usage:

./cduce.opt [options] [CDuce files] -- [arguments for the CDuce program]

The arguments following the -- are passed to the CDuce program
in the argv variable (having type [ String* ], which means: sequence
of character strings).

The option -quiet suppresses normal output (typing, results). It is
normally used when the CDuce interpreter is used in the context
of batch processing.

The option -dump followed by a filename allows persistency between
several invocations of the interpreter: the current environment
(defined types and values) is saved to the file when the interpreter
terminates and it is restored if the interpreter is started again with
the same option. Note that only the arguments after -- on the first
invocation in a session are passed to the CDuce program.

When no CDuce file is given on the command line, the interpreter
uses the standard input.


2. CDuce CGI interface

It is also possible to play with CDuce in a web browser, using the
webiface CGI interface (or webiface.opt) program. Of course, You will
need a web server with CGI support. 

There is usually a running version at:

http://www.cduce.org/cgi-bin/cduce

Some features are disabled in the web interface (including
file manipulation).

3. dtd2cduce

dtd2cduce is small tool that generated CDuce type declarations from
a DTD.

Usage: dtd2cduce <prefix> <.dtd file>

<prefix> is a string prepended to tag names to form CDuce type names
(<prefix> must start with a capital letter).

The generated declarations are sent to the standard output.

4. CDuce web site

The source files (XML + CDuce) of the CDuce web site
(http://www.cduce.org/) are included in the web/ subdirectory.
1	abate	370	README - CDuce
2
3			This package is distributed under the terms of the Q Public License
4			version 1.0 (see the LICENSE file).
5
6
7			------------------------------------------------------------------------------
8			Abstract
9			------------------------------------------------------------------------------
10
11			CDuce is a programming language adapted to the manipulation of XML
12			documents. It has been designed and developped as a joint research
13			project between the Languages group at ENS (Paris) and the Database
14			group at LRI (Orsay).
15
16			[1] http://www.di.ens.fr/~castagna/EQUIPE
17			[2] http://www.lri.fr/bd
18
19
20			The current implementation has been written to demonstrate the
21			innovatives features of the language and to validate design choices.
22			It is not intended to meet industrial quality criteria.
23
24			------------------------------------------------------------------------------
25			Overview of the distribution
26			------------------------------------------------------------------------------
27
28			See the INSTALL file for Installation instructions.
29
30			1. CDuce command-line interpreter
31
32			For performance reasons, it is advised to build it using OCaml native
33			compiler (goal cduce.opt in the Makefile).
34
35			Usage:
36
37			./cduce.opt [options] [CDuce files] -- [arguments for the CDuce program]
38
39			The arguments following the -- are passed to the CDuce program
40			in the argv variable (having type [ String* ], which means: sequence
41			of character strings).
42
43			The option -quiet suppresses normal output (typing, results). It is
44			normally used when the CDuce interpreter is used in the context
45			of batch processing.
46
47			The option -dump followed by a filename allows persistency between
48			several invocations of the interpreter: the current environment
49			(defined types and values) is saved to the file when the interpreter
50			terminates and it is restored if the interpreter is started again with
51			the same option. Note that only the arguments after -- on the first
52			invocation in a session are passed to the CDuce program.
53
54			When no CDuce file is given on the command line, the interpreter
55			uses the standard input.
56
57
58			2. CDuce CGI interface
59
60			It is also possible to play with CDuce in a web browser, using the
61			webiface CGI interface (or webiface.opt) program. Of course, You will
62			need a web server with CGI support.
63
64			There is usually a running version at:
65
66			http://www.cduce.org/cgi-bin/cduce
67
68			Some features are disabled in the web interface (including
69			file manipulation).
70
71			3. dtd2cduce
72
73			dtd2cduce is small tool that generated CDuce type declarations from
74			a DTD.
75
76			Usage: dtd2cduce <prefix> <.dtd file>
77
78			<prefix> is a string prepended to tag names to form CDuce type names
79			(<prefix> must start with a capital letter).
80
81			The generated declarations are sent to the standard output.
82
83			4. CDuce web site
84
85			The source files (XML + CDuce) of the CDuce web site
86			(http://www.cduce.org/) are included in the web/ subdirectory.