diff options
Diffstat (limited to 'doc/ikiwiki')
| -rw-r--r-- | doc/ikiwiki/directive/aggregate.mdwn | 5 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/cutpaste.mdwn | 6 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/haiku.mdwn | 2 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/map.mdwn | 2 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/meta.mdwn | 8 | ||||
| -rw-r--r-- | doc/ikiwiki/directive/progress.mdwn | 2 |
6 files changed, 8 insertions, 17 deletions
diff --git a/doc/ikiwiki/directive/aggregate.mdwn b/doc/ikiwiki/directive/aggregate.mdwn index f132c9746..58c580b8f 100644 --- a/doc/ikiwiki/directive/aggregate.mdwn +++ b/doc/ikiwiki/directive/aggregate.mdwn @@ -1,7 +1,6 @@ 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: diff --git a/doc/ikiwiki/directive/cutpaste.mdwn b/doc/ikiwiki/directive/cutpaste.mdwn index 7c1d5b6cb..a2ce40d64 100644 --- a/doc/ikiwiki/directive/cutpaste.mdwn +++ b/doc/ikiwiki/directive/cutpaste.mdwn @@ -17,12 +17,6 @@ follow the paste directive that uses its text. In fact, this is quite useful 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]]"]] diff --git a/doc/ikiwiki/directive/haiku.mdwn b/doc/ikiwiki/directive/haiku.mdwn index 15d303bb7..a7e99f219 100644 --- a/doc/ikiwiki/directive/haiku.mdwn +++ b/doc/ikiwiki/directive/haiku.mdwn @@ -1,6 +1,6 @@ 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"]] diff --git a/doc/ikiwiki/directive/map.mdwn b/doc/ikiwiki/directive/map.mdwn index 543470864..eb8d11f39 100644 --- a/doc/ikiwiki/directive/map.mdwn +++ b/doc/ikiwiki/directive/map.mdwn @@ -9,7 +9,7 @@ the wiki are mapped. 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]] diff --git a/doc/ikiwiki/directive/meta.mdwn b/doc/ikiwiki/directive/meta.mdwn index b01dbfe76..bbf020c3e 100644 --- a/doc/ikiwiki/directive/meta.mdwn +++ b/doc/ikiwiki/directive/meta.mdwn @@ -1,6 +1,6 @@ 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"]] @@ -44,7 +44,7 @@ Supported fields: * 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 @@ -125,9 +125,7 @@ Supported fields: 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 diff --git a/doc/ikiwiki/directive/progress.mdwn b/doc/ikiwiki/directive/progress.mdwn index c477c435a..23b69a360 100644 --- a/doc/ikiwiki/directive/progress.mdwn +++ b/doc/ikiwiki/directive/progress.mdwn @@ -6,7 +6,7 @@ There are two possible parameter sets. The first is a single parameter "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. |