documentation written; some weird constructors excluded from demo

author: aarne <aarne@cs.chalmers.se> 2008-06-27 14:14:01 +0000
committer: aarne <aarne@cs.chalmers.se> 2008-06-27 14:14:01 +0000
commit: 21c457b711d8e9544c72e466c7d85204c82711f5 (patch)
tree: 711e25aee0ad39b4b804802e8f7b2c44045dd63e
parent: 73e401cee21fa61dcf9900d8d2b40ddd39f4e612 (diff)
8 files changed, 241 insertions, 99 deletions
diff --git a/demos/index.html b/demos/index.html
new file mode 100644
index 000000000..9582581fb
--- /dev/null
+++ b/demos/index.html
@@ -0,0 +1,42 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+<META NAME="generator" CONTENT="http://txt2tags.sf.net">
+<TITLE>Grammatical Framework Demos</TITLE>
+</HEAD><BODY BGCOLOR="white" TEXT="black">
+<P ALIGN="center"><CENTER><H1>Grammatical Framework Demos</H1>
+<FONT SIZE="4">
+</FONT></CENTER>
+
+<P>
+<A HREF="http://www.cs.chalmers.se/~markus/gramlets/letter-applet.html">Letter editor</A>: compose
+a letter in a language you don't know.
+</P>
+<P>
+<A HREF="http://www.cs.chalmers.se/~bringert/gf/translate/">Numeral translator</A>: see 
+number words in 88 languages.
+</P>
+<P>
+<A HREF="http://www.cs.chalmers.se/~bringert/xv/pizza/">Pizza</A>: order a pizza by speaking
+to your web browser.
+</P>
+<P>
+<A HREF="http://www.restauranggajden.se/tomas/">Restauranggajden</A>: write and read
+restaurant reviews in a multilingual Wiki.
+</P>
+<P>
+<A HREF="http://webalt.math.helsinki.fi/PublicFiles/CD/Screencast/TextMathEditor%20Demo.swf">WebALT Math Editor</A>:
+create mathematical exercises in six languages simultaneously.
+</P>
+<P>
+<A HREF="http://www.cs.chalmers.se/~bringert/misc/tramdemo.avi">Tramdemo</A>: find your way in
+Gothenburg public transport system, in six languages (film).
+</P>
+<P>
+<A HREF="resource-api/editor.html">Library API browser-editor</A>: construct phrases in
+the <A HREF="lib/resource/doc/synopsis.html">GF resource library</A>
+</P>
+
+<!-- html code generated by txt2tags 2.4 (http://txt2tags.sf.net) -->
+<!-- cmdline: txt2tags -thtml demos/index.txt -->
+</BODY></HTML>
diff --git a/demos/index.txt b/demos/index.txt
new file mode 100644
index 000000000..a505275d4
--- /dev/null
+++ b/demos/index.txt
@@ -0,0 +1,26 @@
+Grammatical Framework Demos
+
+
+
+
+[Letter editor http://www.cs.chalmers.se/~markus/gramlets/letter-applet.html]: compose
+a letter in a language you don't know.
+
+[Numeral translator http://www.cs.chalmers.se/~bringert/gf/translate/]: see 
+number words in 88 languages.
+
+[Pizza http://www.cs.chalmers.se/~bringert/xv/pizza/]: order a pizza by speaking
+to your web browser.
+
+[Restauranggajden http://www.restauranggajden.se/tomas/]: write and read
+restaurant reviews in a multilingual Wiki.
+
+[WebALT Math Editor  http://webalt.math.helsinki.fi/PublicFiles/CD/Screencast/TextMathEditor%20Demo.swf]:
+create mathematical exercises in six languages simultaneously.
+
+[Tramdemo http://www.cs.chalmers.se/~bringert/misc/tramdemo.avi]: find your way in
+Gothenburg public transport system, in six languages (film).
+
+[Library API browser-editor resource-api/editor.html]: construct phrases in
+the [GF resource library ../lib/resource/doc/synopsis.html]
+
diff --git a/doc/gf3-release.html b/doc/gf3-release.html
index 4f81e8a55..75557c94a 100644
--- a/doc/gf3-release.html
+++ b/doc/gf3-release.html
@@ -7,6 +7,7 @@
 <P ALIGN="center"><CENTER><H1>GF 3.0</H1>
 <FONT SIZE="4">
 <I>Krasimir Angelov, Björn Bringert, and Aarne Ranta</I><BR>
+Beta release, 27 June 2008
 </FONT></CENTER>
 
 <P>
@@ -15,10 +16,6 @@ language in 2.9, which means backward compatibility. But the target languages, t
 compiler implementation, and the functionalities (e.g. the shell) have undergone
 radical changes. 
 </P>
-<P>
-The release of GF 3.0 is projected for 27 June. As usual, the developing sources
-are available all the time via Darcs.
-</P>
 <H2>New features</H2>
 <P>
 Here is a summary of the main novelties visible to the user:
@@ -38,22 +35,25 @@ Here is a summary of the main novelties visible to the user:
   the shell, and the compiler are accessible via high-level APIs.
 <LI><B>Resource library version 1.4</B>: more coverage, more languages; some of
   the new GF language features are exploited.
+<LI><B>Uniform character encoding</B>: UTF8 in generated files, user-definable in
+  source files
 </UL>
 
 <H2>Non-supported features</H2>
 <P>
-There are some features of GF 2.9 that will <I>not</I> work in the 2.7 June release.
+There are some features of GF 2.9 that will <I>not</I> work in the 3.0 beta release.
 </P>
 <UL>
 <LI>Java Editor GUI: we now see the JavaScript editor as the main form of 
   syntax editing.
 <LI>Pre-module multi-file grammar format: the grammar format of GF before version 2.0 
-  is still supported, but its include mechanism is not; this means that grammars 
-  consisting of multiple files have to be concatenated before use.
+  is still not yet supported.
+<LI>Context-free and EBNF input grammar formats.
 <LI>Probabilistic GF grammars.
 <LI>Some output formats: LBNF.
 <LI>Some GF shell commands: while the main ones will be supported with their familiar
-  syntax and options, some old commands have not been included.
+  syntax and options, some old commands have not been included. The GF shell
+  command <CODE>help -changes</CODE> gives the actual list.
 </UL>
 
 <P>
@@ -69,5 +69,5 @@ Inheritance of overload groups.
 </P>
 
 <!-- html code generated by txt2tags 2.4 (http://txt2tags.sf.net) -->
-<!-- cmdline: txt2tags -thtml gf3-release.txt -->
+<!-- cmdline: txt2tags -thtml doc/gf3-release.txt -->
 </BODY></HTML>
diff --git a/doc/gf3-release.txt b/doc/gf3-release.txt
index b065b4582..631752c90 100644
--- a/doc/gf3-release.txt
+++ b/doc/gf3-release.txt
@@ -1,6 +1,6 @@
 GF 3.0
 Krasimir Angelov, Björn Bringert, and Aarne Ranta
-
+Beta release, 27 June 2008
 
 
 GF Version 3.0 is a major revision of GF. The source language is a superset of the
@@ -8,9 +8,6 @@ language in 2.9, which means backward compatibility. But the target languages, t
 compiler implementation, and the functionalities (e.g. the shell) have undergone
 radical changes. 
 
-The release of GF 3.0 is projected for 27 June. As usual, the developing sources
-are available all the time via Darcs.
-
 
 ==New features==
 
@@ -29,20 +26,23 @@ Here is a summary of the main novelties visible to the user:
   the shell, and the compiler are accessible via high-level APIs.
 - **Resource library version 1.4**: more coverage, more languages; some of
   the new GF language features are exploited.
+- **Uniform character encoding**: UTF8 in generated files, user-definable in
+  source files
 
 
 ==Non-supported features==
 
-There are some features of GF 2.9 that will //not// work in the 2.7 June release.
+There are some features of GF 2.9 that will //not// work in the 3.0 beta release.
 - Java Editor GUI: we now see the JavaScript editor as the main form of 
   syntax editing.
 - Pre-module multi-file grammar format: the grammar format of GF before version 2.0 
-  is still supported, but its include mechanism is not; this means that grammars 
-  consisting of multiple files have to be concatenated before use.
+  is still not yet supported.
+- Context-free and EBNF input grammar formats.
 - Probabilistic GF grammars.
 - Some output formats: LBNF.
 - Some GF shell commands: while the main ones will be supported with their familiar
-  syntax and options, some old commands have not been included.
+  syntax and options, some old commands have not been included. The GF shell
+  command ``help -changes`` gives the actual list.
 
 
 Users who want to have these features are welcome to contact us, 
diff --git a/download/index.html b/download/index.html
index d2366c808..b1fd1774f 100644
--- a/download/index.html
+++ b/download/index.html
@@ -1,56 +1,72 @@
-<html>
-<body>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+<META NAME="generator" CONTENT="http://txt2tags.sf.net">
+<TITLE>Grammatical Framework Download and Installation</TITLE>
+</HEAD><BODY BGCOLOR="white" TEXT="black">
+<P ALIGN="center"><CENTER><H1>Grammatical Framework Download and Installation</H1>
+<FONT SIZE="4">
+</FONT></CENTER>
 
-GF Version 2.9, released 21 December 2007 as sources:
-<ul>
-<li> <a href="GF-2.9.tgz"><tt>GF-2.9.tgz</tt></a>, 
-Haskell and Java sources, grammar library sources, examples, documentation.
-To compile and install: read <a href="../src/INSTALL"><tt>src/INSTALL</tt></a>.
+<H2>Latest developer code</H2>
+<P>
+<A HREF="../doc/darcs.html">GF darcs repository</A>
+</P>
+<H2>Latest release</H2>
+<P>
+<A HREF="gf-3.0beta-linux.gz">GF 3.0 beta Linux binary</A> (Intel, Ubuntu)
+</P>
+<P>
+<A HREF="gf-3.0beta-mac.gz">GF 3.0 beta MacOS X binary</A> (Intel Mac with Leopard)
+</P>
+<P>
+<A HREF="gf-3.0beta-mac.exe">GF 3.0 beta Windows binary</A>
+</P>
+<P>
+<A HREF="gf-3.0beta.tgz">GF 3.0 beta sources</A>
+</P>
+<P>
+<A HREF="gf-lib-1.4.tgz">GF libraries v 1.4</A> (compiled resource grammar libraries)
+</P>
+<H2>Old releases</H2>
+<P>
+<A HREF="../GF2/download/index.html">GF 2.9 download page</A>
+</P>
+<H2>Installation instructions</H2>
+<P>
+To compile and install from source: 
+</P>
+<PRE>
+    tar xvfz gf-3.0beta.tgz
+    cd GF/src
+    autoconf
+    ./configure
+    make
+    make install
+</PRE>
+<P>
+To install a binary,
+</P>
+<PRE>
+    tar xvfz BINARY-PACKAGE.tgz
+    cd GF-...
+    ./configure
+    make install
+</PRE>
+<P>
+You may need <CODE>sudo make install</CODE>. 
+If you cannot write in <CODE>/usr/local/</CODE>, you can change the target directory
+by <CODE>./configure --prefix=MYDIR</CODE>.
+</P>
+<P>
+The Mac OS X binary (Intel) requires Readline from
+<A HREF="http://www.macports.org/">Mac Ports</A>. To install, see above item.
+</P>
+<P>
+The Windows binary is easiest if you have
+<A HREF="http://www.cygwin.com/">Cygwin</A>. To install, see above item.
+</P>
 
-<li> <a href="GF-2.9-lib.tgz"><tt>GF-2.9-lib.tgz</tt></a>,
-Compiled grammar libraries</a>. To install: 
-unpack this in the directory pointed by <tt>GF_LIB_PATH</tt>.
-</ul>
-Binaries: GF Version 2.8, released 8 July 2007; updated 12 September.
-<ul>
-<li> <a href="GF-2.8-i386-pc-linux-gnu.tgz"><tt>GF-2.8-i386-pc-linux-gnu.tgz</tt></a>,
-Linux binary, with precompiled grammar libraries. To install:
-<pre>
-  tar xvfz GF-2.8-i386-pc-linux-gnu.tgz
-  cd GF-2.8-i386-pc-linux-gnu
-  ./configure
-  make install
-</pre>
-You may need <tt>sudo make install</tt>; if you cannot write in 
-<tt>/usr/local/</tt>, you can change the target directory
-by <tt>./configure --prefix=MYDIR</tt>.
-
-
-<li> <a href="GF-2.8-i386-apple-darwin8.9.1.tgz"><tt>GF-2.8-i386-apple-darwin8.9.1.tgz</tt></a>, Mac OS X binary (Intel), with precompiled grammar libraries. Requires Readline from
-<a href="http://www.macports.org/">MacPorts</a>. To install, see above item.
-
-<li> <a href="GF-2.8-windows-cygwin.tgz"><tt>GF-2.8-windows-cygwin.tgz</tt></a>, Windows Cygwin binary. Requires 
-<a href="http://www.cygwin.com/">Cygwin</a>. To install, see above item.
-
-</ul>
-The <a href=
-"http://sourceforge.net/project/showfiles.php?group_id=132285">Sourceforge GF site</a> 
-has currently only v 2.7 and older versions.
-
-<p>
-
-Don't forget that you can always get the current sources from the
-<a href="http://www.cs.chalmers.se/Cs/Research/Language-technology/darcs/GF/doc/darcs.html">GF Darcs Repository</a>. First time you do
-<pre>
-  darcs get --partial --set-scripts-executable http://www.cs.chalmers.se/Cs/Research/Language-technology/darcs/GF/
-</pre>
-and subsequent times
-<pre>
-  darcs pull -a
-</pre>
-Then compile and install as described in 
-<a href="src/INSTALL"><tt>GF/src/INSTALL</tt></a>.
-
-
-</body>
-</html>
+<!-- html code generated by txt2tags 2.4 (http://txt2tags.sf.net) -->
+<!-- cmdline: txt2tags -thtml download/index.txt -->
+</BODY></HTML>
diff --git a/download/index.txt b/download/index.txt
new file mode 100644
index 000000000..b036e0ccc
--- /dev/null
+++ b/download/index.txt
@@ -0,0 +1,53 @@
+Grammatical Framework Download and Installation
+
+
+==Latest developer code==
+
+[GF darcs repository  ../doc/darcs.html]
+
+==Latest release==
+
+[GF 3.0 beta Linux binary    gf-3.0beta-linux.gz] (Intel, Ubuntu)
+
+[GF 3.0 beta MacOS X binary  gf-3.0beta-mac.gz] (Intel Mac with Leopard)
+
+[GF 3.0 beta Windows binary  gf-3.0beta-mac.exe]
+
+[GF 3.0 beta sources         gf-3.0beta.tgz]
+
+[GF libraries v 1.4          gf-lib-1.4.tgz] (compiled resource grammar libraries)
+
+
+==Old releases==
+
+[GF 2.9 download page ../GF2/download/index.html]
+
+
+==Installation instructions==
+
+To compile and install from source: 
+```
+  tar xvfz gf-3.0beta.tgz
+  cd GF/src
+  autoconf
+  ./configure
+  make
+  make install
+```
+To install a binary,
+```
+  tar xvfz BINARY-PACKAGE.tgz
+  cd GF-...
+  ./configure
+  make install
+```
+You may need ``sudo make install``. 
+If you cannot write in ``/usr/local/``, you can change the target directory
+by ``./configure --prefix=MYDIR``.
+
+The Mac OS X binary (Intel) requires Readline from
+[Mac Ports http://www.macports.org/]. To install, see above item.
+
+The Windows binary is easiest if you have
+[Cygwin http://www.cygwin.com/]. To install, see above item.
+
diff --git a/index.html b/index.html
index 6146230c0..6d046daf6 100644
--- a/index.html
+++ b/index.html
@@ -23,8 +23,8 @@ June 2008
 <font size=+2>
 </P>
 <P>
-<CODE>[</CODE> <A HREF="demos/">Demos</A>
-<CODE>|</CODE> <A HREF="download">Download</A>
+<CODE>[</CODE> <A HREF="demos/index.html">Demos</A>
+<CODE>|</CODE> <A HREF="download/index.html">Download</A>
 <CODE>|</CODE> <A HREF="lib/resource/doc/synopsis.html">Libraries</A>
 <CODE>|</CODE> <A HREF="doc/gf-refman.html">Reference</A>
 <CODE>|</CODE> <A HREF="doc/gf-tutorial.html">Tutorial</A>
@@ -34,14 +34,15 @@ June 2008
 </font>
 </P>
 <P>
-<CODE>[</CODE> <A HREF="demos/">Demos</A>
-<CODE>|</CODE> <A HREF="download">Download</A>
+<CODE>[</CODE> <A HREF="demos/index.html">Demos</A>
+<CODE>|</CODE> <A HREF="download/index.html">Download</A>
 <CODE>|</CODE> <A HREF="doc/darcs.html">Developers</A>
 <CODE>|</CODE> <A HREF="doc/events.html">Events</A>
-<CODE>|</CODE> <A HREF="lib/">Libraries</A>
+<CODE>|</CODE> <A HREF="lib/resource/doc/synopsis.html">Libraries</A>
 <CODE>|</CODE> <A HREF="doc/gf-people.html">People</A>
 <CODE>|</CODE> <A HREF="doc/projects.html">Projects</A>
 <CODE>|</CODE> <A HREF="doc/gf-tutorial.html">Publications</A>
+<CODE>|</CODE> <A HREF="doc/gf-reference.html">QuickRefCard</A>
 <CODE>|</CODE> <A HREF="doc/gf-refman.html">Reference</A>
 <CODE>|</CODE> <A HREF="doc/gf-tutorial.html">Tutorial</A>
 <CODE>]</CODE> 
@@ -54,7 +55,8 @@ June 2008
 </P>
 <H2>News</H2>
 <P>
-27 June 2008: release of GF 3.0 and a new web page; the old web page is 
+27 June 2008: 
+<A HREF="doc/gf3-relesase.html">release of GF 3.0</A> and this new web page; the old web page is 
 <A HREF="index-2.html">here</A>.
 </P>
 <P>
diff --git a/index.txt b/index.txt
index 4fd1fe56d..52976c41e 100644
--- a/index.txt
+++ b/index.txt
@@ -21,8 +21,8 @@ June 2008
 
 #BELARGE
 
-``[`` [Demos demos/]
-``|`` [Download download]
+``[`` [Demos demos/index.html]
+``|`` [Download download/index.html]
 ``|`` [Libraries lib/resource/doc/synopsis.html]
 ``|`` [Reference doc/gf-refman.html]
 ``|`` [Tutorial doc/gf-tutorial.html]
@@ -30,14 +30,15 @@ June 2008
 
 #ENLARGE
 
-``[`` [Demos demos/]
-``|`` [Download download]
+``[`` [Demos demos/index.html]
+``|`` [Download download/index.html]
 ``|`` [Developers doc/darcs.html]
 ``|`` [Events doc/events.html]
-``|`` [Libraries lib/]
+``|`` [Libraries lib/resource/doc/synopsis.html]
 ``|`` [People doc/gf-people.html]
 ``|`` [Projects doc/projects.html]
 ``|`` [Publications doc/gf-tutorial.html]
+``|`` [QuickRefCard doc/gf-reference.html]
 ``|`` [Reference doc/gf-refman.html]
 ``|`` [Tutorial doc/gf-tutorial.html]
 ``]`` 
@@ -49,7 +50,8 @@ June 2008
 
 ==News==
 
-27 June 2008: release of GF 3.0 and a new web page; the old web page is 
+27 June 2008: 
+[release of GF 3.0 doc/gf3-relesase.html] and this new web page; the old web page is 
 [here index-2.html].
 
 
@@ -91,22 +93,23 @@ GF can be used for building
 
 ==Availability==
 
-GF is **open-source**, licensed under [GPL ] (the program) and [LGPL ] (the libraries). It
+GF is **open-source**, licensed under [GPL LICENSE] (the program) and 
+[LGPL lib/LICENSE] (the libraries). It
 is available for 
-- [Linux ]
-- [Mac OS X ]
-- [Windows ]
-- via compilation to [JavaScript ], almost any platform that has a web browser
+- Linux
+- Mac OS X
+- Windows
+- via compilation to JavaScript, almost any platform that has a web browser
 
 
 ==Projects==
 
-GF was born in 1998 at Xerox Research Centre Europe, Grenoble in the project
+GF was first created in 1998 at Xerox Research Centre Europe, Grenoble in the project
 Multilingual Document Authoring. At Xerox, it was used for prototypes including
-a restaurant phrase book in 6 languages,
-a database query system in 7 languages,
+a restaurant phrase book,
+a database query system,
 a formalization of an alarm system instructions with translations to 5 languages, and
-an authoring system for medical drug descriptions in 2 languages.
+an authoring system for medical drug descriptions.
 
 Later projects using GF and involving third parties include, in chronological order,
 - GF-Alfa: natural language interface to formal proofs
@@ -123,13 +126,13 @@ fifty [scientific publications ].
 
 ==Programming in GF==
 
-GF is easy to learn by following the [tutorial doc/gf-tutorial.html]. You can write your
-first translator in 15 minutes.
+GF is easy to learn by following the [tutorial doc/gf-tutorial.html]. 
+You can write your first translator in 15 minutes.
 
-GF has an interactive command interpreter, as well as a batch compiler. Grammars can be
-compiled to parser and translator code in many different formats.  These components can 
-then be embedded in applications written in other programming languages. The formats
-currently supported are:
+GF has an interactive command interpreter, as well as a batch compiler. 
+Grammars can be compiled to parser and translator code in many different 
+formats.  These components can then be embedded in applications written 
+in other programming languages. The formats currently supported are:
 - Haskell
 - Java
 - JavaScript
@@ -170,7 +173,7 @@ support for an increasing number of languages, currently including
 
 
 Adding a language to the resource library takes 3 to 9 
-months - [contributions doc/projects.html]
+months - [contributions doc/gf-projects.html]
 are welcome!
 
 % [doc/10lang-small.png]
author	aarne <aarne@cs.chalmers.se>	2008-06-27 14:14:01 +0000
committer	aarne <aarne@cs.chalmers.se>	2008-06-27 14:14:01 +0000
commit	21c457b711d8e9544c72e466c7d85204c82711f5 (patch)
tree	711e25aee0ad39b4b804802e8f7b2c44045dd63e
parent	73e401cee21fa61dcf9900d8d2b40ddd39f4e612 (diff)