]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/search.mdwn
Merge branch 'master' into xapian
[ikiwiki.git] / doc / plugins / search.mdwn
1 [[template id=plugin name=search author="[[Joey]]"]]
2 [[tag type/useful]]
3
4 This plugin adds full text search to ikiwiki, using the
5 [xapian](http://xapian.org/) engine, its
6 [omega](http://xapian.org/docs/omega/overview.html) frontend,
7 and the [[cpan Search::Xapian]] perl module. (The [[cpan HTML::Scrubber]]
8 perl module will also be used, if available.)
9
10 Ikiwiki will handle indexing new and changed page contents. Note that it
11 indexes page contents before they are preprocessed and converted to html,
12 as this tends to produce less noisy search results. Also, since it only
13 indexes page contents, files copied by the [[rawhtml]] plugin will not be
14 indexed, nor will other types of data files.
15
16 There is one setting you may need to use in the config file. `omega_cgi` 
17 should point to the location of the omega cgi program. The default location
18 is `/usr/lib/cgi-bin/omega/omega`.