From ebac1125e1f71b99d6a376c93c108247d961f3c7 Mon Sep 17 00:00:00 2001 From: aarne Date: Fri, 21 Dec 2007 17:37:19 +0000 Subject: [PATCH] preparing for release --- doc/gf-quickstart.html | 7 +- doc/index.html | 112 +++++++++------------------ doc/old-news.html | 19 +++++ download/index.html | 56 ++++++++++++++ index.html | 99 ++++++++++------------- lib/resource/doc/MkSynopsis.hs | 2 +- lib/resource/doc/index.html | 13 +--- lib/resource/doc/index.txt | 9 +-- lib/resource/doc/synopsis-browse.txt | 6 ++ lib/resource/doc/synopsis-intro.txt | 13 +++- lib/resource/doc/synopsis.html | 87 ++++++++++++--------- 11 files changed, 227 insertions(+), 196 deletions(-) create mode 100644 download/index.html diff --git a/doc/gf-quickstart.html b/doc/gf-quickstart.html index 2da3ff192..91aaea659 100644 --- a/doc/gf-quickstart.html +++ b/doc/gf-quickstart.html @@ -20,14 +20,13 @@ Aarne Ranta This Quick Start shows two examples of how GF can be used. We assume that you have downloaded and installed GF, so that the command gf works for you. See download and install -instructions here. +instructions here.

Translation and generation

When you have downloaded and installed GF: -
  1. Copy the files Food.gf, @@ -75,7 +74,7 @@ This demo also requires the GUI package, which makes the command
  2. Download the file Letter.gfcm.
  3. Start the GF editor by the command 
    -  jgf Letter.gfcm
+  gfeditor Letter.gfcm
  4. When the editor window is open, select "Letter" from the "New" menu.
  5. Push the button "Random" in the lower end of the window. @@ -86,7 +85,7 @@ This demo also requires the GUI package, which makes the command
  6. Double-click at some of the alternatives marked "ch ..." and observe how the text changes in each of the languages.
-See the Editor User Manual +See the Editor User Manual for more information on how to use the editor. To change the grammars, you should not edit Letter.gfcm, which is low-level code generated by the GF grammar compiler. Instead, you diff --git a/doc/index.html b/doc/index.html index 3d5ab9741..c00dab25c 100644 --- a/doc/index.html +++ b/doc/index.html @@ -10,10 +10,22 @@ -

Grammatical Framework Documents

+Top-3 documents: + +Tutorial + +| + +ReferenceManual + +| + +LibrarySynopsis + +

Tutorials

@@ -21,38 +33,21 @@

-New Grammarian's Tutorial, -Now up-to-date for GF version 2.4, although some -sections are still unwritten. Also available in -pdf. - - -

- -Old Grammarian's Tutorial -on writing GF grammars, with exercises. GF v 1.2, before the module system. - - - - +GF Tutorial, +Now up-to-date for GF version 2.9. Covers all of GF.

Language and system documentation

GF Quick Reference. Also available in -pdf. +pdf. Covers all features of GF language +in a summary format.

-History of changes. Up to date with -the current darcs version of GF. - -

- -Module system document, complements the -JFP paper -by a description of the module system. +GF Reference Manual. A full-scale reference +manual of the GF language.

@@ -67,75 +62,45 @@ on editing in the Java interface.

- -Syntax specification (pdf) of the GF grammar formalism. -Generated by the BNF Converter from the same source as the language -parser. - -

- - -Syntax specification of GFC (pdf), the low-level formalism -to which GF is compiled. -Generated by the BNF Converter from the same source as the language -parser. - -

- -The GF Transfer language document. - -

- Chart of GF grammar compiler phases.

Grammar library documentation

-

- -Resource Grammar Synopsis. -With APIs and use examples, for Resource v. 1.2. +Resource Grammar Tutorial Chapter.

- -GF Resource Grammar Library -user's manual, for API v 1.0. +Resource Grammar Synopsis +for library users. With APIs and use examples.

- -On-line resource grammar library documentation -in progress for API v 1.0. - -

- - -Resource grammar writing HOWTO -document in progress (forthcoming API v 1.0). - -

- -Old resource grammar library -document (v 0.9). + +Resource Grammar HOWTO +for library authors.

Embedding GF grammars in computer programs

+Embedded Grammar Tutorial Chapter. + +

+ Embedded GF Interpreter manual for using GF grammars in Java programs.

- + Embedded GF API for using GF grammars in Haskell programs.

- + MCFG/GF library for Prolog, for using GF grammars in Prolog programs. @@ -152,16 +117,16 @@ The standard reference on GF.

- + Expressivity and Complexity of the Grammatical Framework, PhD Thesis by -Peter Ljunglöf. +Peter Ljunglöf.

