summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-03 21:50:39 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-03 21:50:39 +0000
commitaf9566ff1ae55d273ff96c7ca39e34265623a55d (patch)
treebe91c4464b174b72efbd6453068e8f7308c49e02 /doc
parentb0952742b29373bd762cf13c258cfd4559a680ad (diff)
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
Diffstat (limited to 'doc')
-rw-r--r--doc/hyperestraier.mdwn6
-rw-r--r--doc/ikiwiki.setup4
-rw-r--r--doc/plugins/search.mdwn5
-rw-r--r--doc/usage.mdwn5
4 files changed, 9 insertions, 11 deletions
diff --git a/doc/hyperestraier.mdwn b/doc/hyperestraier.mdwn
index e208ee631..e1246436a 100644
--- a/doc/hyperestraier.mdwn
+++ b/doc/hyperestraier.mdwn
@@ -1,3 +1,3 @@
-[Hyper Estraier](http://hyperestraier.sourceforge.net/) is a full text search engine. Ikiwiki can be configured to use it as the search engine for the wiki (see [[usage]]). This makes ikiwiki call Hyper Ertaier to update its index of pages each time a change is made to the wiki.
-
-It's possible to configure Hyper Estraier via one of ikiwiki's [[templates]]. \ No newline at end of file
+[Hyper Estraier](http://hyperestraier.sourceforge.net/) is a full text
+search engine. Ikiwiki can be configured to use it as the search engine for
+the wiki, using the [[search_plugin|plugins/search]].
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index d6ca7bb0b..3bc15891e 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -48,10 +48,8 @@ use IkiWiki::Setup::Standard {
#anonok => 1,
# Generate rss feeds for pages?
rss => 1,
- # Use the Hyper Estraier search engine?
- #hyperestraier => 1,
# Sanitize html?
sanitize => 1,
# To change the enabled plugins, edit this list
- #plugin => [qw{pagecount inline brokenlinks}],
+ #plugin => [qw{pagecount inline brokenlinks hyperestraier}],
}
diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn
new file mode 100644
index 000000000..afeb0d4aa
--- /dev/null
+++ b/doc/plugins/search.mdwn
@@ -0,0 +1,5 @@
+This plugin is included in ikiwiki, but is not enabled by default. It adds
+full text search to ikiwiki, using the [[HyperEstraier]] engine.
+
+It's possible to configure Hyper Estraier via one of ikiwiki's
+[[templates]].
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index c30d799fd..eac72cdc7 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -172,11 +172,6 @@ These options configure the wiki.
Enables the use of the specified plugin in the wiki. See [[plugins]] for
details. Note that plugin names are case sensative.
-* --hyperestraier
-
- Enables use of the [[HyperEstraier]] search engine for full test page
- searches.
-
* --verbose
Be vebose about what is being done.