{{ :blocks:logo-apl.png?nolink |}} =====Lucene global search engine ===== {{ :local:recherches.png?nolink&150|}} ==== Presentation ==== The internal search engine based on Lucene comes from the original version by Michael Champanis, with contributions from Helen Foster, initially presented in Moodle 1.X versions, then migrated and consolidated for versions after 2. **Unlike the Solr engine**, which requires installing an external server to index resources, the Lucene engine is integrated into Moodle and uses the Zend indexing libraries autonomously. The indexing process relies on building "pseudo documents" from the data contained in a resource or an activity, to derive an indexable representation of the content based on the "significant" words it contains. It scans all the words found in all the resources of a Moodle instance, and builds an entry index filtered by subsets. Entries are associated with metadata that allow weighting of search priorities. The index files are stored in the platform's moodledata. Once built, search is extremely fast. Background tasks update the index by adding/modifying/deleting entries when needed. All search results are checked against the user's current profile, to determine their right to obtain a given result, including when the configuration of the searched objects has changed in the meantime. ==== Features ==== * Choice of terms to include * Choice of exclusions * Choice of search restricted to an activity module * Improved return ranking by entering an additional term * Use of booleans: OR AND * Use of the wildcard term * * Access to statistics ----- ==== Guides ==== * [[Local:Search:installguide|Installation guide]] :TODO: * [[Local:Search:userguide|User guide]] * [[Local:Search:technique|Technical guide]]:TODO: ====Technical sheet==== * **Component type:** Local plugin * **Name:** local_search * **Supported versions:** :M41: to :M53: * **Distribution:** **PRO** (TAM) * **Availability:** Beta ==== Builds ==== Note: a "Failing" status does not necessarily mean that the plugin does not work. This status reflects the result of automated tests checking the code against Moodle's strict standards. We are continuously working on bringing all supported plugins progressively into compliance with these development rules. ^ Branch ^ Continuous integration tests ^ | 405 | | | 501 | | ==== Credits ==== * Valéry Frémaux (valery@activeprolearn.com) Development and tests * Florence Labord (florence@activeprolearn.com) Documentation and functional tests [[:Plugins|Back to plugins index]] - [[:start|Back to catalogue index]] - [[:pluginsets|Index by functional sets]]