diff options
Diffstat (limited to 'underlays/basewiki')
| -rw-r--r-- | underlays/basewiki/directive/cutpaste.mdwn | 7 | ||||
| -rw-r--r-- | underlays/basewiki/directive/img.mdwn | 4 | ||||
| -rw-r--r-- | underlays/basewiki/directive/listdirectives.mdwn | 14 | ||||
| -rw-r--r-- | underlays/basewiki/directive/meta.mdwn | 12 | ||||
| -rw-r--r-- | underlays/basewiki/directive/more.mdwn | 2 | ||||
| -rw-r--r-- | underlays/basewiki/directive/pagestats.mdwn | 4 | ||||
| -rw-r--r-- | underlays/basewiki/directive/pagetemplate.mdwn | 13 | ||||
| -rw-r--r-- | underlays/basewiki/directive/postsparkline.mdwn | 6 | ||||
| -rw-r--r-- | underlays/basewiki/directive/progress.mdwn | 7 | ||||
| -rw-r--r-- | underlays/basewiki/directive/shortcut.mdwn | 4 | ||||
| -rw-r--r-- | underlays/basewiki/directive/teximg.mdwn | 2 |
11 files changed, 39 insertions, 36 deletions
diff --git a/underlays/basewiki/directive/cutpaste.mdwn b/underlays/basewiki/directive/cutpaste.mdwn index 56dd993cb..6b90647e7 100644 --- a/underlays/basewiki/directive/cutpaste.mdwn +++ b/underlays/basewiki/directive/cutpaste.mdwn @@ -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 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. 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=bar text="\[[!paste id=baz]]"]] diff --git a/underlays/basewiki/directive/img.mdwn b/underlays/basewiki/directive/img.mdwn index d8c9f359f..cfcafc3b3 100644 --- a/underlays/basewiki/directive/img.mdwn +++ b/underlays/basewiki/directive/img.mdwn @@ -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 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. ## 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 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 -it: "200x", "x200". +it: "200x", "x200" 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` diff --git a/underlays/basewiki/directive/listdirectives.mdwn b/underlays/basewiki/directive/listdirectives.mdwn index 4d7ab5b3e..47ced80b5 100644 --- a/underlays/basewiki/directive/listdirectives.mdwn +++ b/underlays/basewiki/directive/listdirectives.mdwn @@ -5,12 +5,14 @@ This directive generates a list of available \[[!listdirectives]] -There is one optional keyword argument, `generated`. Normally the `listdirectives` directive will -list all built in directives and directives directly registered by plugins. With this keyword, -`listdirectives` will also list directives generated later. For example, all [[shortcuts]] are -directives generated in turn by the `shortcut` directive. They will only be listed if the `generated` argument is -supplied. +There is one optional keyword argument, `generated`. Normally the +`listdirectives` directive will list all built in directives and directives +directly registered by plugins. With this keyword, `listdirectives` will +also list directives generated later. For example, all [[shortcuts]] are +directives generated in turn by the `shortcut` directive. They will only +be listed if the `generated` argument is supplied. \[[!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. diff --git a/underlays/basewiki/directive/meta.mdwn b/underlays/basewiki/directive/meta.mdwn index 0b4b01ab8..c1d6cab08 100644 --- a/underlays/basewiki/directive/meta.mdwn +++ b/underlays/basewiki/directive/meta.mdwn @@ -90,8 +90,9 @@ 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 insert unsafe content. + However, this latter syntax won't be allowed if the + [[!iki plugins/htmlscrubber]] plugin is enabled, since it can be used to + insert unsafe content. * redir @@ -106,11 +107,12 @@ 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 insert unsafe content. + However, this latter syntax won't be allowed if the + [[!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 - specified using the common `PAGE#ANCHOR` syntax. + specified using the common `#ANCHOR` syntax. * robots diff --git a/underlays/basewiki/directive/more.mdwn b/underlays/basewiki/directive/more.mdwn index dc5f0d8b1..defe7eb3d 100644 --- a/underlays/basewiki/directive/more.mdwn +++ b/underlays/basewiki/directive/more.mdwn @@ -1,6 +1,6 @@ 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: \[[!more linktext="click for more" text=""" diff --git a/underlays/basewiki/directive/pagestats.mdwn b/underlays/basewiki/directive/pagestats.mdwn index c6888df37..c5b39bae3 100644 --- a/underlays/basewiki/directive/pagestats.mdwn +++ b/underlays/basewiki/directive/pagestats.mdwn @@ -1,8 +1,8 @@ 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 -produce either a del.icio.us style cloud, or a table counting the number of -links to each page. +produce either a tag cloud, or a table counting the number of links to each +page. Here's how to use it to create a [[tag]] cloud: diff --git a/underlays/basewiki/directive/pagetemplate.mdwn b/underlays/basewiki/directive/pagetemplate.mdwn index 631ea09a4..855763228 100644 --- a/underlays/basewiki/directive/pagetemplate.mdwn +++ b/underlays/basewiki/directive/pagetemplate.mdwn @@ -1,12 +1,13 @@ The `pagetemplate` directive is supplied by the [[!iki plugins/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 overall look and feel of the wiki page. This is -in contrast to the [[ikiwiki/directive/template]] directive, which allows inserting templates +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 +overall look and feel of the wiki page. This is in contrast to the +[[ikiwiki/directive/template]] directive, which allows inserting templates _into_ the body of a page. 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"]] diff --git a/underlays/basewiki/directive/postsparkline.mdwn b/underlays/basewiki/directive/postsparkline.mdwn index d10451f85..4ee8569f1 100644 --- a/underlays/basewiki/directive/postsparkline.mdwn +++ b/underlays/basewiki/directive/postsparkline.mdwn @@ -1,7 +1,7 @@ The `postsparkline` directive is supplied by the [[!iki plugins/postsparkline]] plugin. -This plugin uses the [[!iki plugins/sparkline]] plugin to create a [[sparkline]] of -statistics about a set of pages, such as posts to a blog. +This directive uses the [[!iki plugins/sparkline]] plugin to create a +[[sparkline]] of statistics about a set of pages, such as posts to a blog. # examples @@ -16,7 +16,7 @@ statistics about a set of pages, such as posts to a blog. # usage 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). Instead, data points are automatically generated based on the creation diff --git a/underlays/basewiki/directive/progress.mdwn b/underlays/basewiki/directive/progress.mdwn index 8f2426693..57b37ec4a 100644 --- a/underlays/basewiki/directive/progress.mdwn +++ b/underlays/basewiki/directive/progress.mdwn @@ -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 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"]] diff --git a/underlays/basewiki/directive/shortcut.mdwn b/underlays/basewiki/directive/shortcut.mdwn index 2c6e0224f..25aa9f382 100644 --- a/underlays/basewiki/directive/shortcut.mdwn +++ b/underlays/basewiki/directive/shortcut.mdwn @@ -1,7 +1,7 @@ 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. The available shortcuts are defined on the [[shortcuts]] page in -the wiki. +the wiki. The `shortcut` directive can only be used on that page. diff --git a/underlays/basewiki/directive/teximg.mdwn b/underlays/basewiki/directive/teximg.mdwn index b80c0d016..08bec67a8 100644 --- a/underlays/basewiki/directive/teximg.mdwn +++ b/underlays/basewiki/directive/teximg.mdwn @@ -19,5 +19,3 @@ height is used. To add an alt text to the image, use alt="text": \[[!teximg code="\frac{1}{2}" alt="1/2"]] - -See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images. |