The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin.
-
-This plugin requires extra setup, specifically, a cron job.
-See the plugin documentation for details.
+This plugin requires extra setup, specifically, a cron job. See the
+plugin's documentation for details.
This directive allows content from other feeds to be aggregated into the wiki.
Aggregate a feed as follows:
to postpone big blocks of text like long annotations and have a more natural
flow. For example:
- This plugin provides three directives:
-
- * \[[!toggle id="cut" text="cut"]] that cuts text
- * \[[!toggle id="copy" text="copy"]] that copies text
- * \[[!toggle id="paste" text="paste"]] that pastes text
-
\[[!toggleable id="cut" text="\[[!paste id=cutlongdesc]]"]]
\[[!toggleable id="copy" text="\[[!paste id=copylongdesc]]"]]
\[[!toggleable id="paste" text="\[[!paste id=pastelongdesc]]"]]
The `haiku` directive is supplied by the [[!iki plugins/haiku]] plugin.
-This plugin allows inserting a randomly generated haiku into a wiki page.
+This directive allows inserting a randomly generated haiku into a wiki page.
Just type:
\[[!haiku hint="argument"]]
By default, the names of pages are shown in the map. The `show` parameter
can be used to show the titles or descriptions of pages instead (as set by
-the [[meta]] plugin). For example:
+the [[meta]] directive). For example:
\[[!map pages="* and !blog/* and !*/Discussion" show=title]]
The `meta` directive is supplied by the [[!iki plugins/meta]] plugin.
-This plugin allows inserting arbitrary metadata into the source of a page.
+This directive allows inserting arbitrary metadata into the source of a page.
Enter the metadata as follows:
\[[!meta field="value"]]
* description
Specifies a "description" of the page. You could use this to provide
- a summary, for example, to be picked up by the [[map]] plugin.
+ a summary, for example, to be picked up by the [[map]] directive.
* permalink
some combinations make sense. If there is no robots meta tag, "index,
follow" is used as the default.
- The plugin escapes the value, but otherwise does not care about its
- contents. In particular, it does not check the values against the set of
- valid values but serves whatever you pass it.
+ The value is escaped, but its contents are not otherwise checked.
* guid
"percent" which holds a percentage figure of how complete the progress bar is.
The second possible set of parameters is a pair of [[ikiwiki/PageSpec]]s,
-`totalpages` and `donepages`. The progress plugin counts the number of
+`totalpages` and `donepages`. The directive counts the number of
pages in each pagespec and shows the percentage of the total pages that are
done.