From 1eb926dd82d31286be75b102b6707057a8787999 Mon Sep 17 00:00:00 2001 From: aarne Date: Sat, 17 Jun 2006 09:53:42 +0000 Subject: [PATCH] doc update, preparing 2.6 --- resource-1.0/TODO | 2 +- resource-1.0/doc/index.html | 88 +++++++++++-------------------------- resource-1.0/doc/index.txt | 30 ++++++++----- 3 files changed, 46 insertions(+), 74 deletions(-) diff --git a/resource-1.0/TODO b/resource-1.0/TODO index 763bd5bdc..7ae9f9a7f 100644 --- a/resource-1.0/TODO +++ b/resource-1.0/TODO @@ -2,7 +2,7 @@ TODO in Resource 1.0 implementation 6/2/2006 -Eng: non-contracted negations +%Eng: non-contracted negations %Eng: auxiliaries in standard API diff --git a/resource-1.0/doc/index.html b/resource-1.0/doc/index.html index ac257ae7c..795bf10c3 100644 --- a/resource-1.0/doc/index.html +++ b/resource-1.0/doc/index.html @@ -7,41 +7,9 @@

GF Resource Grammar Library v. 1.0

Author: Aarne Ranta <aarne (at) cs.chalmers.se>
-Last update: Thu Jun 8 23:35:47 2006 +Last update: Sat Jun 17 11:37:41 2006
-

-
-

- - -

-
-

The GF Resource Grammar Library defines the basic grammar of ten languages: @@ -49,11 +17,13 @@ Danish, English, Finnish, French, German, Italian, Norwegian, Russian, Spanish, Swedish.

+New: User manual of the resource library. +

+

Notice. This document concerns the API v. 1.0 which has not yet been "officially" released. The release is planned in the end of June 2006.

-

Authors

Inger Andersson and Therese Soderberg (Spanish morphology), @@ -88,14 +58,12 @@ Saara Myllyntausta, Wanjiku Ng'ang'a, Jordi Saludes.

-

License

The GF Resource Grammar Library is open-source software licensed under GNU General Public License. See the file LICENSE for more details.

-

Scope

Coverage, for each language: @@ -126,7 +94,6 @@ Presentation:

  • example collections -

    Quick start

    Go to the main directory, compile the grammars, and run a test. @@ -138,7 +105,8 @@ Go to the main directory, compile the grammars, and run a test.

    This will take quite some time. An alternative is to use the -precompiled grammar package from GF download page. This package +precompiled grammar package compiled.tgz. +This package has the necessary gfc and gfr files directly under GF/lib. 

    @@ -159,7 +127,6 @@ Do for instance
 
    
 For more examples, see the Overview slides. 
 
    
-
 
    The language independent ground API
    
 
    
 This API is accessible by both present and alltenses.
@@ -193,7 +160,6 @@ The documentation of the individual modules:
 
  • Lang: the main module comprising both Grammar and Lexicon
 
 
-
 
    The language-dependent APIs
    
 
      
 
    • ParadigmsDan: Danish lexical paradigms
@@ -225,11 +191,11 @@ This is the structure of each language-dependent top module.
 
      
 
        
 
      • Extra: extra constructs implemented in some languages
-
      • ExtraScand: extra constructs in Scandinavian only
-
      • ExtraNor: extra constructs in Norwegian only
+
      • ExtraEng: extra constructs in English only
 
      • ExtraFin: extra constructs in Finnish only
 
      • ExtraFre: extra constructs in French only
-
      • ExtraEng: extra constructs in English only
+
      • ExtraNor: extra constructs in Norwegian only
+
      • ExtraScand: extra constructs in Scandinavian only
 
      
 
 
        
@@ -241,7 +207,6 @@ This is the structure of each language-dependent top module.
 
      • Swedish: Swedish with all extras
 
      
 
-
 
      Special-purpose APIs
      
 
      Present
      
 
      
@@ -269,9 +234,7 @@ gesture. Some functions for constructing demonstratives are provided.
 
    • Symbol: symbols and numbers in text
 
    
 
-
 
    Using the library
    
-
 
    The compiled version
    
 
    
 The simplest way to get the library is to install the precompiled version
@@ -293,7 +256,6 @@ library. Use one (or several) of the following packages instead:
   multimodal dialogue applications
 
 
-
 
    Linking applications to libraries
    
 
    
 Typically, open one of
@@ -332,7 +294,6 @@ The mathematical API shares modules with
 present. It is therefore not a good idea to use it in combination with
 alltenses.
 
    
-
 
    Using the libraries as top-level grammars
    
 
    
 If you have done make in lib/resource-1.0, you will have 
@@ -368,14 +329,12 @@ each session, but gets faster at later runs.
 
    
 It is also feasible to parse in Scandinavian languages (Danish, Norwegian, Swedish).
 
    
-
 
    Example applications
    
 
    
-These applications are meand to serve as starting points for
+These applications are meant to serve as starting points for
 new applications, showing how the libraries can be used in
 typical situations.
 
    
-
 
    Brozeage
    
 
    
 The examples/bronzeage 
@@ -383,7 +342,6 @@ grammar set implements a language fragment
 based on the Swadesh list of 200 words. It is useful for
 things like language training.
 
    
-
 
    Dialogue
    
 
    
 The examples/dialogue 
@@ -392,7 +350,6 @@ multimodal dialogue system.
 Its purpose is to serve as a prototype for applications in the
 TALK project.
 
    
-
 
    Animals
    
 
    
 The examples/animal 
@@ -400,12 +357,8 @@ grammar set implements some queries about animals.
 Its purpose is to serve as a prototype for example-based 
 grammar writing.
 
    
