mirror of
https://github.com/GrammaticalFramework/gf-core.git
synced 2026-04-21 10:49:33 -06:00
155 lines
6.1 KiB
HTML
155 lines
6.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<META NAME="generator" CONTENT="http://txt2tags.sf.net">
|
|
<TITLE>GF Resource Grammar Library v. 1.0</TITLE>
|
|
</HEAD><BODY BGCOLOR="white" TEXT="black">
|
|
<P ALIGN="center"><CENTER><H1>GF Resource Grammar Library v. 1.0</H1>
|
|
<FONT SIZE="4">
|
|
<I>Author: Aarne Ranta <aarne (at) cs.chalmers.se></I><BR>
|
|
Last update: Tue Feb 28 15:53:00 2006
|
|
</FONT></CENTER>
|
|
|
|
<P></P>
|
|
<HR NOSHADE SIZE=1>
|
|
<P></P>
|
|
<UL>
|
|
<LI><A HREF="#toc1">Using the library</A>
|
|
<LI><A HREF="#toc2">The language independent API</A>
|
|
<LI><A HREF="#toc3">The language-dependent APIs</A>
|
|
<LI><A HREF="#toc4">Special-purpose APIs</A>
|
|
<UL>
|
|
<LI><A HREF="#toc5">Multimodal</A>
|
|
<LI><A HREF="#toc6">Mathematical</A>
|
|
</UL>
|
|
</UL>
|
|
|
|
<P></P>
|
|
<HR NOSHADE SIZE=1>
|
|
<P></P>
|
|
<P>
|
|
<B>Notice</B>. This document concerns the API v. 1.0 which has not
|
|
yet been "officially" released. You can find the beginnings of it
|
|
in <A HREF=".."><CODE>GF/lib/resource-1.0/</CODE></A>. See
|
|
<A HREF="../README"><CODE>resource-1.0/README</CODE></A> for
|
|
details on how it differs from previous versions
|
|
and how much has been implemented
|
|
</P>
|
|
<A NAME="toc1"></A>
|
|
<H2>Using the library</H2>
|
|
<P>
|
|
The simplest way to get the library is to install the precompiled version
|
|
<A HREF="../../compiled.tgz"><CODE>lib/compiled.tgz</CODE></A>. Just do
|
|
</P>
|
|
<PRE>
|
|
cd GF/lib
|
|
tar tvfz compiled.tgz
|
|
</PRE>
|
|
<P>
|
|
There is no need to link application grammars to the source directories of the
|
|
library. Use one (or several) of the following packages instead:
|
|
</P>
|
|
<UL>
|
|
<LI><CODE>lib/alltenses</CODE> the complete ground-API library with all forms
|
|
<LI><CODE>lib/present</CODE> a pruned ground-API library with present tense only
|
|
<LI><CODE>lib/mathematical</CODE> special-purpose API for mathematical applications
|
|
<LI><CODE>lib/multimodal</CODE> special-purpose API for multimodal dialogue applications
|
|
</UL>
|
|
|
|
<P>
|
|
Notice, however, that both special-purpose APIs share modules with
|
|
<CODE>present</CODE>. It is therefore not a good idea to use them in combination with
|
|
<CODE>alltenses</CODE>.
|
|
</P>
|
|
<P>
|
|
It is advisable to use the bare package names in paths pointing to the
|
|
libraries. Here is an example, from <CODE>examples/tram</CODE>:
|
|
</P>
|
|
<PRE>
|
|
--# -path=.:present:multimodal:mathematical:prelude
|
|
</PRE>
|
|
<P>
|
|
To reach these directories from anywhere, set the environment variable
|
|
<CODE>GF_LIB_PATH</CODE> to point to the directory <CODE>GF/lib/</CODE>. For instance,
|
|
I have the following line in my <CODE>.bashrc</CODE> file:
|
|
</P>
|
|
<PRE>
|
|
export GF_LIB_PATH=/home/aarne/GF/lib
|
|
</PRE>
|
|
<P></P>
|
|
<A NAME="toc2"></A>
|
|
<H2>The language independent API</H2>
|
|
<P>
|
|
This API is accessible by both <CODE>present</CODE> and <CODE>alltenses</CODE>.
|
|
The API is divided into a bunch of <CODE>abstract</CODE> modules.
|
|
The following figure gives the dependencies of these modules.
|
|
</P>
|
|
<P>
|
|
<IMG ALIGN="left" SRC="Lang.png" BORDER="0" ALT="">
|
|
</P>
|
|
<P>
|
|
The documentation of the individual modules:
|
|
</P>
|
|
<UL>
|
|
<LI><A HREF="gfdoc/Common.html">Common</A>: abstract notions with language-indep. implementations
|
|
<LI><A HREF="gfdoc/Cat.html">Cat</A>: the category system
|
|
<LI><A HREF="gfdoc/Noun.html">Noun</A>: construction of nouns and noun phrases
|
|
<LI><A HREF="gfdoc/Adjective.html">Adjective</A>: construction of adjectival phrases
|
|
<LI><A HREF="gfdoc/Verb.html">Verb</A>: construction of verb phrases
|
|
<LI><A HREF="gfdoc/Adverb.html">Adverb</A>: construction of adverbial phrases
|
|
<LI><A HREF="gfdoc/Numeral.html">Numeral</A>: construction of cardinal and ordinal numerals
|
|
<LI><A HREF="gfdoc/Sentence.html">Sentence</A>: construction of sentences and imperatives
|
|
<LI><A HREF="gfdoc/Question.html">Question</A>: construction of questions
|
|
<LI><A HREF="gfdoc/Relative.html">Relative</A>: construction of relative clauses
|
|
<LI><A HREF="gfdoc/Conjunction.html">Conjunction</A>: coordination of phrases
|
|
<LI><A HREF="gfdoc/Phrase.html">Phrase</A>: construction of the major units of text and speech
|
|
<LI><A HREF="gfdoc/Text.html">Text</A>: construction of texts from phrases, using punctuation
|
|
<LI><A HREF="gfdoc/Idiom.html">Idiom</A>: idiomatic phrases, such as existentials
|
|
<LI><A HREF="gfdoc/Structural.html">Structural</A>: a lexicon of structural words
|
|
<LI><A HREF="gfdoc/Lexicon.html">Lexicon</A>: a lexicon of other common words, for test purposes
|
|
<LI><A HREF="gfdoc/Lang.html">Lang</A>: the main module comprising all the others
|
|
</UL>
|
|
|
|
<A NAME="toc3"></A>
|
|
<H2>The language-dependent APIs</H2>
|
|
<UL>
|
|
<LI><A HREF="gfdoc/ParadigmsEng.html">ParadigmsEng</A>: English lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsFin.html">ParadigmsFin</A>: Finnish lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsFre.html">ParadigmsFre</A>: French lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsIta.html">ParadigmsIta</A>: Italian lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsGer.html">ParadigmsGer</A>: German lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsNor.html">ParadigmsNor</A>: Norwegian lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsSpa.html">ParadigmsSpa</A>: Spanish lexical paradigms
|
|
<LI><A HREF="gfdoc/ParadigmsSwe.html">ParadigmsSwe</A>: Swedish lexical paradigms
|
|
</UL>
|
|
|
|
<UL>
|
|
<LI><A HREF="gfdoc/IrregEng.gf">IrregEng</A>: English irregular verbs
|
|
<LI><A HREF="gfdoc/IrregFre.gf">IrregFre</A>: French irregular verbs
|
|
<LI><A HREF="gfdoc/IrregNor.gf">IrregNor</A>: Norwegian irregular verbs
|
|
<LI><A HREF="gfdoc/IrregSwe.gf">IrregSwe</A>: Swedish irregular verbs
|
|
</UL>
|
|
|
|
<A NAME="toc4"></A>
|
|
<H2>Special-purpose APIs</H2>
|
|
<A NAME="toc5"></A>
|
|
<H3>Multimodal</H3>
|
|
<UL>
|
|
<LI><A HREF="gfdoc/Multimodal.html">Multimodal</A>: main module for multimodal dialogue systems
|
|
<LI><A HREF="gfdoc/Demonstrative.html">Demonstrative</A>: demonstrative noun phrases and adverbs
|
|
</UL>
|
|
|
|
<A NAME="toc6"></A>
|
|
<H3>Mathematical</H3>
|
|
<UL>
|
|
<LI><A HREF="gfdoc/Mathematical.html">Mathematical</A>: main module for mathematical language
|
|
<LI><A HREF="gfdoc/Predication.html">Predication</A>: predication with verbs, adjectives, etc
|
|
<LI><A HREF="gfdoc/Symbol.html">Symbol</A>: symbols and numbers in text
|
|
<P></P>
|
|
</UL>
|
|
|
|
|
|
<!-- html code generated by txt2tags 2.0 (http://txt2tags.sf.net) -->
|
|
<!-- cmdline: txt2tags -\-toc -thtml index.txt -->
|
|
</BODY></HTML>
|