misc minor changes
parent
eb92d09360
commit
5e4767a594
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=color core=0 author="[[ptecza]]"]]
|
[[!template id=plugin name=color core=0 author="[[ptecza]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!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.
|
The directive can be used to color a piece of text on a page.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=conditional core=1 author="[[Joey]]"]]
|
[[!template id=plugin name=conditional core=1 author="[[Joey]]"]]
|
||||||
[[!tag type/format]]
|
[[!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.
|
With this directive, you can make text be conditionally displayed on a page.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
[[!template id=plugin name=toggle author="[[Enrico]]"]]
|
[[!template id=plugin name=toggle author="[[Enrico]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!tag type/chrome]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/cut]],
|
This plugin provides the [[ikiwiki/directive/cut]],
|
||||||
[[ikiwiki/directive/copy]] and [[ikiwiki/directive/paste]] [[ikiwiki/directive]]s.
|
[[ikiwiki/directive/copy]] and [[ikiwiki/directive/paste]]
|
||||||
With these directives you can store and recall pieces of text.
|
[[directives|ikiwiki/directive]].
|
||||||
|
With these directives you can store and recall pieces of text in a page.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[[!template id=plugin name=edittemplate author="[[Joey]]"]]
|
[[!template id=plugin name=edittemplate author="[[Joey]]"]]
|
||||||
[[!tag type/useful]]
|
[[!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
|
This directive allows registering template pages, that provide default
|
||||||
content for new pages created using the web frontend.
|
content for new pages created using the web frontend.
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
[[!template id=plugin name=haiku author="[[Joey]]"]]
|
[[!template id=plugin name=haiku author="[[Joey]]"]]
|
||||||
[[!tag type/fun]]
|
[[!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.
|
The directive allows inserting a randomly generated haiku into a wiki page.
|
||||||
|
|
||||||
As a special bonus, enabling this plugin makes any error messages ikiwiki
|
As a special bonus, enabling this plugin makes any error messages ikiwiki
|
||||||
should display be written in haiku.
|
should display be written in haiku.
|
||||||
|
|
||||||
You need to have the Coy module installed for this plugin to do anything
|
You need to have the [[!cpan Coy]] module installed for this plugin to do
|
||||||
interesting. That does all the heavy lifting.
|
anything interesting. That does all the heavy lifting.
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
[[!template id=plugin name=img author="Christian Mock"]]
|
[[!template id=plugin name=img author="Christian Mock"]]
|
||||||
[[!tag type/chrome]]
|
[[!tag type/chrome]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/img]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/img]] [[ikiwiki/directive]].
|
||||||
This is an image handling directive. While ikiwiki supports inlining full-size
|
While ikiwiki supports inlining full-size images by making a
|
||||||
images by making a [[ikiwiki/WikiLink]] that points to the image, using
|
[[ikiwiki/WikiLink]] that points to the image, using this directive you can
|
||||||
this plugin you can easily scale down an image for inclusion onto a page,
|
easily scale down an image for inclusion onto a page, providing a link to a
|
||||||
providing a link to a full-size version.
|
full-size version.
|
||||||
|
|
||||||
This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via
|
This plugin uses the [ImageMagick](http://www.imagemagick.org/) tools via
|
||||||
[PerlMagick](http://www.imagemagick.org/www/perl-magick.html).
|
[PerlMagick](http://www.imagemagick.org/www/perl-magick.html).
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=inline core=1 author="[[Joey]]"]]
|
[[!template id=plugin name=inline core=1 author="[[Joey]]"]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/inline]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/inline]]
|
||||||
This is a [[ikiwiki/directive]] that allows including one wiki page
|
[[ikiwiki/directive]], which allows including one wiki page
|
||||||
inside another.
|
inside another.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[!template id=plugin name=listdirectives author="Will"]]
|
[[!template id=plugin name=listdirectives author="Will"]]
|
||||||
[[!tag type/meta]]
|
[[!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.
|
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
|
Each directive links to a wiki page with the same name. The location of the
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=meta author="[[Joey]]"]]
|
[[!template id=plugin name=meta author="[[Joey]]"]]
|
||||||
[[!tag type/meta]]
|
[[!tag type/meta]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/meta]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/meta]] [[ikiwiki/directive]],
|
||||||
The directive allows inserting arbitrary metadata into the source of a page.
|
which allows inserting various metadata into the source of a page.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[[!template id=plugin name=more author="Ben"]]
|
[[!template id=plugin name=more author="Ben"]]
|
||||||
[[!tag type/format]]
|
[[!tag type/format]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/more]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/more]] [[ikiwiki/directive]],
|
||||||
The directive provides a way to have a "more" link on a page in a blog, that
|
which is a way to have a "more" link on a post in a blog, that leads to the
|
||||||
leads to the full version of the page.
|
full version of the page.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
[[!template id=plugin name=pagestats author="Enrico Zini"]]
|
[[!template id=plugin name=pagestats author="Enrico Zini"]]
|
||||||
[[!tag type/meta type/tags]]
|
[[!tag type/meta type/tags]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/pagestats]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/pagestats]]
|
||||||
The directive can generate stats about how pages link to each other.
|
[[ikiwiki/directive]], which can generate stats about how pages link to
|
||||||
|
each other, or display a tag cloud.
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
[[!template id=plugin name=pagetemplate author="[[Joey]]"]]
|
[[!template id=plugin name=pagetemplate author="[[Joey]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!tag type/chrome]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/pagetemplate]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/pagetemplate]]
|
||||||
The directive allows a page to be created using a different
|
[[ikiwiki/directive]], which allows a page to be created using a different
|
||||||
[[template|wikitemplates]].
|
[[template|wikitemplates]].
|
||||||
|
|
||||||
This plugin can only use templates that are already installed in
|
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.
|
them). You can choose to use any .tmpl files in that directory.
|
||||||
|
|
|
@ -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
|
a wiki. By pinging the mirror or branch each time the main wiki changes, it
|
||||||
can be kept up-to-date.
|
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
|
The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan
|
||||||
LWPx::ParanoidAgent]] perl module is used if available, for added security.
|
LWPx::ParanoidAgent]] perl module is used if available, for added security.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=poll author="[[Joey]]"]]
|
[[!template id=plugin name=poll author="[[Joey]]"]]
|
||||||
[[!tag type/useful]]
|
[[!tag type/useful]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/poll]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/poll]] [[ikiwiki/directive]],
|
||||||
The directive allows you to create online polls in the wiki.
|
which allows inserting an online poll into a page.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[!template id=plugin name=postsparkline author="[[Joey]]"]]
|
[[!template id=plugin name=postsparkline author="[[Joey]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!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
|
It uses the [[sparkline]] plugin to create a sparkline of
|
||||||
statistics about a set of pages, such as posts to a blog.
|
statistics about a set of pages, such as posts to a blog.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=progress author="[[Will]]"]]
|
[[!template id=plugin name=progress author="[[Will]]"]]
|
||||||
[[!tag type/meta]]
|
[[!tag type/meta]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/progress]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/progress]]
|
||||||
The directive that displays a progress bar.
|
[[ikiwiki/directive]], which generates a progress bar.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[!template id=plugin name=shortcut author="[[Joey]]"]]
|
[[!template id=plugin name=shortcut author="[[Joey]]"]]
|
||||||
[[!tag type/format]]
|
[[!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
|
It allows external links to commonly linked to sites to be made
|
||||||
more easily using shortcuts.
|
more easily using shortcuts.
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,10 @@
|
||||||
[[!template id=plugin name=sparkline author="[[Joey]]"]]
|
[[!template id=plugin name=sparkline author="[[Joey]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!tag type/chrome]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/sparkline]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/sparkline]]
|
||||||
The directive allows for easily embedding sparklines into wiki pages.
|
[[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
|
# requirements
|
||||||
|
|
||||||
|
@ -18,6 +20,3 @@ to use the plugin, you will need:
|
||||||
|
|
||||||
On a Debian system, this can be accomplished by installing these packages:
|
On a Debian system, this can be accomplished by installing these packages:
|
||||||
`libsparkline-php` `php5-gd` `php5-cli` `libdigest-sha1-perl`
|
`libsparkline-php` `php5-gd` `php5-cli` `libdigest-sha1-perl`
|
||||||
|
|
||||||
This plugin also uses the [[!cpan Digest::SHA1]] perl module.
|
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
[[!template id=plugin name=table author="[[VictorMoral]]"]]
|
[[!template id=plugin name=table author="[[VictorMoral]]"]]
|
||||||
[[!tag type/format]]
|
[[!tag type/format]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/table]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/table]] [[ikiwiki/directive]].
|
||||||
The directive can build HTML tables from data in CSV (comma-separated values)
|
It can build HTML tables from data in CSV (comma-separated values)
|
||||||
or DSV (delimiter-separated values) format.
|
or DSV (delimiter-separated values) format.
|
||||||
|
|
||||||
It needs the perl module [[!cpan Text::CSV]] for the CSV data.
|
It needs the perl module [[!cpan Text::CSV]] for the CSV data.
|
||||||
|
|
|
@ -5,9 +5,7 @@ This plugin provides the [[ikiwiki/directive/tag]] and
|
||||||
[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]].
|
[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]].
|
||||||
These directives allow tagging pages.
|
These directives allow tagging pages.
|
||||||
|
|
||||||
This plugin has a configuration option. Set --tagbase=tags and links to tags
|
[[!if test="enabled(tag)" then="""
|
||||||
will be located under the specified base page. If ikiwiki is configured
|
This wiki has the tag plugin enabled, so you'll see a note below that this
|
||||||
this way, then the example above actually tags the page with the tags
|
page is tagged with the "tags" tag.
|
||||||
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.
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[!template id=plugin name=template author="[[Joey]]"]]
|
[[!template id=plugin name=template author="[[Joey]]"]]
|
||||||
[[!tag type/format]]
|
[[!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
|
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
|
and inserted into pages in the wiki. It's documented and existing templates
|
||||||
are listed in the [[templates]] page.
|
are listed in the [[templates]] page.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[[!template id=plugin name=testpagespec author="[[Joey]]"]]
|
[[!template id=plugin name=testpagespec author="[[Joey]]"]]
|
||||||
[[!tag type/useful]]
|
[[!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
|
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.
|
page, and to see the part that matches, or causes the match to fail.
|
||||||
|
|
|
@ -1,11 +1,14 @@
|
||||||
[[!template id=plugin name=teximg author="[[PatrickWinnertz]]"]]
|
[[!template id=plugin name=teximg author="[[PatrickWinnertz]]"]]
|
||||||
[[!tag type/chrome type/slow]]
|
[[!tag type/chrome type/slow]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/teximg]] [[ikiwiki/directive]].
|
This plugin provides a [[ikiwiki/directive/teximg]] [[ikiwiki/directive]],
|
||||||
The directive renders LaTeX formulas into images.
|
that renders LaTeX formulas into images.
|
||||||
|
|
||||||
Of course you will need LaTeX installed for this to work.
|
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
|
## configuration
|
||||||
|
|
||||||
There are several configuration directives that can be used in the setup
|
There are several configuration directives that can be used in the setup
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[!template id=plugin name=toc author="[[Joey]]"]]
|
[[!template id=plugin name=toc author="[[Joey]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!tag type/chrome]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/toc]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/toc]] [[ikiwiki/directive]],
|
||||||
The directive adds table of contents to a page.
|
which adds a table of contents to a page.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[!template id=plugin name=toggle author="[[Joey]]"]]
|
[[!template id=plugin name=toggle author="[[Joey]]"]]
|
||||||
[[!tag type/chrome]]
|
[[!tag type/chrome]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/toggle]] and
|
This plugin provides the [[ikiwiki/directive/toggle]] and
|
||||||
[[ikiwiki/directive/toggleable]] [[ikiwiki/directive]]s.
|
[[ikiwiki/directive/toggleable]] [[directives|ikiwiki/directive]].
|
||||||
With these directives you can create links on pages that, when clicked, toggle
|
With these directives you can create links on pages that, when clicked, toggle
|
||||||
display of other parts of the page.
|
display of other parts of the page.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
[[!template id=plugin name=version author="[[Joey]]"]]
|
[[!template id=plugin name=version author="[[Joey]]"]]
|
||||||
[[!tag type/useful]]
|
[[!tag type/useful]]
|
||||||
|
|
||||||
This plugin implements the [[ikiwiki/directive/version]] [[ikiwiki/directive]].
|
This plugin provides the [[ikiwiki/directive/version]]
|
||||||
It inserts the version of ikiwiki into a page.
|
[[ikiwiki/directive]], which inserts the current version
|
||||||
|
of ikiwiki into a page.
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
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
|
* `\[[!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.
|
using the given ID. The text being cut is not included in the output.
|
||||||
|
@ -42,7 +43,7 @@ This can potentially be used to create loops, but ikiwiki is clever and breaks
|
||||||
them.
|
them.
|
||||||
|
|
||||||
Since you can paste without using double quotes, copy and paste can be used to
|
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=foo text="""
|
||||||
\[[!toggleable id=bar text="\[[!paste id=baz]]"]]
|
\[[!toggleable id=bar text="\[[!paste id=baz]]"]]
|
||||||
|
|
|
@ -2,7 +2,7 @@ The `img` directive is supplied by the [[!iki plugins/img]] plugin.
|
||||||
|
|
||||||
This is an image handling directive. While ikiwiki supports inlining full-size
|
This is an image handling directive. While ikiwiki supports inlining full-size
|
||||||
images by making a [[ikiwiki/WikiLink]] that points to the image, using
|
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.
|
providing a link to a full-size version.
|
||||||
|
|
||||||
## usage
|
## usage
|
||||||
|
@ -16,7 +16,7 @@ The `size` parameter is optional, defaulting to full size. Note that the
|
||||||
original image's aspect ratio is always preserved, even if this means
|
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
|
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
|
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
|
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`
|
passed through unchanged to the html img tag. If you include a `caption`
|
||||||
|
|
|
@ -5,12 +5,14 @@ This directive generates a list of available
|
||||||
|
|
||||||
\[[!listdirectives]]
|
\[[!listdirectives]]
|
||||||
|
|
||||||
There is one optional keyword argument, `generated`. Normally the `listdirectives` directive will
|
There is one optional keyword argument, `generated`. Normally the
|
||||||
list all built in directives and directives directly registered by plugins. With this keyword,
|
`listdirectives` directive will list all built in directives and directives
|
||||||
`listdirectives` will also list directives generated later. For example, all [[shortcuts]] are
|
directly registered by plugins. With this keyword, `listdirectives` will
|
||||||
directives generated in turn by the `shortcut` directive. They will only be listed if the `generated` argument is
|
also list directives generated later. For example, all [[shortcuts]] are
|
||||||
supplied.
|
directives generated in turn by the `shortcut` directive. They will only
|
||||||
|
be listed if the `generated` argument is supplied.
|
||||||
|
|
||||||
\[[!listdirectives generated]]
|
\[[!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.
|
||||||
|
|
|
@ -90,8 +90,9 @@ Supported fields:
|
||||||
|
|
||||||
\[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
|
\[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]]
|
||||||
|
|
||||||
However, this latter syntax won't be allowed if the [[!iki plugins/htmlscrubber]]
|
However, this latter syntax won't be allowed if the
|
||||||
plugin is enabled, since it can be used to insert unsafe content.
|
[[!iki plugins/htmlscrubber]] plugin is enabled, since it can be used to
|
||||||
|
insert unsafe content.
|
||||||
|
|
||||||
* redir
|
* redir
|
||||||
|
|
||||||
|
@ -106,11 +107,12 @@ Supported fields:
|
||||||
|
|
||||||
\[[!meta redir="http://example.com/"]]
|
\[[!meta redir="http://example.com/"]]
|
||||||
|
|
||||||
However, this latter syntax won't be allowed if the [[!iki plugins/htmlscrubber]]
|
However, this latter syntax won't be allowed if the
|
||||||
plugin is enabled, since it can be used to insert unsafe content.
|
[[!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
|
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
|
* robots
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
The `more` directive is supplied by the [[!iki plugins/more]] plugin.
|
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:
|
leads to the full version of the page. Use it like this:
|
||||||
|
|
||||||
\[[!more linktext="click for more" text="""
|
\[[!more linktext="click for more" text="""
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
The `pagestats` directive is supplied by the [[!iki plugins/pagestats]] plugin.
|
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
|
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
|
produce either a tag cloud, or a table counting the number of links to each
|
||||||
links to each page.
|
page.
|
||||||
|
|
||||||
Here's how to use it to create a [[tag]] cloud:
|
Here's how to use it to create a [[tag]] cloud:
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,13 @@
|
||||||
The `pagetemplate` directive is supplied by the [[!iki plugins/pagetemplate]] plugin.
|
The `pagetemplate` directive is supplied by the [[!iki plugins/pagetemplate]] plugin.
|
||||||
|
|
||||||
This directive allows a page to be created using a different
|
This directive allows a page to be created using a different wikitemplates.
|
||||||
wikitemplates. The page text is inserted into the template, so
|
The page text is inserted into the template, so the template controls the
|
||||||
the template controls the overall look and feel of the wiki page. This is
|
overall look and feel of the wiki page. This is in contrast to the
|
||||||
in contrast to the [[ikiwiki/directive/template]] directive, which allows inserting templates
|
[[ikiwiki/directive/template]] directive, which allows inserting templates
|
||||||
_into_ the body of a page.
|
_into_ the body of a page.
|
||||||
|
|
||||||
This directive can only reference templates that are already installed
|
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"]]
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
The `postsparkline` directive is supplied by the [[!iki plugins/postsparkline]] plugin.
|
The `postsparkline` directive is supplied by the [[!iki plugins/postsparkline]] plugin.
|
||||||
|
|
||||||
This plugin uses the [[!iki plugins/sparkline]] plugin to create a [[sparkline]] of
|
This directive uses the [[!iki plugins/sparkline]] plugin to create a
|
||||||
statistics about a set of pages, such as posts to a blog.
|
[[sparkline]] of statistics about a set of pages, such as posts to a blog.
|
||||||
|
|
||||||
# examples
|
# examples
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ statistics about a set of pages, such as posts to a blog.
|
||||||
# usage
|
# usage
|
||||||
|
|
||||||
All options aside fron the `pages`, `max`, `formula`, `time`, and `color`
|
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).
|
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
|
Instead, data points are automatically generated based on the creation
|
||||||
|
|
|
@ -10,8 +10,7 @@ The second possible set of parameters is a pair of [[ikiwiki/PageSpec]]s,
|
||||||
pages in each pagespec and shows the percentage of the total pages that are
|
pages in each pagespec and shows the percentage of the total pages that are
|
||||||
done.
|
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"]]
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
The `shortcut` directive is supplied by the [[!iki plugins/shortcut]] plugin.
|
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.
|
more easily using shortcuts.
|
||||||
|
|
||||||
The available shortcuts are defined on the [[shortcuts]] page in
|
The available shortcuts are defined on the [[shortcuts]] page in
|
||||||
the wiki.
|
the wiki. The `shortcut` directive can only be used on that page.
|
||||||
|
|
|
@ -19,5 +19,3 @@ height is used.
|
||||||
To add an alt text to the image, use alt="text":
|
To add an alt text to the image, use alt="text":
|
||||||
|
|
||||||
\[[!teximg code="\frac{1}{2}" alt="1/2"]]
|
\[[!teximg code="\frac{1}{2}" alt="1/2"]]
|
||||||
|
|
||||||
See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images.
|
|
||||||
|
|
Loading…
Reference in New Issue