cgi-bin/viewcvs.cgi/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 developed 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
innovative features of the language and to validate design choices.
It is a research prototype, not a robust application.


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

See the INSTALL file for Installation instructions.

1. CDuce command-line interpreter / toplevel

For performance reasons, it is advised to build it using OCaml native code
compiler (by default in the Makefile).

See the man page or HTML manual for usage.

When no CDuce file is given on the command line, the interpreter
behaves as a toplevel. Phrases are interpreted when the user type
";;". Of course, mutually recursive definition (types or functions)
must be entirely contained in an adjacent sequence of phrases
(without ";;" inbetween).


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) for the CDuce web site
(http://www.cduce.org/) are included in the web/ subdirectory.

------------------------------------------------------------------------------
Documentation
------------------------------------------------------------------------------

There are several sources of information concerning CDuce:

- we started to write a manual and a tutorial as part of the web site. 
  You can find the manual at:

  http://www.cduce.org/manual.html

  or generate it locally (make local_website).


- papers about CDuce:

  http://www.cduce.org/papers.html


- code examples:

  In the web site:
  http://www.cduce.org/examples.html
  http://www.cduce.org/bench.html
  
  In the distribution: 
  web/site.cd
  web/examples/build.cd

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


- and of course the interpreter source code !


------------------------------------------------------------------------------
Feedback
------------------------------------------------------------------------------

We'll appreciate any feedback (comments, suggestions, questions,
bug reports, ...) concerning the CDuce language or this early release
of the interpreter at info@cduce.org


  -- The CDuce team
1	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 developed 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	innovative features of the language and to validate design choices.
22	It is a research prototype, not a robust application.
23
24
25	------------------------------------------------------------------------------
26	Overview of the distribution
27	------------------------------------------------------------------------------
28
29	See the INSTALL file for Installation instructions.
30
31	1. CDuce command-line interpreter / toplevel
32
33	For performance reasons, it is advised to build it using OCaml native code
34	compiler (by default in the Makefile).
35
36	See the man page or HTML manual for usage.
37
38	When no CDuce file is given on the command line, the interpreter
39	behaves as a toplevel. Phrases are interpreted when the user type
40	";;". Of course, mutually recursive definition (types or functions)
41	must be entirely contained in an adjacent sequence of phrases
42	(without ";;" inbetween).
43
44
45	2. CDuce CGI interface
46
47	It is also possible to play with CDuce in a web browser, using the
48	webiface CGI interface (or webiface.opt) program. Of course, You will
49	need a web server with CGI support.
50
51	There is usually a running version at:
52
53	http://www.cduce.org/cgi-bin/cduce
54
55	Some features are disabled in the web interface (including
56	file manipulation).
57
58	3. dtd2cduce
59
60	dtd2cduce is small tool that generated CDuce type declarations from
61	a DTD.
62
63	Usage: dtd2cduce <prefix> <.dtd file>
64
65	<prefix> is a string prepended to tag names to form CDuce type names
66	(<prefix> must start with a capital letter).
67
68	The generated declarations are sent to the standard output.
69
70	4. CDuce web site
71
72	The source files (XML + CDuce) for the CDuce web site
73	(http://www.cduce.org/) are included in the web/ subdirectory.
74
75	------------------------------------------------------------------------------
76	Documentation
77	------------------------------------------------------------------------------
78
79	There are several sources of information concerning CDuce:
80
81	- we started to write a manual and a tutorial as part of the web site.
82	You can find the manual at:
83
84	http://www.cduce.org/manual.html
85
86	or generate it locally (make local_website).
87
88
89	- papers about CDuce:
90
91	http://www.cduce.org/papers.html
92
93
94	- code examples:
95
96	In the web site:
97	http://www.cduce.org/examples.html
98	http://www.cduce.org/bench.html
99
100	In the distribution:
101	web/site.cd
102	web/examples/build.cd
103
104	Online prototype:
105	http://www.cduce.org/cgi-bin/cduce
106
107
108	- and of course the interpreter source code !
109
110
111	------------------------------------------------------------------------------
112	Feedback
113	------------------------------------------------------------------------------
114
115	We'll appreciate any feedback (comments, suggestions, questions,
116	bug reports, ...) concerning the CDuce language or this early release
117	of the interpreter at info@cduce.org
118
119
120
121	-- The CDuce team