Advanced search page added.
[moodle.git] / search / README.txt
1 2006/08/14
2 ----------
3 First revision of the advanced search page completed. Functional,
4 but needs a date search field still.
6 2006/08/02
7 ----------
8 Added resource search type, and the ability to specify custom 'virtual'
9 models to search - allowing for non-module specific information to be
10 indexed. Specify the extra search types to use in lib.php.
12 2006/07/28
13 ----------
14 Added delete logic to documents; the moodle database log is checked
15 and any found delete events are used to remove the referenced documents
16 from the database table and search index.
18 Added database table name constant to lib.php, must change files using
19 the static table name.
21 Changed documents to use 'docid' instead of 'id' to reference the moodle
22 instance id, since Zend Search adds it's own internal 'id' field. Noticed
23 this whilst working on deletions.
25 Added some additional fields to the permissions checking method, must still
26 implement it though.
28 2006/07/25
29 ----------
30 Query logic moved into the SearchQuery class in querylib.php. Should be able
31 to include this file in any page and run a query against the index (PHP 5
32 checks must be added to those pages then, though).
34 Index info can be retrieved using IndexInfo class in indexlib.php.
36 Abstracted some stuff away, to reduce rendundancy and decrease the
37 likelihood of errors. Improved the stats.php page to include some
38 diagnostics for adminstrators.
40 delete.php skeleton created for removing deleted documents from the
41 index. cron.php will contain the logic for running delete.php,
42 update.php and eventually add.php.
44 2006/07/11
45 ----------
46 (Warning: It took me 1900 seconds to index the forum, go make coffee
47 whilst you wait.) [ forum data]
49 Forum search functions changed to use 'get_recordset' instead of
50 'get_records', for speed reasons. This provides a significant improvement,
51 but indexing is still slow - getting data from the database and Zend's
52 tokenising _seem_ to be the prime suspects at the moment.
54 /search/tests/ added - index.php can be used to see which modules are
55 ready to be included in the search index, and it informs you of any
56 errors - should be a prerequisite for indexing.
58 Search result pagination added to query.php, will default to 20 until
59 an admin page for the search module is written.
61 2006/07/07
62 ----------
63 Search-enabling functions moved out've the mod's lib.php files and into
64 /search/documents/mod_document.php - this requires the search module to
65 operate without requiring modification of lib files.
67 SearchDocument base class improved, and the way module documents extend
68 it. A custom-data field has been added to allow modules to add any custom
69 data they wish to be stored in the index - this field is serialised into
70 the index as a binary field.
72 Database field 'type' renamed to 'doctype' to match the renaming in the
73 index, 'type' seems to be a reserved word in Lucene. Several index field
74 names change to be more descriptive (cid -> course_id). URLs are now
75 stored in the index, and don't have to be generated on the fly during
76 display of query results.
78 2006/07/05
79 ------
80 Started cleaning and standardising things.
82 cvs v1.1
83 --------
84 This is the initial release (prototype) of Moodle's new search module -
85 so basically watch out for sharp edges.
87 The structure has not been finalised, but this is what is working at the
88 moment, when I start looking at other content to index, it will most likely
89 change. I don't recommend trying to make your own content modules indexable,
90 at least not until the whole flow is finalised. I will be implementing the
91 functions needed to index all of the default content modules on Moodle, so
92 expect that around mid-August.
94 Wiki pages were my goal for this release, they can be indexed and searched,
95 but not updated or deleted at this stage (was waiting for ZF 0.14 actually).
97 I need to check the PostgreSQL sql file, I don't have a PG7 install lying
98 around to test on, so the script is untested.
100 To index for the first time, login as an admin user and browse to /search/index.php
101 or /search/stats.php - there will be a message and a link telling you to go index.
103 -- Michael Champanis (mchampan)
105    Summer of Code 2006