README 4.03 KB
Newer Older
1 2
README - CDuce

3 4
This package is distributed under the terms of an MIT-like License
(see the LICENSE file).
5 6 7 8 9 10 11


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

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
Karoline Malmkjaer's avatar
Karoline Malmkjaer committed
14
group at LRI (Orsay) (http://www.lri.fr/bd).
15 16

The current implementation has been written to demonstrate the
17
innovative features of the language and to validate design choices.
18 19
It is a research prototype, not a robust application. However, it has 
been reported to work properly in a production environment.
20

Karoline Malmkjaer's avatar
Karoline Malmkjaer committed
21 22 23 24
Further information about CDuce is available at

  http://www.cduce.org

25 26

------------------------------------------------------------------------------
27
Source distribution
28 29 30 31
------------------------------------------------------------------------------

See the INSTALL file for Installation instructions.

32
1. CDuce command-line interpreter / toplevel
33

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

37
See the man page or HTML manual for usage.
38 39

When no CDuce file is given on the command line, the interpreter
40 41 42 43
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).
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58


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).

59

60 61
3. dtd2cduce

62
dtd2cduce is small tool that generates CDuce type declarations from
63 64 65 66
a DTD.

Usage: dtd2cduce <prefix> <.dtd file>

67
<prefix> is a string prepended to tag names to form CDuce type names.
68 69
The generated declarations are sent to the standard output.

70 71 72 73 74
dtd2cduce can also operates as a cgi-bin. You can access it using
the form at this URL:

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

75

76 77
4. CDuce web site

78
The source files (XML + CDuce) for the CDuce web site
79
(http://www.cduce.org/) are included in the web/ subdirectory.
80

81 82 83 84 85 86 87 88 89
------------------------------------------------------------------------------
Binary distribution
------------------------------------------------------------------------------

If you have downloaded the "linux static" binary distribution, you got
the cduce and dtd2cduce executables, the man pages, and the web/
subdirectory. To build the website, just do "make".


90 91 92 93 94 95 96 97 98 99 100
------------------------------------------------------------------------------
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

101 102 103
  or generate it locally (make local_website). Note that the online
  version is probably more up-to-date than the one included in the
  distribution.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123


- 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

124 125
- the CDuce users' mailing-list:
  http://www.cduce.org/mailing.html
126

127 128

- and of course the source code!
129

130

131 132 133 134 135
------------------------------------------------------------------------------
Feedback
------------------------------------------------------------------------------

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



  -- The CDuce team