-The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin.
+The `aggregate` directive is supplied by the [[!iki plugins/aggregate desc=aggregate]] plugin.
This plugin requires extra setup, specifically, a cron job. See the
plugin's documentation for details.
-The `brokenlinks` directive is supplied by the [[!iki plugins/brokenlinks]] plugin.
+The `brokenlinks` directive is supplied by the [[!iki plugins/brokenlinks desc=brokenlinks]] plugin.
This directive generates a list of broken links on pages in the wiki. This is
a useful way to find pages that still need to be written, or links that
-The `calendar` directive is supplied by the [[!iki plugins/calendar]] plugin.
+The `calendar` directive is supplied by the [[!iki plugins/calendar desc=calendar]] plugin.
This plugin requires extra setup. See the plugin documentation for details.
This directive displays a calendar, similar to the typical calendars shown on
-The `color` directive is supplied by the [[!iki plugins/color]] plugin.
+The `color` directive is supplied by the [[!iki plugins/color desc=color]] plugin.
This directive can be used to color a piece of text on a page.
It can be used to set the foreground and/or background color of the text.
The `copy`, `cut` and `paste` directives are supplied by the
-[[!iki plugins/cutpaste]] plugin.
+[[!iki plugins/cutpaste desc=cutpaste]] plugin.
With these directives you can store and recall pieces of text in a page:
-The `edittemplate` directive is supplied by the [[!iki plugins/edittemplate]] plugin.
+The `edittemplate` directive is supplied by the [[!iki plugins/edittemplate desc=edittemplate]] plugin.
This directive allows registering template pages, that provide default
content for new pages created using the web frontend. To register a
-The `fortune` directive is supplied by the [[!iki plugins/fortune]] plugin.
+The `fortune` directive is supplied by the [[!iki plugins/fortune desc=fortune]] plugin.
This just uses the `fortune` program to insert a fortune cookie into the page.
Usage:
-The `graph` directive is supplied by the [[!iki plugins/graphviz]] plugin.
+The `graph` directive is supplied by the [[!iki plugins/graphviz desc=graphviz]] plugin.
This directive allows embedding [graphviz](http://www.graphviz.org/) graphs in a
page. Example usage:
-The `haiku` directive is supplied by the [[!iki plugins/haiku]] plugin.
+The `haiku` directive is supplied by the [[!iki plugins/haiku desc=haiku]] plugin.
This directive allows inserting a randomly generated haiku into a wiki page.
Just type:
-The `if` directive is supplied by the [[!iki plugins/conditional]] plugin.
+The `if` directive is supplied by the [[!iki plugins/conditional desc=conditional]] plugin.
With this directive, you can make text be conditionally displayed on a page.
For example:
-The `img` directive is supplied by the [[!iki plugins/img]] plugin.
+The `img` directive is supplied by the [[!iki plugins/img desc=img]] plugin.
This is an image handling directive. While ikiwiki supports inlining full-size
images by making a [[ikiwiki/WikiLink]] that points to the image, using
-The `inline` directive is supplied by the [[!iki plugins/inline]] plugin.
+The `inline` directive is supplied by the [[!iki plugins/inline desc=inline]] plugin.
This is a [[ikiwiki/directive]] that allows including one wiki page
inside another. For example:
-The `linkmap` directive is supplied by the [[!iki plugins/linkmap]] plugin.
+The `linkmap` directive is supplied by the [[!iki plugins/linkmap desc=linkmap]] plugin.
This directive uses [graphviz](http://www.graphviz.org/) to generate a
graph showing the links between a set of pages in the wiki. Example usage:
-The `listdirectives` directive is supplied by the [[!iki plugins/listdirectives]] plugin.
+The `listdirectives` directive is supplied by the [[!iki plugins/listdirectives desc=listdirectives]] plugin.
This directive generates a list of available
[[directives|ikiwiki/directive]].
-The `map` directive is supplied by the [[!iki plugins/map]] plugin.
+The `map` directive is supplied by the [[!iki plugins/map desc=map]] plugin.
This directive generates a hierarchical page map for the wiki. Example usage:
-The `meta` directive is supplied by the [[!iki plugins/meta]] plugin.
+The `meta` directive is supplied by the [[!iki plugins/meta desc=meta]] plugin.
This directive allows inserting arbitrary metadata into the source of a page.
Enter the metadata as follows:
\[[!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
+ [[!iki plugins/htmlscrubber desc=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
+ [[!iki plugins/htmlscrubber desc=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
If the field is not one of the above predefined fields, the metadata will be
written to the generated html page as a <meta> header. However, this
-won't be allowed if the [[!iki plugins/htmlscrubber]] plugin is enabled,
+won't be allowed if the [[!iki plugins/htmlscrubber desc=htmlscrubber]] plugin is enabled,
since it can be used to insert unsafe content.
[[!meta robots="noindex, follow"]]
-The `more` directive is supplied by the [[!iki plugins/more]] plugin.
+The `more` directive is supplied by the [[!iki plugins/more desc=more]] plugin.
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:
-The `orphans` directive is supplied by the [[!iki plugins/orphans]] plugin.
+The `orphans` directive is supplied by the [[!iki plugins/orphans desc=orphans]] plugin.
This directive generates a list of possibly orphaned pages -- pages that no
other page links to. Example:
-The `pagecount` directive is supplied by the [[!iki plugins/pagecount]] plugin.
+The `pagecount` directive is supplied by the [[!iki plugins/pagecount desc=pagecount]] plugin.
This directive counts pages currently in the wiki. Example:
-The `pagestats` directive is supplied by the [[!iki plugins/pagestats]] plugin.
+The `pagestats` directive is supplied by the [[!iki plugins/pagestats desc=pagestats]] plugin.
This directive can generate stats about how pages link to each other. It can
produce either a tag cloud, or a table counting the number of links to each
-The `pagetemplate` directive is supplied by the [[!iki plugins/pagetemplate]] plugin.
+The `pagetemplate` directive is supplied by the [[!iki plugins/pagetemplate desc=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
-The `ping` directive is supplied by the [[!iki plugins/pinger]] plugin.
+The `ping` directive is supplied by the [[!iki plugins/pinger desc=pinger]] plugin.
This directive allows ikiwiki to be configured to hit a URL each time it
-updates the wiki. One way to use this is in conjunction with the [[!iki plugins/pingee]]
+updates the wiki. One way to use this is in conjunction with the [[!iki plugins/pingee desc=pingee]]
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.
-The `poll` directive is supplied by the [[!iki plugins/poll]] plugin.
+The `poll` directive is supplied by the [[!iki plugins/poll desc=poll]] plugin.
This directive allows you to create online polls in the wiki. Here's an
example use:
-The `polygen` directive is supplied by the [[!iki plugins/polygen]] plugin.
+The `polygen` directive is supplied by the [[!iki plugins/polygen desc=polygen]] plugin.
This directive allows inserting text generated by polygen into a wiki page.
For example:
-The `postsparkline` directive is supplied by the [[!iki plugins/postsparkline]] plugin.
+The `postsparkline` directive is supplied by the [[!iki plugins/postsparkline desc=postsparkline]] plugin.
-This directive uses the [[!iki plugins/sparkline]] plugin to create a
+This directive uses the [[!iki plugins/sparkline desc=sparkline]] plugin to create a
[[sparkline]] of statistics about a set of pages, such as posts to a blog.
# examples
-The `progress` directive is supplied by the [[!iki plugins/progress]] plugin.
+The `progress` directive is supplied by the [[!iki plugins/progress desc=progress]] plugin.
This directive generates a progress bar.
-The `shortcut` directive is supplied by the [[!iki plugins/shortcut]] plugin.
+The `shortcut` directive is supplied by the [[!iki plugins/shortcut desc=shortcut]] plugin.
This directive allows external links to commonly linked to sites to be made
more easily using shortcuts.
-The `sparkline` directive is supplied by the [[!iki plugins/sparkline]] plugin.
+The `sparkline` directive is supplied by the [[!iki plugins/sparkline desc=sparkline]] plugin.
This directive allows for embedding sparklines into wiki pages. A
sparkline is a small word-size graphic chart, that is designed to be
-The `table` directive is supplied by the [[!iki plugins/table]] plugin.
+The `table` directive is supplied by the [[!iki plugins/table desc=table]] plugin.
This directive can build HTML tables from data in CSV (comma-separated values)
or DSV (delimiter-separated values) format.
-The `tag` and `taglink` directives are supplied by the [[!iki plugins/tag]] plugin.
+The `tag` and `taglink` directives are supplied by the [[!iki plugins/tag desc=tag]] plugin.
These directives allow tagging pages. List tags as follows:
-The `template` directive is supplied by the [[!iki plugins/template]] plugin.
+The `template` directive is supplied by the [[!iki plugins/template desc=template]] plugin.
[[Templates]] are files that can be filled out and inserted into pages in the
wiki, by using the template directive. The directive has an `id` parameter
-The `testpagespec` directive is supplied by the [[!iki plugins/testpagespec]] plugin.
+The `testpagespec` directive is supplied by the [[!iki plugins/testpagespec desc=testpagespec]] plugin.
This 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.
-The `teximg` directive is supplied by the [[!iki plugins/teximg]] plugin.
+The `teximg` directive is supplied by the [[!iki plugins/teximg desc=teximg]] plugin.
This directive renders LaTeX formulas into images.
-The `toc` directive is supplied by the [[!iki plugins/toc]] plugin.
+The `toc` directive is supplied by the [[!iki plugins/toc desc=toc]] plugin.
Add a table of contents to a page:
-The `toggle` and `toggleable` directives are supplied by the [[!iki plugins/toggle]] plugin.
+The `toggle` and `toggleable` directives are supplied by the [[!iki plugins/toggle desc=toggle]] plugin.
With these directives you can create links on pages that, when clicked, toggle
display of other parts of the page.
-The `version` directive is supplied by the [[!iki plugins/version]] plugin.
+The `version` directive is supplied by the [[!iki plugins/version desc=version]] plugin.
This directive allows inserting the version of ikiwiki onto a page.
projects / ikiwiki.git / commitdiff