X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d73eb7d9b2569ebb44fc79480b6ec2d8c1faea5d..34076e398cb7662e3bf0659d591faa4208679882:/doc/plugins/search.mdwn?ds=sidebyside diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index 7b32714f4..92cc5945a 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -1,12 +1,18 @@ -[[template id=plugin name=search author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=search author="[[Joey]]"]] +[[!tag type/web]] -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]], [[!cpan Digest::SHA1]], and [[!cpan HTML::Scrubber]] +perl modules. -It's possible to configure HyperEstraier via one of ikiwiki's -[[templates|wikitemplates]], but for most users, no configuration should be -needed aside from enabling the plugin. +The [[ikiwiki/searching]] page describes how to write search queries. -This plugin has a configuration option. To change the path to estseek.cgi, -set `--estseek=/path/to/estseek.cgi` +Ikiwiki will handle indexing new and changed page contents. Note that since +it only indexes page contents, files copied by the [[rawhtml]] plugin will +not be indexed, nor will other types of data files. + +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`.