[ikiwiki] / doc / plugins / search.mdwn

[[!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]], [[!cpan Digest::SHA1]], and [[!cpan HTML::Scrubber]]
perl modules.

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`.
Commit	Line	Data
297ff849	1	[[!template id=plugin name=search author="[[Joey]]"]]
8c191adf	2	[[!tag type/web]]
9d7375c3	3
8a6a5320	4	This plugin adds full text search to ikiwiki, using the
ce826411	5	[xapian](http://xapian.org/) engine, its
3215b5a9	6	[omega](http://xapian.org/docs/omega/overview.html) frontend, and the
297ff849	7	[[!cpan Search::Xapian]], [[!cpan Digest::SHA1]], and [[!cpan HTML::Scrubber]]
3215b5a9 JH	8	perl modules.
	9
	10	The [[ikiwiki/searching]] page describes how to write search queries.
af9566ff	11
1dddec0b JH	12	Ikiwiki will handle indexing new and changed page contents. Note that since
	13	it only indexes page contents, files copied by the [[rawhtml]] plugin will
	14	not be indexed, nor will other types of data files.
62e1a2ce	15
8a6a5320 JH	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`.