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