Introductory talks

- + GF in 25 Minutes - overview for computer science audience.

@@ -172,14 +137,7 @@ Slides on GF theory and implementation given at INRIA Rocquencourt in December 2003.

- - -Slides on multilingual grammar engineering and some examples of -using the module system of GF. - -

- + Slides on example-based grammar writing and a short introduction diff --git a/doc/old-news.html b/doc/old-news.html index f51019548..89f608510 100644 --- a/doc/old-news.html +++ b/doc/old-news.html @@ -4,6 +4,25 @@

GF News 2004-2007

+

+ +August 31, 2007. GF Graduate Course +organized by GSLT: first module +September 13-14 in Gothenburg. + +

+ +July 8, 2007. GF 2.8 released. Some highlights: +

+

diff --git a/download/index.html b/download/index.html new file mode 100644 index 000000000..5a6d65609 --- /dev/null +++ b/download/index.html @@ -0,0 +1,56 @@ + + + +GF Version 2.9, released 21 December 2007 as sources: +

+Binaries: GF Version 2.8, released 8 July 2007; updated 12 September. + +The Sourceforge GF site +has currently only v 2.7 and older versions. + +

+ +Don't forget that you can always get the current sources from the +GF Darcs Repository. First time you do +

+  darcs get --partial --set-scripts-executable http://www.cs.chalmers.se/Cs/Research/Language-technology/darcs/GF/
+
+and subsequent times +
+  darcs pull -a
+
+Then compile and install as described in +GF/src/INSTALL. + + + + diff --git a/index.html b/index.html index bf39e8ea1..f352fd4ad 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -GF Version 2.8 +GF Version 2.9 @@ -9,9 +9,9 @@

Grammatical Framework

-

Version 2.8

+

Version 2.9

-July 8, 2007. +December 21, 2007.

@@ -23,25 +23,21 @@ July 8, 2007. "doc">Documentation | Download +"download/">Download | Developers -| -Changes +"http://www.cs.chalmers.se/Cs/Research/Language-technology/darcs/GF/doc/darcs.html">LatestCode | QuickStart | Tutorial +"doc/gf-tutorial.html">Tutorial | Libraries +"doc/gf-refman.html">ReferenceManual | -Examples +Libraries | NumeralDemo @@ -56,30 +52,24 @@ July 8, 2007.

News

-

-August 31, 2007. GF Graduate Course -organized by GSLT: first module -September 13-14 in Gothenburg. - -

- -July 8, 2007. GF 2.8 released. Some highlights: +December 21, 2007.

-

-News before 2.7. +News before 2.9.

What is GF?

@@ -136,8 +126,8 @@ GF is open-source software licensed under

-The are licensed under -GNU Lesser General Public License (LGPL). +The GF Grammar Libraries are licensed under +GNU Lesser General Public License (LGPL). @@ -166,7 +156,12 @@ of a multimodal dialogue system built with embedded grammars.

-Resource grammar library: +Example grammars used in the +GF tutorial. + +

+ +Resource grammar library: basic structures of ten languages (Danish, English, Finnish, French, German, Italian, Norwegian, Russian, Spanish, Swedish). @@ -181,8 +176,7 @@ but they can also be useful for language training. GF is available for several platforms: Linux, Mac OS X, Microsoft Windows, and Sun OS. To get GF, go to the -Download Page -(at SourceForge). +Download Page.

Quick start

@@ -205,8 +199,8 @@ The platform-independent graphical user interface is written in

-The -Download Page (at SourceForge) gives links to source and binary packages, as well as +The Download Page +gives links to source and binary packages, as well as information on compiler requirements.

@@ -234,40 +228,30 @@ See the Documentation page.

Projects and events

