documenting the library

lib/resource-1.0/doc/index.html

@@ -7,19 +7,20 @@
 <P ALIGN="center"><CENTER><H1>GF Resource Grammar Library v. 1.0</H1>
 <FONT SIZE="4">
 <I>Author: Aarne Ranta &lt;aarne (at) cs.chalmers.se&gt;</I><BR>
-Last update: Tue Feb 21 16:23:46 2006
+Last update: Sat Feb 25 23:18:51 2006
 </FONT></CENTER>
 
 <P></P>
 <HR NOSHADE SIZE=1>
 <P></P>
     <UL>
-    <LI><A HREF="#toc1">The language independent API</A>
-    <LI><A HREF="#toc2">The language-dependent APIs</A>
-    <LI><A HREF="#toc3">Special-purpose APIs</A>
+    <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="#toc4">Multimodal</A>
-      <LI><A HREF="#toc5">Mathematical</A>
+      <LI><A HREF="#toc5">Multimodal</A>
+      <LI><A HREF="#toc6">Mathematical</A>
       </UL>
     </UL>
 
@@ -29,14 +30,49 @@ Last update: Tue Feb 21 16:23:46 2006
 <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 the
+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>
+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>
@@ -66,7 +102,7 @@ The documentation of the individual modules:
 <LI><A HREF="gfdoc/Lang.html">Lang</A>: the main module comprising all the others
 </UL>
 
-<A NAME="toc2"></A>
+<A NAME="toc3"></A>
 <H2>The language-dependent APIs</H2>
 <UL>
 <LI><A HREF="gfdoc/ParadigmsEng.html">ParadigmsEng</A>: English lexical paradigms
@@ -86,16 +122,16 @@ The documentation of the individual modules:
 <LI><A HREF="gfdoc/IrregSwe.gf">IrregSwe</A>: Swedish irregular verbs
 </UL>
 
-<A NAME="toc3"></A>
-<H2>Special-purpose APIs</H2>
 <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="toc5"></A>
+<A NAME="toc6"></A>
 <H3>Mathematical</H3>
 <UL>
 <LI><A HREF="gfdoc/Mathematical.html">Mathematical</A>: main module for mathematical language
@@ -105,6 +141,6 @@ The documentation of the individual modules:
 </UL>
 
 
-<!-- html code generated by txt2tags 2.0 (http://txt2tags.sf.net) -->
+<!-- html code generated by txt2tags 2.3 (http://txt2tags.sf.net) -->
 <!-- cmdline: txt2tags -\-toc -thtml index.txt -->
 </BODY></HTML>