-
 
    Known bugs and missing components
    
 
    
-This bugs should be fixed before the final release of v. 1.0.
-
    
-
    
 Danish
 
    
 
      
@@ -416,7 +369,7 @@ Danish
 English 
 
      
 
        
-
      • only contracted negation forms
+
      • -
 
      
 
 
      
@@ -431,6 +384,7 @@ French
 
      
 
        
 
      • no inverted word order in questions
+
      • multiple clitics (with V3) not always right
 
      
 
 
      
@@ -446,6 +400,7 @@ Italian
 
        
 
      • no contraction of infinitives before clitics
 
      • no list of irregular verbs
+
      • multiple clitics (with V3) not always right
 
      
 
 
      
@@ -460,21 +415,30 @@ Russian
 
      
 
        
 
      • some functions missing
-
      • regular paradigms are missing
+
      • some regular paradigms are missing
 
      
 
 
      
 Spanish
 
      
 
        
-
      • -
+
      • no list of irregular verbs
+
      • multiple clitics (with V3) not always right
+
      
+
+
      
 Swedish
+
      
+
        
 
      • -
 
      
 
-
 
      More reading
      
 
      
+GF Resource Grammar Library (pdf).
+Printable user manual with API documentation.
+
      
+
      
 Grammars as Software Libraries. Slides
 with background and motivation for the resource grammar library.
 
      
@@ -502,5 +466,5 @@ examples are from multimodal/old, which is a reduced-size API.
 
      
 
 
-
+
 
diff --git a/resource-1.0/doc/index.txt b/resource-1.0/doc/index.txt
index 5fae49e12..f9a84ffbc 100644
--- a/resource-1.0/doc/index.txt
+++ b/resource-1.0/doc/index.txt
@@ -14,6 +14,8 @@ ten languages:
 Danish, English, Finnish, French, German,
 Italian, Norwegian, Russian, Spanish, Swedish.
 
+**New**: [User manual of the resource library ../../../doc/resource.pdf].
+
 **Notice**. This document concerns the API v. 1.0 which has not
 yet been "officially" released. The release is planned in the end
 of June 2006.
@@ -91,7 +93,8 @@ Go to the main directory, compile the grammars, and run a test.
   make test
 ```
 This will take quite some time. An alternative is to use the
-precompiled grammar package from GF download page. This package 
+precompiled grammar package [``compiled.tgz`` ../../compiled.tgz]. 
+This package 
 has the necessary ``gfc`` and ``gfr`` files directly under ``GF/lib``.
 ```
   GF/lib/alltenses
@@ -168,11 +171,11 @@ This is the structure of each language-dependent top module.
 [English.png]
 
 - [Extra ../abstract/Extra.gf]: extra constructs implemented in some languages
-- [ExtraScand ../scandinavian/ExtraScandAbs.gf]: extra constructs in Scandinavian only
-- [ExtraNor ../norwegian/ExtraNorAbs.gf]: extra constructs in Norwegian only
+- [ExtraEng ../english/ExtraEngAbs.gf]: extra constructs in English only
 - [ExtraFin ../finnish/ExtraFinAbs.gf]: extra constructs in Finnish only
 - [ExtraFre ../french/ExtraFreAbs.gf]: extra constructs in French only
-- [ExtraEng ../english/ExtraEngAbs.gf]: extra constructs in English only
+- [ExtraNor ../norwegian/ExtraNorAbs.gf]: extra constructs in Norwegian only
+- [ExtraScand ../scandinavian/ExtraScandAbs.gf]: extra constructs in Scandinavian only
 
 
 - [English ../english/EnglishAbs.gf]: English with all extras
@@ -296,7 +299,7 @@ It is also feasible to parse in Scandinavian languages (Danish, Norwegian, Swedi
 
 ==Example applications==
 
-These applications are meand to serve as starting points for
+These applications are meant to serve as starting points for
 new applications, showing how the libraries can be used in
 typical situations.
 
@@ -327,14 +330,12 @@ grammar writing.
 
 ==Known bugs and missing components==
 
-This bugs should be fixed before the final release of v. 1.0.
-
 Danish
 - the lexicon and chosen inflections are only partially verified
 
 
 English 
-- only contracted negation forms
+- -
 
 
 Finnish
@@ -343,6 +344,7 @@ Finnish
 
 French
 - no inverted word order in questions
+- multiple clitics (with V3) not always right
 
 
 German
@@ -352,6 +354,7 @@ German
 Italian
 - no contraction of infinitives before clitics
 - no list of irregular verbs
+- multiple clitics (with V3) not always right
 
 
 Norwegian
@@ -360,11 +363,14 @@ Norwegian
 
 Russian
 - some functions missing
-- regular paradigms are missing
+- some regular paradigms are missing
 
 
 Spanish
-- -
+- no list of irregular verbs
+- multiple clitics (with V3) not always right
+
+
 Swedish
 - -
 
@@ -372,6 +378,9 @@ Swedish
 
 ==More reading==
 
+[GF Resource Grammar Library ../../../doc/resource.pdf] (pdf).
+Printable user manual with API documentation.
+
 [Grammars as Software Libraries gslt-sem-2006.html]. Slides
 with background and motivation for the resource grammar library.
 
@@ -385,7 +394,6 @@ start if you want to add another language to the library.
 Slides explaining some ideas in the implementation of
 French, Italian, and Spanish.
 
-
 [Grammar writing by examples http://www.cs.chalmers.se/~aarne/slides/webalt-2005.pdf].
 Slides showing how the method is used.