LexDB Usage Instructions

NEW: See LkbLexDbSingleUser for SINGLE USER LexDB (lightweight system).

(BenWaldron is responsible for this module.)

If running the LKB runtime binary:

• Download and install (LkbInstallation) the latest LKB, taking care to install/extract the lkb_data.tgz archive into the lkb installation directory (henceforth [Linux] ~/lkb).

If running the LKB from source:

• Download and compile (LkbCompilation) the LKB, ensuring that

  • your .clinit.cl file contains (pushnew :psql *features*)

Now initialize the database server (LexDbPsqlInitialize) and the lexical database itself (LexDbInitialize).

HOW TO set the filter

LexDB -> Set Filter

The filter specified is interpreted as an SQL WHERE clause. Examples:

     userid = 'danf'
     userid = 'danf' AND dialect = 'my_dialect'
     userid IN ('danf', 'aac')
     confidence > 0.5

(Note: the default is NULL. Change this to a non-NULL value to select a subset of the lexical database.)

The filter determines the entries in the lexicon as seen by a particular user. Only revision entries matching the filter conditions in filter can form part of the lexicon (of these, the most recent revision is the one actually used).

HOW TO store LexDB in CVS

The LexDB may be dumped to text files which can then be uploaded to storage in CVS.

1. LexDB -> Dump

(This will dump public schema tables to text files -- eg. lexdb.rev, lexdb.rev_key, lexdb.dfn, lexdb.fld, lexdb.meta) BR(Note: the dump mechanism will also produce a .tdl file if *lexdb-dump-tdl* is set to t) BR(Note: the database dump files are tab-separated with null as \N)

2. Run the cvs commit command. E.g.

• cvs commit ~/erg/lexdb.*

HOW TO retrieve LexDB from CVS

1. Run the cvs update command to retrieve the latest dump file. E.g.

• cvs update ~/erg/lexdb.*

2. LexDB -> Load ('rev' entries)

These steps update the LexDB (public schema) to include all new revisions stored in a CVS dump file. The new entries will be copied to the table public.rev_new. Any changes made to your copy of the LexDB since the last update will be preserved.

HOW TO export LexDB to TDL file

LexDB -> Export (TDL file)

Dumps active LexDB entries (determined by filter) to .tdl file.

HOW TO edit entries in the LexDB

The LexDB-Emacs interface allows editing of lexical entries from within an Emacs environment (with browsing functionality, field completion, etc.). New revision entries are first stored in the users private schema, and hence are visible only to the particular user.

0. Add the following (path adjusted for your setup) to your .emacs file:

(add-to-list 'load-path "/path/to/delphin/lkb/lexdb")
(load "pg-interface")

1. In [http://www.gnu.org/software/emacs/emacs.html GNU Emacs]: M-x lexdb to enter LexDB major mode. Then see the PG menu.

Available commands in LexDB major mode are:

C-l : load (active revision of lexical entry) into Emacs

C-c C-c : commit (edited/new revision of) lexical entry into LexDB

TAB : field completion

M-TAB l : get (ring of) entries in table lex where value of current field matches that in buffer

M-TAB r : get (ring of) entries in union of rev tables where value of current field matches that in buffer

M-n : cycle through ring of entries obtained above

M-s : as M-TAB, but explicitly specify field value

M-va : view entries added in merge operation from dump file

M-vs : view entries in user's privat rev

To remove a lexical entry from the current lexicon lex, create a (head) revision where the dead field is set to t (true) rather than f (false). In this manner we keep a revision history even for entries which are no longer used (and such entries can be reactivated if necessary). No revision entry should ever be deleted from the lexical database itself.

HOW TO import TDL entries from a file

To add a small number of new (revision) entries from a .tdl file: LexDB -> Import (TDL file). You will be queried to provide values for other certain non-grammar fields. The entries will go into the private rev table.

HOW TO commit entries to public rev

The LexDB consists of a single public schema and a set of private schemas, one per user. New (revision) entries are placed initially in your private schema. To commit (all) entries in your private schema to the public table: LexDB -> Commit private 'rev'

HOW TO list entries in private rev

From LKB: LexDB -> Display private 'rev'

or

from Emacs LexDB major mode: M-vs

HOW TO clear entries in private rev

LexDB -> Clear private 'rev

Further Topics