X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9921a4a8a1a696ce69acce5e14943f0149d926ff..623c7e17989f53ef049f12639950d2c50c9edd4f:/doc/ikiwiki/directive/postsparkline.mdwn diff --git a/doc/ikiwiki/directive/postsparkline.mdwn b/doc/ikiwiki/directive/postsparkline.mdwn index 398b48ef1..318512eef 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 @@ -15,7 +15,7 @@ This directive uses the [[!iki plugins/sparkline]] plugin to create a # usage -All options aside fron the `pages`, `max`, `formula`, `time`, and `color` +All options aside from the `pages`, `max`, `formula`, `time`, and `color` options are the same as in [[sparkline]] directive. You don't need to specify any data points (though you can if you want to). @@ -24,7 +24,7 @@ times of pages matched by the specified `pages` [[ikiwiki/PageSpec]]. A maximum of `max` data points will be generated. The `formula` parameter controls the formula used to generate data points. -Available forumlae: +Available formulae: * `interval` - The height of each point represents how long it has been since the previous post. @@ -32,10 +32,10 @@ Available forumlae: many posts were made that day. * `permonth` - Each point represents a month; the height represents how many posts were made that month. -* `peryear` - Each point represents a day; the height represents how +* `peryear` - Each point represents a year; the height represents how many posts were made that year. -The `time` parameter has a default value of "ctime", since forumae use +The `time` parameter has a default value of "ctime", since formulae use the creation times of pages by default. If you instead want them to use the modification times of pages, set it to "mtime".