diff options
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/search.mdwn | 20 | ||||
| -rw-r--r-- | doc/plugins/search/discussion.mdwn | 2 |
2 files changed, 15 insertions, 7 deletions
diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index 7b32714f4..67e3b85ef 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -1,12 +1,18 @@ [[template id=plugin name=search author="[[Joey]]"]] [[tag type/useful]] -This plugin is included in ikiwiki, but is not enabled by default. It adds -full text search to ikiwiki, using the [[HyperEstraier]] engine. +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.) -It's possible to configure HyperEstraier via one of ikiwiki's -[[templates|wikitemplates]], but for most users, no configuration should be -needed aside from enabling the plugin. +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. -This plugin has a configuration option. To change the path to estseek.cgi, -set `--estseek=/path/to/estseek.cgi` +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`. diff --git a/doc/plugins/search/discussion.mdwn b/doc/plugins/search/discussion.mdwn index 494d0a38a..6b5714c42 100644 --- a/doc/plugins/search/discussion.mdwn +++ b/doc/plugins/search/discussion.mdwn @@ -42,3 +42,5 @@ Now I did a `rm -rf ~wiki/wiki/.ikiwiki/hyperestraier` and re-ran `--rebuild`ing once more, I'm back to the previous error message. --[[tschwinge]] + +I guess this is fixed now that it uses xapian. :-) --[[Joey]] |