+
  • WebALT, +Web Advanced Learning Technologies. GF is used as for generating multilingual +teaching material in mathematics. +
  • TALK = Tools for Ambient Linguistic -Knowledge. GF is used in implementing multimodal and multilingual dialogue systems. +Knowledge. GF was used in implementing multimodal and multilingual dialogue systems.
  • KeY project on Integrated Deductive -Software Design. GF is used for +Software Design. GF was used for authoring informal and formal specifications. More details on the GF application here. -
  • WebALT, -Web Advanced Learning Technologies. GF is used as for generating multilingual -teaching material in mathematics. -
  • Project Efficient at Tudor Institute, Luxembourg, "atelier de prototypage de transactions d'e-commerce". GF is used as an authoring tool for business models. -
  • -An introductory course on GF was given at the -ESSLLI summer school -in Vienna 2003. -

    Miscellaneous

    -
  • -Gramlets: -GF grammars compiled to Java applets. - -
  • GFCC: @@ -276,11 +260,6 @@ The compiler source code can be found in the directory examples/gfcc in the GF grammar library (see GF download page). -
  • - -An early version of the GF Home Page -last updated for GF, Version 1.2, 2003. -
  • The original GF Xerox Home Page @@ -296,8 +275,7 @@ Earlier application:
  • The BNF Converter. A GF spin-off customized for the description of programming -languages. - +languages.
  • @@ -305,6 +283,7 @@ languages. Morphology project. Creating infrastructure for GF and other linguistic applications. +

    • Authors

    @@ -332,6 +311,6 @@ And register to the Last modified by Aarne Ranta, -December 22, 2005. +December 21, 2007. diff --git a/lib/resource/doc/MkSynopsis.hs b/lib/resource/doc/MkSynopsis.hs index a025feb24..48ba73153 100644 --- a/lib/resource/doc/MkSynopsis.hs +++ b/lib/resource/doc/MkSynopsis.hs @@ -14,7 +14,7 @@ main = do cs2 <- getCats catAPI let cs = sortCats (cs1 ++ cs2) writeFile synopsis "GF Resource Grammar Library: Synopsis" - append "Aarne Ranta" + append "B. Bringert and A. Ranta" space append "%!postproc(html): '(SRC=\"categories.png\")' '\\1 USEMAP=\"#categories\"'" append "%!postproc(html): '#LParadigms' ''" diff --git a/lib/resource/doc/index.html b/lib/resource/doc/index.html index 8c7e42f8b..139e7f554 100644 --- a/lib/resource/doc/index.html +++ b/lib/resource/doc/index.html @@ -7,7 +7,7 @@

    GF Resource Grammar Library v. 1.2

    Author: Aarne Ranta <aarne (at) cs.chalmers.se>
    -Last update: Sun Jul 8 18:49:50 2007 +Last update: Fri Dec 21 18:15:24 2007

    @@ -28,20 +28,15 @@ Still incomplete implementations for Arabic and Catalan are also included.

    -New in Version 1.2 +New in December 2007: Browsing the library by syntax editor +directly on the web.

    - -

    Authors

    Inger Andersson and Therese Soderberg (Spanish morphology), Nicolas Barth and Sylvain Pogodalla (French verb list), Ali El Dada (Arabic modules), +Magda Gerritsen and Ulrich Real (Russian paradigms and lexicon), Janna Khegai (Russian modules), Bjorn Bringert (many Swadesh lexica), Carlos Gonzalía (Spanish cardinals), diff --git a/lib/resource/doc/index.txt b/lib/resource/doc/index.txt index 681c0237e..86d1f3d0c 100644 --- a/lib/resource/doc/index.txt +++ b/lib/resource/doc/index.txt @@ -26,12 +26,8 @@ Italian, Norwegian, Russian, Spanish, Swedish. Still incomplete implementations for Arabic and Catalan are also included. -**New in Version 1.2** -- Simpler APIs using overloading: see [Synopsis synopsis.html]. - The API of version 1.0 remains valid and can be used in combination with this. -- Bug fixes and new paradigms. -- Licensed under LGPL. - +**New** in December 2007: Browsing the library by syntax editor +[directly on the web ../../../demos/resource-api/editor.html]. @@ -41,6 +37,7 @@ included. Inger Andersson and Therese Soderberg (Spanish morphology), Nicolas Barth and Sylvain Pogodalla (French verb list), Ali El Dada (Arabic modules), +Magda Gerritsen and Ulrich Real (Russian paradigms and lexicon), Janna Khegai (Russian modules), Bjorn Bringert (many Swadesh lexica), Carlos Gonzalía (Spanish cardinals), diff --git a/lib/resource/doc/synopsis-browse.txt b/lib/resource/doc/synopsis-browse.txt index afc00d6f5..de28c3c8c 100644 --- a/lib/resource/doc/synopsis-browse.txt +++ b/lib/resource/doc/synopsis-browse.txt @@ -1,6 +1,12 @@ + + + =Browsing the libraries with GF commands= +**New**: Browsing by syntax editor +[directly on the web ../../../demos/resource-api/editor.html]. + All of the following assume ``` cd $GF_LIB_PATH diff --git a/lib/resource/doc/synopsis-intro.txt b/lib/resource/doc/synopsis-intro.txt index a670eb738..5a473d241 100644 --- a/lib/resource/doc/synopsis-intro.txt +++ b/lib/resource/doc/synopsis-intro.txt @@ -1,16 +1,25 @@ + + +=Introduction= + This document contains the most important parts of the GF Resource Grammar API. It has been machine-generated from the source files; each chapter gives a link to the relevant source files, which give more information. Some of the files have -not yet been prepared so that the machine generated documentation has the right format. +not yet been prepared so that the machine generated documentation has the right +format. -Since the character encoding is UTF-8 for Russian and Latin-1 for other languages, you +Since the character encoding is UTF-8 for Russian and Latin-1 for other +languages, you may have to change the encoding preference of your browser when reading different parts of the document. The second-last chapter gives instructions on how to "browse" the library by loading the grammars into the ``gf`` command editor. +**New**: Browsing by syntax editor +[directly on the web ../../../demos/resource-api/editor.html]. + The last chapter contains a brief example of how application grammars can import resource modules. At the same time, it illustrates a "design pattern" for using the resource API to build functor-based applications diff --git a/lib/resource/doc/synopsis.html b/lib/resource/doc/synopsis.html index 869b6e35a..e9514b192 100644 --- a/lib/resource/doc/synopsis.html +++ b/lib/resource/doc/synopsis.html @@ -6,19 +6,20 @@

    GF Resource Grammar Library: Synopsis

    -Aarne Ranta
    +B. Bringert and A. Ranta

    + +

    Introduction

    This document contains the most important parts of the GF Resource Grammar API. It has been machine-generated from the source files; each chapter gives a link to the relevant source files, which give more information. Some of the files have -not yet been prepared so that the machine generated documentation has the right format. +not yet been prepared so that the machine generated documentation has the right +format.

    -Since the character encoding is UTF-8 for Russian and Latin-1 for other languages, you +Since the character encoding is UTF-8 for Russian and Latin-1 for other +languages, you may have to change the encoding preference of your browser when reading different parts of the document.

    @@ -123,11 +128,15 @@ The second-last chapter gives instructions on how to "browse" the library by loading the grammars into the gf command editor.

    +New: Browsing by syntax editor +directly on the web. +

    +

    The last chapter contains a brief example of how application grammars can import resource modules. At the same time, it illustrates a "design pattern" for using the resource API to build functor-based applications

    - +

    Categories

    Source 1: http://www.cs.chalmers.se/~aarne/GF/lib/resource/abstract/Common.gf @@ -135,7 +144,7 @@ Source 1: http://www.cs.chalmers.se/~aarne

    Source 2: http://www.cs.chalmers.se/~aarne/GF/lib/resource/abstract/Cat.gf

    - +

    A hierarchic view

    The chart below shows the categories in a hierarchical top-down order. @@ -207,7 +216,7 @@ each category. The rectangular boxes mark open lexical categories, which have constructors also in the Paradigms modules.

    - +

    Explanations

    @@ -508,7 +517,7 @@ also in the Paradigms modules.

    - +

    Syntax Rules and Structural Words

    Source 1: http://www.cs.chalmers.se/~aarne/GF/lib/resource/api/Constructors.gf @@ -2873,9 +2882,9 @@ Lexical category, constructors given in

    - -

    Lexical Paradigms

    +

    Lexical Paradigms

    +

    Paradigms for Danish

    @@ -3123,7 +3132,7 @@ source http://www.cs.chalmers.se/~aarn

    - +

    Paradigms for English

    @@ -3355,7 +3364,7 @@ source http://www.cs.chalmers.se/~aar

    - +

    Paradigms for Finnish

    @@ -3695,7 +3704,7 @@ source http://www.cs.chalmers.se/~aar

    - +

    Paradigms for French

    @@ -3927,7 +3936,7 @@ source http://www.cs.chalmers.se/~aarn

    - +

    Paradigms for German

    @@ -4183,7 +4192,7 @@ source http://www.cs.chalmers.se/~aarn

    - +

    Paradigms for Italian

    @@ -4419,7 +4428,7 @@ source http://www.cs.chalmers.se/~aar

    - +

    Paradigms for Norwegian

    @@ -4667,7 +4676,7 @@ source http://www.cs.chalmers.se/~a

    - +

    Paradigms for Russian

    @@ -4963,7 +4972,7 @@ source http://www.cs.chalmers.se/~aar

    - +

    Paradigms for Spanish

    @@ -5199,7 +5208,7 @@ source http://www.cs.chalmers.se/~aar

    - +

    Paradigms for Swedish

    @@ -5443,9 +5452,13 @@ source http://www.cs.chalmers.se/~aar

    - +

    Browsing the libraries with GF commands

    +New: Browsing by syntax editor +directly on the web. +

    +

    All of the following assume 

    @@ -5480,7 +5493,7 @@ To view linearizations in all languages by parsing from English:
     > p -cat=S -lang=LangEng "this grammar is too big" | tb

    - +

    An Example of Usage

    The standard way of building an application has the following modules.