X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Fsearch.mdwn;h=e95739cf36569171e863e7587c3613bea53f4b50;hb=1ce0d17dc758c4025d2e2eea79a691a8dbb90414;hp=5b53253714222e0b20f027890ee2da5e563c261c;hpb=62e1a2ceed6d99e3606d81effaa71e009dbeb121;p=ikiwiki.git diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index 5b5325371..e95739cf3 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -1,12 +1,18 @@ -[[template id=plugin name=search included=1 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::SHA]], and [[!cpan HTML::Scrubber]] +perl modules. -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. +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`.