Merge remote-tracking branch 'anarcat/dev/proxy-utf8-fail'

[git.ikiwiki.info.git] / doc / plugins / search.mdwn

diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn
index a95302fcc993516445c6027e86d1226823367b86..4d517a2664af800ee1d9c88e530dc11f472bc35c 100644 (file)
--- 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 (on debian, check that you have packages `xapian-omega`, `libsearch-xapian-perl`, `libdigest-sha-perl` and `libhtml-scrubber-perl` installed).

 
 

-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`.