From 84434383942a50b74ea416b30dadfc043465de2c Mon Sep 17 00:00:00 2001 From: aarne Date: Fri, 21 Dec 2007 17:37:19 +0000 Subject: [PATCH] preparing for release --- resource/doc/MkSynopsis.hs | 2 +- resource/doc/index.html | 13 ++--- resource/doc/index.txt | 9 ++-- resource/doc/synopsis-browse.txt | 6 +++ resource/doc/synopsis-intro.txt | 13 ++++- resource/doc/synopsis.html | 87 ++++++++++++++++++-------------- 6 files changed, 75 insertions(+), 55 deletions(-) diff --git a/resource/doc/MkSynopsis.hs b/resource/doc/MkSynopsis.hs index a025feb24..48ba73153 100644 --- a/resource/doc/MkSynopsis.hs +++ b/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/resource/doc/index.html b/resource/doc/index.html index 8c7e42f8b..139e7f554 100644 --- a/resource/doc/index.html +++ b/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/resource/doc/index.txt b/resource/doc/index.txt index 681c0237e..86d1f3d0c 100644 --- a/resource/doc/index.txt +++ b/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/resource/doc/synopsis-browse.txt b/resource/doc/synopsis-browse.txt index afc00d6f5..de28c3c8c 100644 --- a/resource/doc/synopsis-browse.txt +++ b/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/resource/doc/synopsis-intro.txt b/resource/doc/synopsis-intro.txt index a670eb738..5a473d241 100644 --- a/resource/doc/synopsis-intro.txt +++ b/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/resource/doc/synopsis.html b/resource/doc/synopsis.html index 869b6e35a..e9514b192 100644 --- a/resource/doc/synopsis.html +++ b/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.