aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:29:07 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:29:07 -0400
commit5e4767a594f238327a4c74f1aecc69779a237eab (patch)
treef9d0f4383ddbb7d3e0064d20e3a68e38e3e0ab74 /doc
parenteb92d09360e871f4af059c30e70cf7f0b24315e2 (diff)
downloadikiwiki-5e4767a594f238327a4c74f1aecc69779a237eab.tar
ikiwiki-5e4767a594f238327a4c74f1aecc69779a237eab.tar.gz
misc minor changes
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki/directive.mdwn2
-rw-r--r--doc/plugins/color.mdwn2
-rw-r--r--doc/plugins/conditional.mdwn2
-rw-r--r--doc/plugins/cutpaste.mdwn7
-rw-r--r--doc/plugins/edittemplate.mdwn2
-rw-r--r--doc/plugins/haiku.mdwn6
-rw-r--r--doc/plugins/img.mdwn10
-rw-r--r--doc/plugins/inline.mdwn4
-rw-r--r--doc/plugins/listdirectives.mdwn2
-rw-r--r--doc/plugins/meta.mdwn4
-rw-r--r--doc/plugins/more.mdwn6
-rw-r--r--doc/plugins/pagestats.mdwn5
-rw-r--r--doc/plugins/pagetemplate.mdwn6
-rw-r--r--doc/plugins/pinger.mdwn3
-rw-r--r--doc/plugins/poll.mdwn4
-rw-r--r--doc/plugins/postsparkline.mdwn2
-rw-r--r--doc/plugins/progress.mdwn4
-rw-r--r--doc/plugins/shortcut.mdwn2
-rw-r--r--doc/plugins/sparkline.mdwn9
-rw-r--r--doc/plugins/table.mdwn4
-rw-r--r--doc/plugins/tag.mdwn10
-rw-r--r--doc/plugins/template.mdwn2
-rw-r--r--doc/plugins/testpagespec.mdwn2
-rw-r--r--doc/plugins/teximg.mdwn7
-rw-r--r--doc/plugins/toc.mdwn4
-rw-r--r--doc/plugins/toggle.mdwn4
-rw-r--r--doc/plugins/version.mdwn5
27 files changed, 62 insertions, 58 deletions
diff --git a/doc/ikiwiki/directive.mdwn b/doc/ikiwiki/directive.mdwn
index 93549cb1a..775adaa0f 100644
--- a/doc/ikiwiki/directive.mdwn
+++ b/doc/ikiwiki/directive.mdwn
@@ -41,5 +41,5 @@ defaults to off, so ikiwiki supports the old syntax.
[[!if test="enabled(listdirectives)" then="""
Here is a list of available directives:
-[[!listdirectives]]
+[[!listdirectives ]]
"""]]
diff --git a/doc/plugins/color.mdwn b/doc/plugins/color.mdwn
index 6e516096c..dbb8b870c 100644
--- a/doc/plugins/color.mdwn
+++ b/doc/plugins/color.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=color core=0 author="[[ptecza]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/color]] [[ikiwiki/directive]].
+This plugin provides a [[ikiwiki/directive/color]] [[ikiwiki/directive]].
The directive can be used to color a piece of text on a page.
diff --git a/doc/plugins/conditional.mdwn b/doc/plugins/conditional.mdwn
index c93bbda41..95ffb2764 100644
--- a/doc/plugins/conditional.mdwn
+++ b/doc/plugins/conditional.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=conditional core=1 author="[[Joey]]"]]
[[!tag type/format]]
-This plugin implements the [[ikiwiki/directive/if]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/if]] [[ikiwiki/directive]].
With this directive, you can make text be conditionally displayed on a page.
diff --git a/doc/plugins/cutpaste.mdwn b/doc/plugins/cutpaste.mdwn
index 90c5ccfb9..1b78e60fc 100644
--- a/doc/plugins/cutpaste.mdwn
+++ b/doc/plugins/cutpaste.mdwn
@@ -1,6 +1,7 @@
[[!template id=plugin name=toggle author="[[Enrico]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/cut]],
-[[ikiwiki/directive/copy]] and [[ikiwiki/directive/paste]] [[ikiwiki/directive]]s.
-With these directives you can store and recall pieces of text.
+This plugin provides the [[ikiwiki/directive/cut]],
+[[ikiwiki/directive/copy]] and [[ikiwiki/directive/paste]]
+[[directives|ikiwiki/directive]].
+With these directives you can store and recall pieces of text in a page.
diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn
index 646fc9af7..51101a7bd 100644
--- a/doc/plugins/edittemplate.mdwn
+++ b/doc/plugins/edittemplate.mdwn
@@ -1,6 +1,6 @@
[[!template id=plugin name=edittemplate author="[[Joey]]"]]
[[!tag type/useful]]
-This plugin implements the [[ikiwiki/directive/edittemplate]] [[ikiwiki/directive]].
+This plugin provides a [[ikiwiki/directive/edittemplate]] [[ikiwiki/directive]].
This directive allows registering template pages, that provide default
content for new pages created using the web frontend.
diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn
index f01e2f0f3..74eac1c29 100644
--- a/doc/plugins/haiku.mdwn
+++ b/doc/plugins/haiku.mdwn
@@ -1,11 +1,11 @@
[[!template id=plugin name=haiku author="[[Joey]]"]]
[[!tag type/fun]]
-This plugin implements the [[ikiwiki/directive/haiku]] [[ikiwiki/directive]].
+This plugin provides a [[ikiwiki/directive/haiku]] [[ikiwiki/directive]].
The directive allows inserting a randomly generated haiku into a wiki page.
As a special bonus, enabling this plugin makes any error messages ikiwiki
should display be written in haiku.
-You need to have the Coy module installed for this plugin to do anything
-interesting. That does all the heavy lifting.
+You need to have the [[!cpan Coy]] module installed for this plugin to do
+anything interesting. That does all the heavy lifting.
diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn
index 04077d065..114438765 100644
--- a/doc/plugins/img.mdwn
+++ b/doc/plugins/img.mdwn
@@ -1,11 +1,11 @@
[[!template id=plugin name=img author="Christian Mock"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/img]] [[ikiwiki/directive]].
-This is an image handling directive. While ikiwiki supports inlining full-size
-images by making a [[ikiwiki/WikiLink]] that points to the image, using
-this plugin you can easily scale down an image for inclusion onto a page,
-providing a link to a full-size version.
+This plugin provides the [[ikiwiki/directive/img]] [[ikiwiki/directive]].
+While ikiwiki supports inlining full-size images by making a
+[[ikiwiki/WikiLink]] that points to the image, using this directive you can
+easily scale down an image for inclusion onto a page, providing a link to a
+full-size version.
This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via
[PerlMagick](http://www.imagemagick.org/www/perl-magick.html).
diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn
index e4587117e..6c3282576 100644
--- a/doc/plugins/inline.mdwn
+++ b/doc/plugins/inline.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=inline core=1 author="[[Joey]]"]]
-This plugin implements the [[ikiwiki/directive/inline]] [[ikiwiki/directive]].
-This is a [[ikiwiki/directive]] that allows including one wiki page
+This plugin provides the [[ikiwiki/directive/inline]]
+[[ikiwiki/directive]], which allows including one wiki page
inside another.
diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn
index 761138917..2f6691345 100644
--- a/doc/plugins/listdirectives.mdwn
+++ b/doc/plugins/listdirectives.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=listdirectives author="Will"]]
[[!tag type/meta]]
-This plugin implements the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]].
The linkmap directive inserts a list of currently available directives into the page.
Each directive links to a wiki page with the same name. The location of the
diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn
index a4f708ee3..afd554993 100644
--- a/doc/plugins/meta.mdwn
+++ b/doc/plugins/meta.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=meta author="[[Joey]]"]]
[[!tag type/meta]]
-This plugin implements the [[ikiwiki/directive/meta]] [[ikiwiki/directive]].
-The directive allows inserting arbitrary metadata into the source of a page.
+This plugin provides the [[ikiwiki/directive/meta]] [[ikiwiki/directive]],
+which allows inserting various metadata into the source of a page.
diff --git a/doc/plugins/more.mdwn b/doc/plugins/more.mdwn
index 252fed534..e9a971289 100644
--- a/doc/plugins/more.mdwn
+++ b/doc/plugins/more.mdwn
@@ -1,6 +1,6 @@
[[!template id=plugin name=more author="Ben"]]
[[!tag type/format]]
-This plugin implements the [[ikiwiki/directive/more]] [[ikiwiki/directive]].
-The directive provides a way to have a "more" link on a page in a blog, that
-leads to the full version of the page.
+This plugin provides the [[ikiwiki/directive/more]] [[ikiwiki/directive]],
+which is a way to have a "more" link on a post in a blog, that leads to the
+full version of the page.
diff --git a/doc/plugins/pagestats.mdwn b/doc/plugins/pagestats.mdwn
index 3b7bc0255..c3eba6363 100644
--- a/doc/plugins/pagestats.mdwn
+++ b/doc/plugins/pagestats.mdwn
@@ -1,5 +1,6 @@
[[!template id=plugin name=pagestats author="Enrico Zini"]]
[[!tag type/meta type/tags]]
-This plugin implements the [[ikiwiki/directive/pagestats]] [[ikiwiki/directive]].
-The directive can generate stats about how pages link to each other.
+This plugin provides the [[ikiwiki/directive/pagestats]]
+[[ikiwiki/directive]], which can generate stats about how pages link to
+each other, or display a tag cloud.
diff --git a/doc/plugins/pagetemplate.mdwn b/doc/plugins/pagetemplate.mdwn
index b81f0a4d7..afd5eb500 100644
--- a/doc/plugins/pagetemplate.mdwn
+++ b/doc/plugins/pagetemplate.mdwn
@@ -1,10 +1,10 @@
[[!template id=plugin name=pagetemplate author="[[Joey]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/pagetemplate]] [[ikiwiki/directive]].
-The directive allows a page to be created using a different
+This plugin provides the [[ikiwiki/directive/pagetemplate]]
+[[ikiwiki/directive]], which allows a page to be created using a different
[[template|wikitemplates]].
This plugin can only use templates that are already installed in
-/usr/share/ikiwiki/templates (or wherever ikiwiki is configured to look for
+`/usr/share/ikiwiki/templates` (or wherever ikiwiki is configured to look for
them). You can choose to use any .tmpl files in that directory.
diff --git a/doc/plugins/pinger.mdwn b/doc/plugins/pinger.mdwn
index f9b8e7bcb..00d83e1bb 100644
--- a/doc/plugins/pinger.mdwn
+++ b/doc/plugins/pinger.mdwn
@@ -7,7 +7,8 @@ plugin to set up a loosely coupled mirror network, or a branched version of
a wiki. By pinging the mirror or branch each time the main wiki changes, it
can be kept up-to-date.
-See the [[ikiwiki/directive/ping]] [[ikiwiki/directive]] page for usage details.
+To configure what URLs to ping, use the [[ikiwiki/directive/ping]]
+[[ikiwiki/directive]].
The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan
LWPx::ParanoidAgent]] perl module is used if available, for added security.
diff --git a/doc/plugins/poll.mdwn b/doc/plugins/poll.mdwn
index db9737f10..160fd2ffa 100644
--- a/doc/plugins/poll.mdwn
+++ b/doc/plugins/poll.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=poll author="[[Joey]]"]]
[[!tag type/useful]]
-This plugin implements the [[ikiwiki/directive/poll]] [[ikiwiki/directive]].
-The directive allows you to create online polls in the wiki.
+This plugin provides the [[ikiwiki/directive/poll]] [[ikiwiki/directive]],
+which allows inserting an online poll into a page.
diff --git a/doc/plugins/postsparkline.mdwn b/doc/plugins/postsparkline.mdwn
index b94a310bf..c81f91bdc 100644
--- a/doc/plugins/postsparkline.mdwn
+++ b/doc/plugins/postsparkline.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=postsparkline author="[[Joey]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/postsparkline]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/postsparkline]] [[ikiwiki/directive]].
It uses the [[sparkline]] plugin to create a sparkline of
statistics about a set of pages, such as posts to a blog.
diff --git a/doc/plugins/progress.mdwn b/doc/plugins/progress.mdwn
index af48e569c..e1b560cc8 100644
--- a/doc/plugins/progress.mdwn
+++ b/doc/plugins/progress.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=progress author="[[Will]]"]]
[[!tag type/meta]]
-This plugin implements the [[ikiwiki/directive/progress]] [[ikiwiki/directive]].
-The directive that displays a progress bar.
+This plugin provides the [[ikiwiki/directive/progress]]
+[[ikiwiki/directive]], which generates a progress bar.
diff --git a/doc/plugins/shortcut.mdwn b/doc/plugins/shortcut.mdwn
index 095c4785f..cca1f4bdd 100644
--- a/doc/plugins/shortcut.mdwn
+++ b/doc/plugins/shortcut.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=shortcut author="[[Joey]]"]]
[[!tag type/format]]
-This plugin implements the [[ikiwiki/directive/shortcut]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/shortcut]] [[ikiwiki/directive]].
It allows external links to commonly linked to sites to be made
more easily using shortcuts.
diff --git a/doc/plugins/sparkline.mdwn b/doc/plugins/sparkline.mdwn
index 5f5d08b5e..bcc5daec6 100644
--- a/doc/plugins/sparkline.mdwn
+++ b/doc/plugins/sparkline.mdwn
@@ -1,8 +1,10 @@
[[!template id=plugin name=sparkline author="[[Joey]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/sparkline]] [[ikiwiki/directive]].
-The directive allows for easily embedding sparklines into wiki pages.
+This plugin provides the [[ikiwiki/directive/sparkline]]
+[[ikiwiki/directive]], which allows for easily embedding sparklines into
+wiki pages. A sparkline is a small word-size graphic chart, that is designed
+to be displayed alongside text.
# requirements
@@ -18,6 +20,3 @@ to use the plugin, you will need:
On a Debian system, this can be accomplished by installing these packages:
`libsparkline-php` `php5-gd` `php5-cli` `libdigest-sha1-perl`
-
-This plugin also uses the [[!cpan Digest::SHA1]] perl module.
-
diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn
index ec6e34f55..7b080acda 100644
--- a/doc/plugins/table.mdwn
+++ b/doc/plugins/table.mdwn
@@ -1,8 +1,8 @@
[[!template id=plugin name=table author="[[VictorMoral]]"]]
[[!tag type/format]]
-This plugin implements the [[ikiwiki/directive/table]] [[ikiwiki/directive]].
-The directive can build HTML tables from data in CSV (comma-separated values)
+This plugin provides the [[ikiwiki/directive/table]] [[ikiwiki/directive]].
+It can build HTML tables from data in CSV (comma-separated values)
or DSV (delimiter-separated values) format.
It needs the perl module [[!cpan Text::CSV]] for the CSV data.
diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index b2288ddc9..17bb086a1 100644
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -5,9 +5,7 @@ This plugin provides the [[ikiwiki/directive/tag]] and
[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]].
These directives allow tagging pages.
-This plugin has a configuration option. Set --tagbase=tags and links to tags
-will be located under the specified base page. If ikiwiki is configured
-this way, then the example above actually tags the page with the tags
-tags/tech, tags/life, and tags/linux. This is a useful way to avoid
-having to write the full path to tags, if you want to keep them grouped
-together out of the way.
+[[!if test="enabled(tag)" then="""
+This wiki has the tag plugin enabled, so you'll see a note below that this
+page is tagged with the "tags" tag.
+"""]]
diff --git a/doc/plugins/template.mdwn b/doc/plugins/template.mdwn
index 9bdef91bf..3485fe64c 100644
--- a/doc/plugins/template.mdwn
+++ b/doc/plugins/template.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=template author="[[Joey]]"]]
[[!tag type/format]]
-This plugin implements the [[ikiwiki/directive/template]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/template]] [[ikiwiki/directive]].
With this plugin, you can set up templates, and cause them to be filled out
and inserted into pages in the wiki. It's documented and existing templates
are listed in the [[templates]] page.
diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn
index cd777fa1c..dabcb0bec 100644
--- a/doc/plugins/testpagespec.mdwn
+++ b/doc/plugins/testpagespec.mdwn
@@ -1,6 +1,6 @@
[[!template id=plugin name=testpagespec author="[[Joey]]"]]
[[!tag type/useful]]
-This plugin implements the [[ikiwiki/directive/testpagespec]] [[ikiwiki/directive]].
+This plugin provides a [[ikiwiki/directive/testpagespec]] [[ikiwiki/directive]].
The directive allows testing a [[ikiwiki/PageSpec]] to see if it matches a
page, and to see the part that matches, or causes the match to fail.
diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn
index cf9fb5c6d..ae052837f 100644
--- a/doc/plugins/teximg.mdwn
+++ b/doc/plugins/teximg.mdwn
@@ -1,11 +1,14 @@
[[!template id=plugin name=teximg author="[[PatrickWinnertz]]"]]
[[!tag type/chrome type/slow]]
-This plugin implements the [[ikiwiki/directive/teximg]] [[ikiwiki/directive]].
-The directive renders LaTeX formulas into images.
+This plugin provides a [[ikiwiki/directive/teximg]] [[ikiwiki/directive]],
+that renders LaTeX formulas into images.
Of course you will need LaTeX installed for this to work.
+See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered
+images.
+
## configuration
There are several configuration directives that can be used in the setup
diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn
index 7e265fcec..2b7686681 100644
--- a/doc/plugins/toc.mdwn
+++ b/doc/plugins/toc.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=toc author="[[Joey]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/toc]] [[ikiwiki/directive]].
-The directive adds table of contents to a page.
+This plugin provides the [[ikiwiki/directive/toc]] [[ikiwiki/directive]],
+which adds a table of contents to a page.
diff --git a/doc/plugins/toggle.mdwn b/doc/plugins/toggle.mdwn
index 3dbdbac73..69ac613e0 100644
--- a/doc/plugins/toggle.mdwn
+++ b/doc/plugins/toggle.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=toggle author="[[Joey]]"]]
[[!tag type/chrome]]
-This plugin implements the [[ikiwiki/directive/toggle]] and
-[[ikiwiki/directive/toggleable]] [[ikiwiki/directive]]s.
+This plugin provides the [[ikiwiki/directive/toggle]] and
+[[ikiwiki/directive/toggleable]] [[directives|ikiwiki/directive]].
With these directives you can create links on pages that, when clicked, toggle
display of other parts of the page.
diff --git a/doc/plugins/version.mdwn b/doc/plugins/version.mdwn
index 67c2a4e40..257f8f303 100644
--- a/doc/plugins/version.mdwn
+++ b/doc/plugins/version.mdwn
@@ -1,5 +1,6 @@
[[!template id=plugin name=version author="[[Joey]]"]]
[[!tag type/useful]]
-This plugin implements the [[ikiwiki/directive/version]] [[ikiwiki/directive]].
-It inserts the version of ikiwiki into a page.
+This plugin provides the [[ikiwiki/directive/version]]
+[[ikiwiki/directive]], which inserts the current version
+of ikiwiki into a page.