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::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).

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`.
Migrate doc/plugins via prefix_directives This is a partial commit of: egrep -rl '\[\[[a-z]+ ' doc \| xargs --max-args 1 ./ikiwiki-transition prefix_directives 2008-07-21 13:31:57 +02:00			`[[!template id=plugin name=search author="[[Joey]]"]]`
tag updates 2008-10-09 22:58:25 +02:00			`[[!tag type/web]]`
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin. 2006-08-23 07:41:07 +02:00
search: Converted to use xapian-omega. Everything is done except for the actual indexing. I plan to do incremental indexing as pages change. 2008-06-03 21:29:54 +02:00			`This plugin adds full text search to ikiwiki, using the`
more search improvements 2008-06-04 06:38:40 +02:00			`[xapian](http://xapian.org/) engine, its`
finishing touches on the new search plugin - Add a Help link. - If the pageterm is too long, hash it. 2008-06-04 21:24:05 +02:00			`[omega](http://xapian.org/docs/omega/overview.html) frontend, and the`
Use Digest::SHA built into perl rather than external Digest::SHA1 to simplify dependencies. Closes: #591040 2010-07-31 21:54:25 +02:00			`[[!cpan Search::Xapian]], [[!cpan Digest::SHA]], and [[!cpan HTML::Scrubber]]`
Note 'xapian-omega' package 2013-11-28 16:20:44 +01:00			perl modules (on debian, check that you have packages `xapian-omega`, `libsearch-xapian-perl`, `libdigest-sha-perl` and `libhtml-scrubber-perl` installed).
finishing touches on the new search plugin - Add a Help link. - If the pageterm is too long, hash it. 2008-06-04 21:24:05 +02:00
			`The [[ikiwiki/searching]] page describes how to write search queries.`
rather a lot of changes to make hyperestraier search be a plugin, allowing for other types of search engine plugins if wanted, and also opening up a lot of new possibilities for other kinds of plugins later some notable changes along the way: - lots of new hook types: cgi, render, delete - wrapper files fixed to support config strings with newlines in them - HEADERCONTENT in page template useful for plugins. Probably needs to be expanded to more such for other places plugins might want to add content. - remove unnecessary wrappers field from config info stored in wrappers 2006-05-03 23:50:39 +02:00
Pass a destpage parameter to the sanitize hook. Because the search plugin needed it, also because it's one of the few plugins that didn't already have it. I also considered adding it to htmlize, but I really cannot imagine caring what the destpage is when htmlizing. (I'll probably be poven wrong later.) 2008-06-04 07:24:23 +02:00			`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.`
estseek patch (slightly altered) and other replies 2006-09-18 22:53:17 +02:00
search: Converted to use xapian-omega. Everything is done except for the actual indexing. I plan to do incremental indexing as pages change. 2008-06-03 21:29:54 +02:00			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`.