[[!if test="enabled(listdirectives)" then="""
Here is a list of available directives:
-[[!listdirectives]]
+[[!listdirectives ]]
"""]]
[[!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.
[[!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.
[[!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.
[[!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.
[[!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.
[[!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).
[[!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.
[[!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
[[!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.
[[!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.
[[!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.
[[!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.
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.
[[!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.
[[!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.
[[!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.
[[!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.
[[!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
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.
-
[[!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.
[[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.
+"""]]
[[!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.
[[!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.
[[!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
[[!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.
[[!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.
[[!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.
-The `copy`, `cut` and `paste` directives are supplied by the [[!iki plugins/cutpaste]] plugin.
+The `copy`, `cut` and `paste` directives are supplied by the
+[[!iki plugins/cutpaste]] plugin.
-With these directives you can store and recall pieces of text:
+With these directives you can store and recall pieces of text in a page:
* `\[[!cut id=name text="text"]]` memorizes the text allowing to recall it
using the given ID. The text being cut is not included in the output.
them.
Since you can paste without using double quotes, copy and paste can be used to
-nest directive that require multiline parameters inside each other:
+nest directives that require multiline parameters inside each other:
\[[!toggleable id=foo text="""
\[[!toggleable id=bar text="\[[!paste id=baz]]"]]
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,
+this directive you can easily scale down an image for inclusion onto a page,
providing a link to a full-size version.
## usage
original image's aspect ratio is always preserved, even if this means
making the image smaller than the specified size. You can also specify only
the width or the height, and the other value will be calculated based on
-it: "200x", "x200".
+it: "200x", "x200"
You can also pass `alt`, `title`, `class` and `id` parameters. These are
passed through unchanged to the html img tag. If you include a `caption`
\[[!listdirectives]]
-There is one optional keyword argument, `generated`. Normally the `listdirectives` directive will
-list all built in directives and directives directly registered by plugins. With this keyword,
-`listdirectives` will also list directives generated later. For example, all [[shortcuts]] are
-directives generated in turn by the `shortcut` directive. They will only be listed if the `generated` argument is
-supplied.
+There is one optional keyword argument, `generated`. Normally the
+`listdirectives` directive will list all built in directives and directives
+directly registered by plugins. With this keyword, `listdirectives` will
+also list directives generated later. For example, all [[shortcuts]] are
+directives generated in turn by the `shortcut` directive. They will only
+be listed if the `generated` argument is supplied.
\[[!listdirectives generated]]
-This extended list is often quite long, and often contains many undocumented directives.
+This extended list is often quite long, and often contains many
+undocumented directives.
\[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
- However, this latter syntax won't be allowed if the [[!iki plugins/htmlscrubber]]
- plugin is enabled, since it can be used to insert unsafe content.
+ However, this latter syntax won't be allowed if the
+ [[!iki plugins/htmlscrubber]] plugin is enabled, since it can be used to
+ insert unsafe content.
* redir
\[[!meta redir="http://example.com/"]]
- However, this latter syntax won't be allowed if the [[!iki plugins/htmlscrubber]]
- plugin is enabled, since it can be used to insert unsafe content.
+ However, this latter syntax won't be allowed if the
+ [[!iki plugins/htmlscrubber]] plugin is enabled, since it can be used to
+ insert unsafe content.
For both cases, an anchor to jump to inside the destination page may also be
- specified using the common `PAGE#ANCHOR` syntax.
+ specified using the common `#ANCHOR` syntax.
* robots
The `more` directive is supplied by the [[!iki plugins/more]] plugin.
-This directive provides a way to have a "more" link on a page in a blog, that
+This directive provides a way to have a "more" link on a post in a blog, that
leads to the full version of the page. Use it like this:
\[[!more linktext="click for more" text="""
The `pagestats` directive is supplied by the [[!iki plugins/pagestats]] plugin.
This directive can generate stats about how pages link to each other. It can
-produce either a del.icio.us style cloud, or a table counting the number of
-links to each page.
+produce either a tag cloud, or a table counting the number of links to each
+page.
Here's how to use it to create a [[tag]] cloud:
The `pagetemplate` directive is supplied by the [[!iki plugins/pagetemplate]] plugin.
-This directive allows a page to be created using a different
-wikitemplates. The page text is inserted into the template, so
-the template controls the overall look and feel of the wiki page. This is
-in contrast to the [[ikiwiki/directive/template]] directive, which allows inserting templates
+This directive allows a page to be created using a different wikitemplates.
+The page text is inserted into the template, so the template controls the
+overall look and feel of the wiki page. This is in contrast to the
+[[ikiwiki/directive/template]] directive, which allows inserting templates
_into_ the body of a page.
This directive can only reference templates that are already installed
-by the system administrator. Example:
+by the system administrator, typically into the
+`/usr/share/ikiwiki/templates` directory. Example:
- \[[!pagetemplate template=my_fancy.tmpl]]
+ \[[!pagetemplate template="my_fancy.tmpl"]]
The `postsparkline` directive is supplied by the [[!iki plugins/postsparkline]] plugin.
-This plugin uses the [[!iki plugins/sparkline]] plugin to create a [[sparkline]] of
-statistics about a set of pages, such as posts to a blog.
+This directive uses the [[!iki plugins/sparkline]] plugin to create a
+[[sparkline]] of statistics about a set of pages, such as posts to a blog.
# examples
# usage
All options aside fron the `pages`, `max`, `formula`, `time`, and `color`
-options are passed on to the sparkline plugin.
+options are the same as in [[sparkline]] directive.
You don't need to specify any data points (though you can if you want to).
Instead, data points are automatically generated based on the creation
pages in each pagespec and shows the percentage of the total pages that are
done.
-This plugin is included in ikiwiki, but is not enabled by default.
+For example, to show what percentage of pages have
+discussion pages:
-If it is turned on it can show what percentage of pages have discussion pages:
-
-[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]
+ \[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]
The `shortcut` directive is supplied by the [[!iki plugins/shortcut]] plugin.
-This plugin allows external links to commonly linked to sites to be made
+This directive allows external links to commonly linked to sites to be made
more easily using shortcuts.
The available shortcuts are defined on the [[shortcuts]] page in
-the wiki.
+the wiki. The `shortcut` directive can only be used on that page.
To add an alt text to the image, use alt="text":
\[[!teximg code="\frac{1}{2}" alt="1/2"]]
-
-See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images.
projects / ikiwiki.git / commitdiff