urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

wording 

Specifically, places that refer to "plugin" when they're really talking
about a directive.
master
Joey Hess 2008-09-11 18:51:23 -04:00
parent bc7381c4f9
commit 1d650e7810
6 changed files with 8 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/ikiwiki/directive/aggregate.mdwn
View File

@ -1,7 +1,6 @@
The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin. The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin.
This plugin requires extra setup, specifically, a cron job. See the
This plugin requires extra setup, specifically, a cron job. plugin's documentation for details.
See the plugin documentation for details.
This directive allows content from other feeds to be aggregated into the wiki. This directive allows content from other feeds to be aggregated into the wiki.
Aggregate a feed as follows: Aggregate a feed as follows:

6
doc/ikiwiki/directive/cutpaste.mdwn
View File

@ -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 to postpone big blocks of text like long annotations and have a more natural
flow. For example: 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="cut" text="\[[!paste id=cutlongdesc]]"]]
\[[!toggleable id="copy" text="\[[!paste id=copylongdesc]]"]] \[[!toggleable id="copy" text="\[[!paste id=copylongdesc]]"]]
\[[!toggleable id="paste" text="\[[!paste id=pastelongdesc]]"]] \[[!toggleable id="paste" text="\[[!paste id=pastelongdesc]]"]]

2
doc/ikiwiki/directive/haiku.mdwn
View File

@ -1,6 +1,6 @@
The `haiku` directive is supplied by the [[!iki plugins/haiku]] plugin. 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: Just type:
\[[!haiku hint="argument"]] \[[!haiku hint="argument"]]

2
doc/ikiwiki/directive/map.mdwn
View File

@ -9,7 +9,7 @@ the wiki are mapped.
By default, the names of pages are shown in the map. The `show` parameter 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 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]] \[[!map pages="* and !blog/* and !*/Discussion" show=title]]

8
doc/ikiwiki/directive/meta.mdwn
View File

@ -1,6 +1,6 @@
The `meta` directive is supplied by the [[!iki plugins/meta]] plugin. 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: Enter the metadata as follows:
\[[!meta field="value"]] \[[!meta field="value"]]
@ -44,7 +44,7 @@ Supported fields:
* description * description
Specifies a "description" of the page. You could use this to provide 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 * permalink
@ -125,9 +125,7 @@ Supported fields:
some combinations make sense. If there is no robots meta tag, "index, some combinations make sense. If there is no robots meta tag, "index,
follow" is used as the default. follow" is used as the default.
The plugin escapes the value, but otherwise does not care about its The value is escaped, but its contents are not otherwise checked.
contents. In particular, it does not check the values against the set of
valid values but serves whatever you pass it.
* guid * guid

2
doc/ikiwiki/directive/progress.mdwn
View File

@ -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. "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, 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 pages in each pagespec and shows the percentage of the total pages that are
done. done.