]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/search.mdwn
second review pass and I have a revert branch now
[git.ikiwiki.info.git] / doc / plugins / search.mdwn
index 67e3b85ef65fdcb634e5d4a05930b767af64b482..e95739cf36569171e863e7587c3613bea53f4b50 100644 (file)
@@ -1,17 +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
 [xapian](http://xapian.org/) engine, its
-[omega](http://xapian.org/docs/omega/overview.html) frontend,
-and the [[cpan Search::Xapian]] perl module. (The [[cpan HTML::Scrubber]]
-perl module will also be used, if available.)
+[omega](http://xapian.org/docs/omega/overview.html) frontend, and the
+[[!cpan Search::Xapian]], [[!cpan Digest::SHA]], and [[!cpan HTML::Scrubber]]
+perl modules.
 
-Ikiwiki will handle indexing new and changed page contents. 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