Tdl from grammar

README.rst

@@ -12,16 +12,50 @@ documentation in the grammar, a kind of literate programming.
 There is `more documentation <http://moin.delph-in.net/LkbLtdb>`__ at
 the DELPH-IN Wiki.
 
+
+LTDB assumes that the grammar follows the usual DELPH-IN conventions,
+in particular that there is a grammar directory with sub directories
+for ace and lkb config files.  
+
+``
+grammar/ace/config.tdl
+grammar/lkb/script
+``
+
+If your `orth-path` is not `STEM` then you must have it defined in the
+**top** ace config file, we do not follow includes for config files (yet). 
+
 --------------
 
 Usage
 -----
 
-1. Run ``./make-ltdb.bash --grmdir /path/to/grammar``
+0. Prepare the local environment
+   ``
+   python3 -m venv .venv
+   source .venv/bin/activate
+   python3 -m pip install --upgrade pip
+   pip install -r requirements.txt
+   ``
+
+1. Run ``./make-ltdb.bash --script /path/to/grammar/lkb/script``
+
+or (somewhat experimental but gets more docstrings)
+
+2. Run ``./make-ltdb.bash --acecfg /path/to/ace/config.tdl``
+
+3. Add extra lisp to call before the script
+   ``./make-ltdb.bash   --lisp '(push :mal *features*)' --script /path/to/grammar/lkb/script``
+
+4. You can tell it to just read the grammar, not gold (mainly useful for debugging)
+   ``./make-ltdb.bash --acecfg /path/to/ace/config.tdl --nogold``
+
+You can load from lisp and ace versions of the grammar, it will try to merge information from both.
 
 .. code:: bash
 
-    ./make-ltdb.bash --grmdir ~/logon/dfki/jacy
+    ./make-ltdb.bash --script ~/logon/dfki/jacy/lkb/script
+    ./make-ltdb.bash --acecfg ~/logon/dfki/jacy/ace/config.tdl
 
 Everything is installed to ``~/public_html/``
 
@@ -33,28 +67,27 @@ Requirements
 
 ::
 
-      * python 2.7, python 3, pydelphin, docutils, lxml
+      * python 3, pydelphin, docutils, lxml
       * Perl
       * SQLite3
       * Apache
       * LKB/Lisp        for db dump
       * xmlstarlet      for validating lisp
 
-We prefer that Sentence IDs are unique, if we see two sentences in the
-gold treebank with the same ID, we only store the first one.
+We store items as (profile, item-id) pairs, so Sentence IDs do not
+need to be unique.
 
-Only the new LKB-FOS (http://moin.delph-in.net/LkbFos) suppoorts the new docstring comments.  We assume it is installed in
+Only the new LKB-FOS (http://moin.delph-in.net/LkbFos) supports the new docstring comments.  We assume it is installed in
 ``LKBFOS=~/delphin/lkb_fos/lkb.linux_x86_64``.
 
 Install dependencies (in ubuntu):
 
 .. code:: bash
 
-    sudo apt-get install apache2 xmlstarlet
-    sudo apt-get install python-docutils python3-docutils python3-lxml
+    sudo apt-get install apache2 xmlstarlet p7zip sqlite3
+    sudo apt-get install python3-docutils python3-lxml
 
-    sudo pip install pydelphin --upgrade
-    sudo pip3 install pydelphin --upgrade
+    pip install pydelphin --upgrade
 
 Enable local directories in Apache2
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -66,7 +99,7 @@ This may be different on different operating systems
     sudo a2enmod userdir
     sudo a2enmod cgi
 
-Put this in ``/etc/apache2/sites-available/000-default.conf``
+Put this at the end of ``/etc/apache2/sites-available/000-default.conf``
 
 .. code:: xml
 
@@ -99,11 +132,44 @@ If the LKB complains
 it probably means you have a docstring in an instance file, or an old
 version of the LKB. Make sure you only document types for now.
 
+If you are having trouble with apache encodings, set the following in ``/etc/apache2/apache2.conf``
+
+::
+
+   SetEnv PYTHONIOENCODING utf8
+
+To make debugging 
+
+On Ubuntu 18.04, to get python3 modwsgi working if you have updated from an earlier version (so your python defaults to 2.7) do this
+
+.. code:: bash
+
+    sudo apt-get install libapache2-mod-wsgi-py3 
+    sudo update-alternatives --install /usr/bin/python python /usr/bin/python2.7 1 
+    sudo update-alternatives --install /usr/bin/python python /usr/bin/python3.6 2 
+
+Links go to the wrong place
+---------------------------
+
+ltdb assumes that the code is being served from a machine whose name
+is  ``hostname -f`` using ``http`` in your ``public_html``.  If that is not true, e.g. you
+want to change the host, or port or use https, then please change the
+appropriate parts of ``params``. 
+
+.. code:: bash
+
+    charset=utf-8
+    dbroot=/home/bond/public_html/cgi-bin/ERG_mal_mo
+    db=/home/bond/public_html/cgi-bin/ERG_mal_mo/lt.db
+    cssdir=http://mori/~bond/ltdb/ERG_mal_mo
+    cgidir=http://mori/~bond/cgi-bin/ERG_mal_mo
+    ver=ERG_mal_mo
+
+
+
 Todo
 ----
 
--  check I am getting lrule/irule right
-
 --------------
 
 Types, instances in the same table, distinguished by status.
@@ -114,15 +180,15 @@ Types, instances in the same table, distinguished by status.
 +==========+====================================+===================+======+
 |type      |normal type                         |                   |      |
 +----------+------------------------------------+-------------------+------+
-|ltype     |lexical type                        |type + in lexicon  | _lt  |
+|lex-type  |lexical type                        |type + in lexicon  | _lt  |
 +----------+------------------------------------+-------------------+------+
 |lex-entry |lexical entry                       |                   | _le  |   
 +----------+------------------------------------+-------------------+------+
 |rule      |syntactic construction/grammar rule | LKB:\*RULES       | _c   |
 +----------+------------------------------------+-------------------+------+
-|lrule	   |lexical rule                        | LKB:\*LRULES      | lr   |
+|lex-rule  | lexical rule                       | LKB:\*LRULES      | lr   |
 +----------+------------------------------------+-------------------+------+
-|irule	   |inflectional rule                   | LKB:\*LRULES +    | ilr  | 
+|inf-rule  |inflectional rule                   | LKB:\*LRULES +    | ilr  | 
 +----------+------------------------------------+-------------------+------+
 |          |            (inflectional-rule-pid )|                   |      |
 +----------+------------------------------------+-------------------+------+
@@ -153,5 +219,3 @@ Types, instances in the same table, distinguished by status.
 +--------+--------------------------------------+
 |  ◬    | Binary, Non-Headed                   |
 +--------+--------------------------------------+
-
-FIXME: add IDIOMS as a different table

ToDo

@@ -1,3 +1,9 @@
+ * look at lisp with John
+  * prettier lisp
+  * hyperlinked types
+  * types without glb
+
+
  * Better linking to surface form