Merge commit 'origin/master'

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

diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn
index 78088aed87e0a0d36f77af68fb6bb4b489022844..92cc5945a27489c9118e272582bd15651456c3dd 100644 (file)
--- a/doc/plugins/search.mdwn
+++ b/doc/plugins/search.mdwn
@@ -1,8 +1,18 @@
-This plugin is included in ikiwiki, but is not enabled by default. It adds
-full text search to ikiwiki, using the [[HyperEstraier]] engine.
+[[!template id=plugin name=search author="[[Joey]]"]]
+[[!tag type/web]]

 
 

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

 
 

-[[tag type/useful]]
+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`.