[r2003-05-24 16:55:18 by cvscast] Spell-check

Original author: cvscast
Date: 2003-05-24 16:55:18+00:00

INSTALL

@@ -2,9 +2,11 @@ Installation Notes for CDuce
 ============================
 
 CDuce is written in the OCaml programming language. It has been
-sucessfully compiled under Intel Linux, SunOS 5.7, Window XP
+successfully compiled under Intel Linux, SunOS 5.7, Windows XP
 and FreeBSD 4.7.
 
+(See INSTALL.WIN32 for installation under Windows)
+
 ------------------------------------------------------------------------------
 Prerequisites
 ------------------------------------------------------------------------------
@@ -60,7 +62,7 @@ Efficiency issues:
 - OCamlnet: if you plan to load XML file with encodings other than
   UTF-8, it is advised to use the CVS version of OCamlnet:
     http://sourceforge.net/cvs/?group_id=19774  
-  Indeed, the netconversion module in the lastest release (0.95) was
+  Indeed, the netconversion module in the latest release (0.95) was
   very slow, and it has been rewritten since then.
 
 ------------------------------------------------------------------------------
@@ -80,8 +82,8 @@ distribution. It defines the following goals:
   compiles the CDuce web interface interpreter (to be used as a CGI script)
 
 - make local_website
-  compiles in the web/www/ subdirectory the HTML files of CDuce website
-  (including the tutorial)
+  compiles in the web/www/ subdirectory the HTML files for the CDuce website
+  (including the tutorial and manual)
 
 - make all
   equivalent to (make cduce; make dtd2cduce; make local_website)
@@ -99,4 +101,4 @@ PXP_WLEX=false: use ocamllex for parsing UTF-8 XML files
   default: false (ocamllex is faster; wlex is more compact)
 
 E.g.:
-  make cduce NATIVE=false
\ No newline at end of file
+  make cduce NATIVE=false

INSTALL.WIN32

-                 Installation Notes for Windows NT/2000/XT
+                 Installation Notes for Windows NT/2000/XP
                  =========================================
 
 
@@ -7,9 +7,9 @@ RedHat/Cygnus environment Cygwin freely available at
 
 http://www/cygwin.com
 
-The execucatable needs the cygwin1.dll that is distributed 
-under GPL licence. This is not compatible with the CDuce licence.
-For this reason we don not provide binaries but give here detailed 
+The executable needs the cygwin1.dll that is distributed 
+under GPL license. This is not compatible with the CDuce license.
+For this reason we do not provide binaries but give here detailed 
 instructions about how to compile CDuce sources under Cygwin/Windows.
 
 
@@ -66,7 +66,7 @@ Installation notes (you are advised to follow this order):
        Utils/
          diff
          patch
-     then procede with installation
+     then proceed with installation
 
 
 2) Download (we suggest in /usr/src) and install Ocaml
@@ -156,6 +156,6 @@ Efficiency issues:
 - OCamlnet: if you plan to load XML file with encodings other than
   UTF-8, it is advised to use the CVS version of OCamlnet:
     http://sourceforge.net/cvs/?group_id=19774  
-  Indeed, the netconversion module in the lastest release (0.95) was
+  Indeed, the netconversion module in the latest release (0.95) was
   very slow, and it has been rewritten since then.
 

README

@@ -9,7 +9,7 @@ Abstract
 ------------------------------------------------------------------------------
 
 CDuce is a programming language adapted to the manipulation of XML
-documents.  It has been designed and developped as a joint research
+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).
 
@@ -18,8 +18,9 @@ group at LRI (Orsay).
 
 
 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.
+innovative features of the language and to validate design choices.
+It is a research prototype, not a robust application.
+
 
 ------------------------------------------------------------------------------
 Overview of the distribution
@@ -44,7 +45,7 @@ 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
+The option -dump followed by a filename allows persistence 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
@@ -82,5 +83,52 @@ The generated declarations are sent to the standard output.
 
 4. CDuce web site
 
-The source files (XML + CDuce) of the 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 interpreter at:
+<Alain.Frisch@ens.fr>
+
+
+
+  -- The CDuce team

header

-                               CDuce
-
-  Alain Frisch, quipe Langages, Dpartement d'Informatique,
-  cole Normale Suprieure
-
-  This file is distributed under the terms of the Q Public License 
-  version 1.0.
+The CDuce interpreter
+Alain.Frisch@ens.fr
+Copyright 2003 (see LICENSE for details)

web/manual/interpreter.xml

@@ -28,7 +28,7 @@ String* ]</code>, which means sequence of character strings).  </li>
 results).  It is normally used when the CDuce interpreter is used in
 the context of batch processing.  </li>
 
-<li> The option <code>-dump %%filename%%</code> allows persistency
+<li> The option <code>-dump %%filename%%</code> allows persistence
 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
@@ -37,7 +37,7 @@ started again with the same option. Note that only the arguments after
 CDuce program.  </li>
 
 <li> The option <code>-v</code> makes the interpreter print its
-version number and exit immediatly.</li>
+version number and exit immediately.</li>
 
 <li>All the other arguments on the command line are considered CDuce
 scripts, which are executed successively. If no CDuce file is given on

web/manual/types_patterns.xml

@@ -138,7 +138,7 @@ integers, characters, and atoms. To each kind corresponds a family of types.
 <ul>
 <li><b>Integers</b>. 
  <br/>CDuce integers are arbitrarily large. An integer
-  literal is a sequence of decimal digits, plus an optinal leading unary
+  literal is a sequence of decimal digits, plus an optional leading unary
   minus (<code>-</code>) character.
    <ul>
     <li><code>Int</code>: all the integers.</li>
@@ -159,7 +159,7 @@ integers, characters, and atoms. To each kind corresponds a family of types.
   The usual <code>'\n', '\t', '\r'</code> are recognized.
   Arbitrary Unicode codepoints can be written in decimal
   <code>'\%%i%%;</code> (<code>%%i%%</code> is an decimal integer) or
-  in hexadecimal <code>'\x%%i%%;</code>. Any other occurence of 
+  in hexadecimal <code>'\x%%i%%;</code>. Any other occurrence of 
   a backslash character is prohibited.
 
    <ul>
@@ -169,7 +169,7 @@ integers, characters, and atoms. To each kind corresponds a family of types.
 	interval of Unicode character set. E.g.: <code>'a'--'z'</code>. </li>
     <li><code>%%c%%</code> (where <code>%%c%%</code> is an integer
      literal): character singleton type.</li>
-    <li><code>Bytte</code>: all the Latin1 character set 
+    <li><code>Byte</code>: all the Latin1 character set 
 (equivalent to <code>'\0;'--'\255;'</code>).</li>
    </ul>
 </li>