diff options
Diffstat (limited to 'doc/ikiwiki')
36 files changed, 41 insertions, 41 deletions
diff --git a/doc/ikiwiki/directive/aggregate.mdwn b/doc/ikiwiki/directive/aggregate.mdwn index 58c580b8f..702d91cf5 100644 --- a/doc/ikiwiki/directive/aggregate.mdwn +++ b/doc/ikiwiki/directive/aggregate.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/brokenlinks.mdwn b/doc/ikiwiki/directive/brokenlinks.mdwn index 2cde5b64a..91bafe5a0 100644 --- a/doc/ikiwiki/directive/brokenlinks.mdwn +++ b/doc/ikiwiki/directive/brokenlinks.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/calendar.mdwn b/doc/ikiwiki/directive/calendar.mdwn index 5cbfa2dc6..8a257d6eb 100644 --- a/doc/ikiwiki/directive/calendar.mdwn +++ b/doc/ikiwiki/directive/calendar.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/color.mdwn b/doc/ikiwiki/directive/color.mdwn index be8907099..553767f00 100644 --- a/doc/ikiwiki/directive/color.mdwn +++ b/doc/ikiwiki/directive/color.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/cutpaste.mdwn b/doc/ikiwiki/directive/cutpaste.mdwn index a2ce40d64..012367bdf 100644 --- a/doc/ikiwiki/directive/cutpaste.mdwn +++ b/doc/ikiwiki/directive/cutpaste.mdwn @@ -1,5 +1,5 @@ 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: diff --git a/doc/ikiwiki/directive/edittemplate.mdwn b/doc/ikiwiki/directive/edittemplate.mdwn index b3187ea66..779c3fa3c 100644 --- a/doc/ikiwiki/directive/edittemplate.mdwn +++ b/doc/ikiwiki/directive/edittemplate.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/fortune.mdwn b/doc/ikiwiki/directive/fortune.mdwn index 5ba704b66..45f533eb2 100644 --- a/doc/ikiwiki/directive/fortune.mdwn +++ b/doc/ikiwiki/directive/fortune.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/graph.mdwn b/doc/ikiwiki/directive/graph.mdwn index 48eb7e340..433187268 100644 --- a/doc/ikiwiki/directive/graph.mdwn +++ b/doc/ikiwiki/directive/graph.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/haiku.mdwn b/doc/ikiwiki/directive/haiku.mdwn index a7e99f219..979f0891f 100644 --- a/doc/ikiwiki/directive/haiku.mdwn +++ b/doc/ikiwiki/directive/haiku.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/if.mdwn b/doc/ikiwiki/directive/if.mdwn index d6419b18b..2338956d2 100644 --- a/doc/ikiwiki/directive/if.mdwn +++ b/doc/ikiwiki/directive/if.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/img.mdwn b/doc/ikiwiki/directive/img.mdwn index ab3c07bfd..1d1f29bea 100644 --- a/doc/ikiwiki/directive/img.mdwn +++ b/doc/ikiwiki/directive/img.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/inline.mdwn b/doc/ikiwiki/directive/inline.mdwn index 4bf0de13d..7538e3a53 100644 --- a/doc/ikiwiki/directive/inline.mdwn +++ b/doc/ikiwiki/directive/inline.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/linkmap.mdwn b/doc/ikiwiki/directive/linkmap.mdwn index ecc12bd77..8fdf40c9f 100644 --- a/doc/ikiwiki/directive/linkmap.mdwn +++ b/doc/ikiwiki/directive/linkmap.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/listdirectives.mdwn b/doc/ikiwiki/directive/listdirectives.mdwn index 0564159e0..b41d27a80 100644 --- a/doc/ikiwiki/directive/listdirectives.mdwn +++ b/doc/ikiwiki/directive/listdirectives.mdwn @@ -1,4 +1,4 @@ -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]]. diff --git a/doc/ikiwiki/directive/map.mdwn b/doc/ikiwiki/directive/map.mdwn index eb8d11f39..09c95a0c9 100644 --- a/doc/ikiwiki/directive/map.mdwn +++ b/doc/ikiwiki/directive/map.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn index bbf020c3e..74db31943 100644 --- a/doc/ikiwiki/directive/meta.mdwn +++ b/doc/ikiwiki/directive/meta.mdwn @@ -1,4 +1,4 @@ -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: @@ -91,7 +91,7 @@ Supported fields: \[[!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 @@ -108,7 +108,7 @@ Supported fields: \[[!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 @@ -141,7 +141,7 @@ Supported fields: 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"]] diff --git a/doc/ikiwiki/directive/more.mdwn b/doc/ikiwiki/directive/more.mdwn index 68c2cd39a..506551910 100644 --- a/doc/ikiwiki/directive/more.mdwn +++ b/doc/ikiwiki/directive/more.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/orphans.mdwn b/doc/ikiwiki/directive/orphans.mdwn index 19b00f0ca..b03f5ac30 100644 --- a/doc/ikiwiki/directive/orphans.mdwn +++ b/doc/ikiwiki/directive/orphans.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/pagecount.mdwn b/doc/ikiwiki/directive/pagecount.mdwn index f799a5d7f..0e6ca3c46 100644 --- a/doc/ikiwiki/directive/pagecount.mdwn +++ b/doc/ikiwiki/directive/pagecount.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn index de0419a03..cfb5737a5 100644 --- a/doc/ikiwiki/directive/pagestats.mdwn +++ b/doc/ikiwiki/directive/pagestats.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/pagetemplate.mdwn b/doc/ikiwiki/directive/pagetemplate.mdwn index 9c8e43962..0e4066f34 100644 --- a/doc/ikiwiki/directive/pagetemplate.mdwn +++ b/doc/ikiwiki/directive/pagetemplate.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/ping.mdwn b/doc/ikiwiki/directive/ping.mdwn index 9eac60fd5..691c75843 100644 --- a/doc/ikiwiki/directive/ping.mdwn +++ b/doc/ikiwiki/directive/ping.mdwn @@ -1,7 +1,7 @@ -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. diff --git a/doc/ikiwiki/directive/poll.mdwn b/doc/ikiwiki/directive/poll.mdwn index e991dfaa9..6aa3d2cea 100644 --- a/doc/ikiwiki/directive/poll.mdwn +++ b/doc/ikiwiki/directive/poll.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/polygen.mdwn b/doc/ikiwiki/directive/polygen.mdwn index 3facc131d..e8726341a 100644 --- a/doc/ikiwiki/directive/polygen.mdwn +++ b/doc/ikiwiki/directive/polygen.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/postsparkline.mdwn b/doc/ikiwiki/directive/postsparkline.mdwn index 398b48ef1..c17d32952 100644 --- a/doc/ikiwiki/directive/postsparkline.mdwn +++ b/doc/ikiwiki/directive/postsparkline.mdwn @@ -1,6 +1,6 @@ -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 diff --git a/doc/ikiwiki/directive/progress.mdwn b/doc/ikiwiki/directive/progress.mdwn index 23b69a360..529f1c3c1 100644 --- a/doc/ikiwiki/directive/progress.mdwn +++ b/doc/ikiwiki/directive/progress.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/shortcut.mdwn b/doc/ikiwiki/directive/shortcut.mdwn index 14cdbdce7..29db86ca5 100644 --- a/doc/ikiwiki/directive/shortcut.mdwn +++ b/doc/ikiwiki/directive/shortcut.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/sparkline.mdwn b/doc/ikiwiki/directive/sparkline.mdwn index d6eee7287..1f691e14f 100644 --- a/doc/ikiwiki/directive/sparkline.mdwn +++ b/doc/ikiwiki/directive/sparkline.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/table.mdwn b/doc/ikiwiki/directive/table.mdwn index 0d1af1249..e27a94b7c 100644 --- a/doc/ikiwiki/directive/table.mdwn +++ b/doc/ikiwiki/directive/table.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/tag.mdwn b/doc/ikiwiki/directive/tag.mdwn index a6e1833a4..267aee660 100644 --- a/doc/ikiwiki/directive/tag.mdwn +++ b/doc/ikiwiki/directive/tag.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/template.mdwn b/doc/ikiwiki/directive/template.mdwn index 38b7e3c5e..d538b69b1 100644 --- a/doc/ikiwiki/directive/template.mdwn +++ b/doc/ikiwiki/directive/template.mdwn @@ -1,4 +1,4 @@ -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 diff --git a/doc/ikiwiki/directive/testpagespec.mdwn b/doc/ikiwiki/directive/testpagespec.mdwn index 401353e89..dde7d99f5 100644 --- a/doc/ikiwiki/directive/testpagespec.mdwn +++ b/doc/ikiwiki/directive/testpagespec.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/teximg.mdwn b/doc/ikiwiki/directive/teximg.mdwn index bd040c9cf..e13d1ed65 100644 --- a/doc/ikiwiki/directive/teximg.mdwn +++ b/doc/ikiwiki/directive/teximg.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/toc.mdwn b/doc/ikiwiki/directive/toc.mdwn index 94b0fe1af..bf504dafc 100644 --- a/doc/ikiwiki/directive/toc.mdwn +++ b/doc/ikiwiki/directive/toc.mdwn @@ -1,4 +1,4 @@ -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: diff --git a/doc/ikiwiki/directive/toggle.mdwn b/doc/ikiwiki/directive/toggle.mdwn index 5729fca11..db11f0335 100644 --- a/doc/ikiwiki/directive/toggle.mdwn +++ b/doc/ikiwiki/directive/toggle.mdwn @@ -1,4 +1,4 @@ -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. diff --git a/doc/ikiwiki/directive/version.mdwn b/doc/ikiwiki/directive/version.mdwn index 8ab96d045..f1e2085a7 100644 --- a/doc/ikiwiki/directive/version.mdwn +++ b/doc/ikiwiki/directive/version.mdwn @@ -1,4 +1,4 @@ -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. |