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