]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/search.mdwn
updated branch; this is ready for review for inclusion in IkIWiki
[git.ikiwiki.info.git] / doc / plugins / search.mdwn
index 4c1b50fcd719e7e5aab71f35467014786e091e91..4d517a2664af800ee1d9c88e530dc11f472bc35c 100644 (file)
@@ -1,16 +1,17 @@
-[[template id=plugin name=search author="[[Joey]]"]]
-[[tag type/useful]]
+[[!template id=plugin name=search author="[[Joey]]"]]
+[[!tag type/web]]
 
 This plugin adds full text search to ikiwiki, using the
 
 This plugin adds full text search to ikiwiki, using the
-[xapian](http://xapian.org/) engine and its
-[omega](http://xapian.org/docs/omega/overview.html) frontend.
+[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).
 
 
-Ikiwiki will handle indexing new and changed page contents, using the
-[[cpan Search::Xapian]] perl modules. Note that it indexes page contents
-before they are preprocessed and converted to html, as this tends to
-produce less noisy search results. Also, since it only indexes page
-contents, files copied by the [[rawhtml]] plugin will not be indexed, nor
-will other types of data files.
+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
 
 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