From 3215b5a9821d69a2216c2cdf2b64cd3eb27f7370 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Wed, 4 Jun 2008 15:24:05 -0400 Subject: finishing touches on the new search plugin - Add a Help link. - If the pageterm is too long, hash it. --- doc/ikiwiki.mdwn | 1 + doc/ikiwiki/searching.mdwn | 2 +- doc/plugins/search.mdwn | 8 +++++--- 3 files changed, 7 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/ikiwiki.mdwn b/doc/ikiwiki.mdwn index 485ac8826..c98a97e59 100644 --- a/doc/ikiwiki.mdwn +++ b/doc/ikiwiki.mdwn @@ -14,3 +14,4 @@ Some documentation on using ikiwiki: * [[ikiwiki/markdown]] * [[ikiwiki/subpage]] * [[ikiwiki/openid]] +* [[ikiwiki/searching]] diff --git a/doc/ikiwiki/searching.mdwn b/doc/ikiwiki/searching.mdwn index 0eeb5a6b9..539e7193d 100644 --- a/doc/ikiwiki/searching.mdwn +++ b/doc/ikiwiki/searching.mdwn @@ -5,7 +5,7 @@ then="This wiki has searching **enabled**." else="This wiki has searching **disabled**."]] If searching is enabled, you can enter search terms in the search field, -like you'd expect. There are a few special things you can do to constuct +as you'd expect. There are a few special things you can do to constuct more powerful searches. * To match a phrase, enclose it in double quotes. diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index e53c28c7c..9336b2403 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -3,9 +3,11 @@ 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::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 -- cgit v1.2.3