⇤ ← Revision 1 as of 2007-08-11 01:33:18
1879
Comment:
|
3116
|
Deletions are marked like this. | Additions are marked like this. |
Line 25: | Line 25: |
See Section 4 on how to produce these files | See Section 3 on how to produce these files |
Line 63: | Line 63: |
== 3 Index building == === 3.1 Parsing === {{{ svn checkout file://KM/ir/SVN/xmlparser vim <db>.parse.cpp g++ <db>.parse.cpp }}} This should produce a <db>.words file and a <db>.docs file. Actually it doesn't matter how they are produced, as long as they adhere to the format [TODO: explain]. === 3.2 Sorting === {{{ sort -k1,1 -k2,2n -k4,4n <db>.words_unsorted > <db>.words sort -k1,1n <db>.docs_unsorted > <db>.docs }}} In case the <db>.words and <db>.docs file are not sorted acoording to the format specifications [TODO: link], this would be a way to sort them. If the files were produced with the help of xmlparser above (or by any parser which just outputs things in the order it encounters them), sorting is necessary. === 3.3 Words Index (<db>.hybrid and <db>.vocabulary) === {{{ make buildIndex buildIndex HYB <db>.words }}} For good efficiency it is actually a bit more tricky (good choice block boundaries is important). TODO: take this burden from the user, and incorporate it into buildIndex === 3.4 Docs Index (<db>.docs.DB) === {{{ make buildDocsDB buildDocsDB <db>.docs }}} Run without arguments for detailed usage information about command line options etc. |
1. Completion Server (C++)
1.1 Get it
svn checkout file://KM/ir/SVN/autocompletion
1.2 Compile it
make startCompletionServer
1.3 Run it
startCompletionServer -p <port> -l <log file> <db>.hybrid
call without arguments for detailed usage information
requires three files: <db>.hybrid (the HYB index in some binary format), <db>.vocabulary (list of distinct words in sorted order), <db>.docs.db (url + title + raw text of the documents)
See Section 3 on how to produce these files
2. Web Server (Apache + PHP)
2.1 Get it
svn checkout file://KM/ir/SVN/autocomplete-php
contains three components:
2.1.1 application-independent code: the autocomplete directory
2.1.2 application-specific code: the files index.php, autocomplete.css, autocomplete_config.php
2.1.3 web-server configuration details: the file STILL_HAS_TO_BE_WRITTEN.txt
2.2 Configure it
mkdir <some dir> cp index.php autocomplete.css autocomplete_config.php <some dir>
<some dir> should be a directory served by your web server. The search engine will then be accessible unter http://<server name>/.../<some dir>
vim autocomplete_config.php
The config file is just a list of variable assignements. It is well-documented and clearly says [TODO: not yet] which parts you must adapt (few), and which you can just leave to their default values (you can always come back and change them later).
vim <apache config file>
Adapt it as explained in the web-server configuration file from 2.1.3 above. You must have Apache + PHP installed (PHP4 or PHP5 are both fine). [TODO: give details on how to install it. For Debian, it's a simple package libapache2-mod-php4. For windows there is an installer [TODO].]
3 Index building
3.1 Parsing
svn checkout file://KM/ir/SVN/xmlparser vim <db>.parse.cpp g++ <db>.parse.cpp
This should produce a <db>.words file and a <db>.docs file. Actually it doesn't matter how they are produced, as long as they adhere to the format [TODO: explain].
3.2 Sorting
sort -k1,1 -k2,2n -k4,4n <db>.words_unsorted > <db>.words sort -k1,1n <db>.docs_unsorted > <db>.docs
In case the <db>.words and <db>.docs file are not sorted acoording to the format specifications [TODO: link], this would be a way to sort them. If the files were produced with the help of xmlparser above (or by any parser which just outputs things in the order it encounters them), sorting is necessary.
3.3 Words Index (<db>.hybrid and <db>.vocabulary)
make buildIndex buildIndex HYB <db>.words
For good efficiency it is actually a bit more tricky (good choice block boundaries is important). TODO: take this burden from the user, and incorporate it into buildIndex
3.4 Docs Index (<db>.docs.DB)
make buildDocsDB buildDocsDB <db>.docs
Run without arguments for detailed usage information about command line options etc.