X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/62e1a2ceed6d99e3606d81effaa71e009dbeb121..46f7dcb362da5d043c758453384a447f0360462c:/doc/plugins/search.mdwn diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index 5b5325371..67e3b85ef 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -1,12 +1,18 @@ -[[template id=plugin name=search included=1 author="[[Joey]]"]] +[[template id=plugin name=search author="[[Joey]]"]] [[tag type/useful]] -This plugin is included in ikiwiki, but is not enabled by default. It adds -full text search to ikiwiki, using the [[HyperEstraier]] engine. +This plugin adds full text search to ikiwiki, using the +[xapian](http://xapian.org/) engine, its +[omega](http://xapian.org/docs/omega/overview.html) frontend, +and the [[cpan Search::Xapian]] perl module. (The [[cpan HTML::Scrubber]] +perl module will also be used, if available.) -It's possible to configure HyperEstraier via one of ikiwiki's -[[templates]], but for most users, no configuration should be needed aside -from enabling the plugin. +Ikiwiki will handle indexing new and changed page contents. Note that it +indexes page contents before they are preprocessed and converted to html, +as this tends to produce less noisy search results. Also, since it only +indexes page contents, files copied by the [[rawhtml]] plugin will not be +indexed, nor will other types of data files. -This plugin has a configuration option. To change the path to estseek.cgi, -set `--estseek=/path/to/estseek.cgi` +There is one setting you may need to use in the config file. `omega_cgi` +should point to the location of the omega cgi program. The default location +is `/usr/lib/cgi-bin/omega/omega`.