X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8f8959c96ecc69ecc75b5e5c76b52345afce94d8..dd8cb45ad889344e081e79fbcdd5500f5d05a69e:/doc/plugins/search.mdwn?ds=sidebyside diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index b9875ff85..e95739cf3 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -1,9 +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. + +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`.