Initial commit
[moodle.git] / search / README.txt
a25a3912 12006/07/11
3(Warning: It took me 1900 seconds to index the forum, go make coffee
4whilst you wait.)
6Forum search functions changed to use 'get_recordset' instead of
7'get_records', for speed reasons. This provides a significant improvement,
8but indexing is still slow - getting data from the database and Zend's
9tokenising _seem_ to be the prime suspects at the moment.
11/search/tests/ added - index.php can be used to see which modules are
12ready to be included in the search index, and it informs you of any
13errors - should be a prerequisite for indexing.
15Search result pagination added to query.php, will default to 20 until
16an admin page for the search module is written.
20Search-enabling functions moved out've the mod's lib.php files and into
21/search/documents/mod_document.php - this requires the search module to
22operate without requiring modification of lib files.
24SearchDocument base class improved, and the way module documents extend
25it. A custom-data field has been added to allow modules to add any custom
26data they wish to be stored in the index - this field is serialised into
27the index as a binary field.
29Database field 'type' renamed to 'doctype' to match the renaming in the
30index, 'type' seems to be a reserved word in Lucene. Several index field
31names change to be more descriptive (cid -> course_id). URLs are now
32stored in the index, and don't have to be generated on the fly during
33display of query results.
abb4ea20 36------
37Started cleaning and standardising things.
39cvs v1.1
682d4032 41This is the initial release (prototype) of Moodle's new search module -
42so basically watch out for sharp edges.
44The structure has not been finalised, but this is what is working at the
45moment, when I start looking at other content to index, it will most likely
46change. I don't recommend trying to make your own content modules indexable,
47at least not until the whole flow is finalised. I will be implementing the
48functions needed to index all of the default content modules on Moodle, so
49expect that around mid-August.
51Wiki pages were my goal for this release, they can be indexed and searched,
52but not updated or deleted at this stage (was waiting for ZF 0.14 actually).
54I need to check the PostgreSQL sql file, I don't have a PG7 install lying
55around to test on, so the script is untested.
57To index for the first time, login as an admin user and browse to /search/index.php
58or /search/stats.php - there will be a message and a link telling you to go index.
60-- Michael Champanis (mchampan)
62 Summer of Code 2006