GF Resource Grammar Library v. 1.0
Author: Aarne Ranta <aarne (at) cs.chalmers.se>
Last update: %%date(%c)

% NOTE: this is a txt2tags file.
% Create an html file from this file using:
% txt2tags --toc -thtml index.txt

%!target:html


**Notice**. This document concerns the API v. 1.0 which has not
yet been "officially" released. You can find the beginnings of it
in [``GF/lib/resource-1.0/`` ..]. See
[``resource-1.0/README`` ../README] for
details on how it differs from previous versions
and how much has been implemented



==Using the library==

There is no need to link application grammars to the source directories of the
library. Use one (or several) of the following packages instead:

- ``lib/alltenses`` the complete ground-API library with all forms
- ``lib/present`` a pruned ground-API library with present tense only
- ``lib/mathematical`` special-purpose API for mathematical applications
- ``lib/multimodal`` special-purpose API for multimodal dialogue applications


Notice, however, that both special-purpose APIs share modules with
``present``. It is therefore not a good idea to use them in combination with
``alltenses``.


It is advisable to use the bare package names in paths pointing to the
libraries. Here is an example, from ``examples/tram``:
```
  --# -path=.:present:multimodal:mathematical:prelude
```
To reach these directories from anywhere, set the environment variable
``GF_LIB_PATH`` to point to the directory ``GF/lib/``. For instance,
I have the following line in my ``.bashrc`` file:
```
  export GF_LIB_PATH=/home/aarne/GF/lib
```



==The language independent API==

This API is accessible by both ``present`` and ``alltenses``.
The API is divided into a bunch of ``abstract`` modules.
The following figure gives the dependencies of these modules.

[Lang.png] 

The documentation of the individual modules:

- [Common gfdoc/Common.html]: abstract notions with language-indep. implementations
- [Cat gfdoc/Cat.html]: the category system
- [Noun gfdoc/Noun.html]: construction of nouns and noun phrases
- [Adjective gfdoc/Adjective.html]: construction of adjectival phrases
- [Verb gfdoc/Verb.html]: construction of verb phrases
- [Adverb gfdoc/Adverb.html]: construction of adverbial phrases
- [Numeral gfdoc/Numeral.html]: construction of cardinal and ordinal numerals
- [Sentence gfdoc/Sentence.html]: construction of sentences and imperatives
- [Question gfdoc/Question.html]: construction of questions
- [Relative gfdoc/Relative.html]: construction of relative clauses
- [Conjunction gfdoc/Conjunction.html]: coordination of phrases
- [Phrase gfdoc/Phrase.html]: construction of the major units of text and speech
- [Text gfdoc/Text.html]: construction of texts from phrases, using punctuation
- [Idiom gfdoc/Idiom.html]: idiomatic phrases, such as existentials
- [Structural gfdoc/Structural.html]: a lexicon of structural words
- [Lexicon gfdoc/Lexicon.html]: a lexicon of other common words, for test purposes
- [Lang gfdoc/Lang.html]: the main module comprising all the others


==The language-dependent APIs==

- [ParadigmsEng gfdoc/ParadigmsEng.html]: English lexical paradigms
- [ParadigmsFin gfdoc/ParadigmsFin.html]: Finnish lexical paradigms
- [ParadigmsFre gfdoc/ParadigmsFre.html]: French lexical paradigms
- [ParadigmsIta gfdoc/ParadigmsIta.html]: Italian lexical paradigms
- [ParadigmsGer gfdoc/ParadigmsGer.html]: German lexical paradigms
- [ParadigmsNor gfdoc/ParadigmsNor.html]: Norwegian lexical paradigms
- [ParadigmsSpa gfdoc/ParadigmsSpa.html]: Spanish lexical paradigms
- [ParadigmsSwe gfdoc/ParadigmsSwe.html]: Swedish lexical paradigms



- [IrregEng gfdoc/IrregEng.gf]: English irregular verbs
- [IrregFre gfdoc/IrregFre.gf]: French irregular verbs
% - [IrregGer gfdoc/IrregGer.gf]: German irregular verbs
- [IrregNor gfdoc/IrregNor.gf]: Norwegian irregular verbs
- [IrregSwe gfdoc/IrregSwe.gf]: Swedish irregular verbs


==Special-purpose APIs==

===Multimodal===

- [Multimodal gfdoc/Multimodal.html]: main module for multimodal dialogue systems
- [Demonstrative gfdoc/Demonstrative.html]: demonstrative noun phrases and adverbs


===Mathematical===

- [Mathematical gfdoc/Mathematical.html]: main module for mathematical language
- [Predication gfdoc/Predication.html]: predication with verbs, adjectives, etc
- [Symbol gfdoc/Symbol.html]: symbols and numbers in text