PML-TQ - Query engine and query language for trees in PML format

This distribution contains an implementation of a PML-TQ search engine
(CGI and HTTP server) and a command-line client. A graphical client
for PML-TQ is part of the tree editor TrEd
(http://ufal.mff.cuni.cz/pajas/~tred).

Documentation:

	doc/pmltq_doc.html - Manual
	README (this file)

License:

	General Public License v 2.0
	see LICENSE

Directory structure:

	config    - sample configuration files (must edit first!)
	contrib   - sample conversion scripts (e.g. for PDT 2.0)
	doc       - documentation
	libs      - perl modules used by pmltq
	resources - PML schemas used by pmltq
	sql       - SQL scripts to init the database

Scripts:
	install_deps.sh - install modules required by the search server
	pmltq_http  - small HTTP server providing PML-TQ services
	pml2base.pl - PML to SQL database conversion script
	pmltq	    - command-line client for SQL or HTTP engine

Quick start:

  * install PostgreSQL >= 8.4
             or Oracle >= 10g database (e.g. the free XE version)

  * create a new directory for data conversion by copying
    the contrib/prepare_data/sample/ directory 

     mkdir my_treebank_pmltq
     cd  my_treebank_pmltq
     cp -R contrib/prepare_data/sample/* .

  * convert your treebank into the PML format (depends on the native
    format of your data)

  * create a soft-link to your treebank data in my_treebank_pmltq (just for convenience)

    ln -s /path/to/your/treebank/data/in/pml data

  * edit carefully the following configuration scripts in my_treebank_pmltq directory
    according to the comments provided there:

    $EDITOR bin/config.sh
    $EDITOR bin/convert_to_db.sh
    
  * run the following script on any machine

    bin/convert_to_db.sh

  * run the following scripts on the machine running the SQL server or
    a machine able to access the SQL server via the database command-line
    client (sqlplus or psql)

    bin/create_db.sh
    bin/load_to_db.sh

  * change to the pmltq installation directory

    cd /path/to/pmltq

  * create/edit the configuration file config/pmltq_cgi.conf :

    [ -f config/pmltq_cgi.conf ] || mv config/pmltq_cgi.conf.sample config/pmltq_cgi.conf
    $EDITOR config/pmltq_cgi.conf
    
  * create/edit the configuration file run/run.conf :

    [ -f run/run.conf ] || mv run/run.conf.sample run/run.conf
    $EDITOR run/run.conf

  * start PMLTQ servers 

    run/run.sh --start

  * use them:

      	  open http://localhost:8082/query in your browser
            or
	  ./pmltq 
	    or 
	  start TrEd, press Shift+F3, configure connection,
	  create a query and press Space 
	  
Copyright:

	Petr Pajas and Jan Stepanek (c) 2008-2009
