379a27277c869154df6a68283b629208b757dab8
[moodle.git] / search / README.txt
1 2006/08/21
2 ----------
3 Fixed index document count, and created new config variable to store
4 the size. (Search now has 3 global vars in $CFG, date, size and complete,
5 see indexer.php for var names). Index size is cached to provide an always
6 current value for the index - this is to take into account the fact that
7 deleted documents are in fact not removed from the index, but instead just
8 marked as deleted and not returned in search results. The actual document
9 still features in the index, and skews sizes. When the index optimiser is
10 completed in ZFS, then these deleted documents will be pruned, thus 
11 correctly modifying the index size.
13 Additional commenting added.
15 Query page logic very slightly modified to clean up GET string a bit (removed
16 'p' variable).
18 Add/delete functions added to other document types.
20 A few TODO fields added to source, indicating changes still to come (or at
21 least to be considered).
23 2006/08/16
24 ----------
25 Add/delete/update cron functions finished - can be called seperately
26 or all at once via cron.php.
28 Document date field added to index and database summary.
30 Some index db functionality abstracted out to indexlib.php - can
31 use IndexDBControl class to add/del documents from database, and
32 to make sure the db table is functioning.
34 DB sql files changed to add some extra fields.
36 Default 'simple' query modified to search title and author, as well
37 as contents of document, to provide better results for users.
39 2006/08/14
40 ----------
41 First revision of the advanced search page completed. Functional,
42 but needs a date search field still.
44 2006/08/02
45 ----------
46 Added resource search type, and the ability to specify custom 'virtual'
47 models to search - allowing for non-module specific information to be
48 indexed. Specify the extra search types to use in lib.php.
50 2006/07/28
51 ----------
52 Added delete logic to documents; the moodle database log is checked
53 and any found delete events are used to remove the referenced documents
54 from the database table and search index.
56 Added database table name constant to lib.php, must change files using
57 the static table name.
59 Changed documents to use 'docid' instead of 'id' to reference the moodle
60 instance id, since Zend Search adds it's own internal 'id' field. Noticed
61 this whilst working on deletions.
63 Added some additional fields to the permissions checking method, must still
64 implement it though.
66 2006/07/25
67 ----------
68 Query logic moved into the SearchQuery class in querylib.php. Should be able
69 to include this file in any page and run a query against the index (PHP 5
70 checks must be added to those pages then, though).
72 Index info can be retrieved using IndexInfo class in indexlib.php.
74 Abstracted some stuff away, to reduce rendundancy and decrease the
75 likelihood of errors. Improved the stats.php page to include some
76 diagnostics for adminstrators.
78 delete.php skeleton created for removing deleted documents from the
79 index. cron.php will contain the logic for running delete.php,
80 update.php and eventually add.php.
82 2006/07/11
83 ----------
84 (Warning: It took me 1900 seconds to index the forum, go make coffee
85 whilst you wait.) [Moodle.org forum data]
87 Forum search functions changed to use 'get_recordset' instead of
88 'get_records', for speed reasons. This provides a significant improvement,
89 but indexing is still slow - getting data from the database and Zend's
90 tokenising _seem_ to be the prime suspects at the moment.
92 /search/tests/ added - index.php can be used to see which modules are
93 ready to be included in the search index, and it informs you of any
94 errors - should be a prerequisite for indexing.
96 Search result pagination added to query.php, will default to 20 until
97 an admin page for the search module is written.
99 2006/07/07
100 ----------
101 Search-enabling functions moved out've the mod's lib.php files and into
102 /search/documents/mod_document.php - this requires the search module to
103 operate without requiring modification of lib files.
105 SearchDocument base class improved, and the way module documents extend
106 it. A custom-data field has been added to allow modules to add any custom
107 data they wish to be stored in the index - this field is serialised into
108 the index as a binary field.
110 Database field 'type' renamed to 'doctype' to match the renaming in the
111 index, 'type' seems to be a reserved word in Lucene. Several index field
112 names change to be more descriptive (cid -> course_id). URLs are now
113 stored in the index, and don't have to be generated on the fly during
114 display of query results.
116 2006/07/05
117 ------
118 Started cleaning and standardising things.
120 cvs v1.1
121 --------
122 This is the initial release (prototype) of Moodle's new search module -
123 so basically watch out for sharp edges.
125 The structure has not been finalised, but this is what is working at the
126 moment, when I start looking at other content to index, it will most likely
127 change. I don't recommend trying to make your own content modules indexable,
128 at least not until the whole flow is finalised. I will be implementing the
129 functions needed to index all of the default content modules on Moodle, so
130 expect that around mid-August.
132 Wiki pages were my goal for this release, they can be indexed and searched,
133 but not updated or deleted at this stage (was waiting for ZF 0.14 actually).
135 I need to check the PostgreSQL sql file, I don't have a PG7 install lying
136 around to test on, so the script is untested.
138 To index for the first time, login as an admin user and browse to /search/index.php
139 or /search/stats.php - there will be a message and a link telling you to go index.
141 -- Michael Champanis (mchampan)
142    email: cynnical@gmail.com
143    skype: mchampan
144    Summer of Code 2006