249c8f8b5e421078c4224f49c5b632e6e34e867a
[moodle.git] / search / README.txt
1 2006/07/25
2 ----------
3 Query logic moved into the SearchQuery class in querylib.php. Should be able
4 to include this file in any page and run a query against the index (PHP 5
5 checks must be added to those pages then, though).
7 Index info can be retrieved using IndexInfo class in indexlib.php.
9 Abstracted some stuff away, to reduce rendundancy and decrease the
10 likelihood of errors. Improved the stats.php page to include some
11 diagnostics for adminstrators.
13 delete.php skeleton created for removing deleted documents from the
14 index. cron.php will contain the logic for running delete.php,
15 update.php and eventually add.php.
17 2006/07/11
18 ----------
19 (Warning: It took me 1900 seconds to index the forum, go make coffee
20 whilst you wait.) [Moodle.org forum data]
22 Forum search functions changed to use 'get_recordset' instead of
23 'get_records', for speed reasons. This provides a significant improvement,
24 but indexing is still slow - getting data from the database and Zend's
25 tokenising _seem_ to be the prime suspects at the moment.
27 /search/tests/ added - index.php can be used to see which modules are
28 ready to be included in the search index, and it informs you of any
29 errors - should be a prerequisite for indexing.
31 Search result pagination added to query.php, will default to 20 until
32 an admin page for the search module is written.
34 2006/07/07
35 ----------
36 Search-enabling functions moved out've the mod's lib.php files and into
37 /search/documents/mod_document.php - this requires the search module to
38 operate without requiring modification of lib files.
40 SearchDocument base class improved, and the way module documents extend
41 it. A custom-data field has been added to allow modules to add any custom
42 data they wish to be stored in the index - this field is serialised into
43 the index as a binary field.
45 Database field 'type' renamed to 'doctype' to match the renaming in the
46 index, 'type' seems to be a reserved word in Lucene. Several index field
47 names change to be more descriptive (cid -> course_id). URLs are now
48 stored in the index, and don't have to be generated on the fly during
49 display of query results.
51 2006/07/05
52 ------
53 Started cleaning and standardising things.
55 cvs v1.1
56 --------
57 This is the initial release (prototype) of Moodle's new search module -
58 so basically watch out for sharp edges.
60 The structure has not been finalised, but this is what is working at the
61 moment, when I start looking at other content to index, it will most likely
62 change. I don't recommend trying to make your own content modules indexable,
63 at least not until the whole flow is finalised. I will be implementing the
64 functions needed to index all of the default content modules on Moodle, so
65 expect that around mid-August.
67 Wiki pages were my goal for this release, they can be indexed and searched,
68 but not updated or deleted at this stage (was waiting for ZF 0.14 actually).
70 I need to check the PostgreSQL sql file, I don't have a PG7 install lying
71 around to test on, so the script is untested.
73 To index for the first time, login as an admin user and browse to /search/index.php
74 or /search/stats.php - there will be a message and a link telling you to go index.
76 -- Michael Champanis (mchampan)
77    cynnical@gmail.com
78    Summer of Code 2006