summaryrefslogtreecommitdiff
path: root/doc/plugins/postsparkline.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:05:51 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:51 -0400
commitc69a7f758590c91bd137a8d1cfa99f37bf28045a (patch)
tree16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/postsparkline.mdwn
parent4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff)
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/postsparkline.mdwn')
-rw-r--r--doc/plugins/postsparkline.mdwn42
1 files changed, 2 insertions, 40 deletions
diff --git a/doc/plugins/postsparkline.mdwn b/doc/plugins/postsparkline.mdwn
index 73c6801a1..b94a310bf 100644
--- a/doc/plugins/postsparkline.mdwn
+++ b/doc/plugins/postsparkline.mdwn
@@ -1,48 +1,10 @@
[[!template id=plugin name=postsparkline author="[[Joey]]"]]
[[!tag type/chrome]]
-This plugin uses the [[sparkline]] plugin to create a sparkline of
+This plugin implements the [[ikiwiki/directive/postsparkline]] [[ikiwiki/directive]].
+It uses the [[sparkline]] plugin to create a sparkline of
statistics about a set of pages, such as posts to a blog.
-# examples
-
- Post interval:
- \[[!postsparkline pages="blog/* and !*/Discussion" max=100
- formula=interval style=bar barwidth=2 barspacing=1 height=13]]
-
- Posts per month this year:
- \[[!postsparkline pages="blog/* and !*/Discussion" max=12
- formula=permonth style=bar barwidth=2 barspacing=1 height=13]]
-
-# usage
-
-All options aside fron the `pages`, `max`, `formula`, `time`, and `color`
-options are passed on to the sparkline plugin.
-
-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
-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:
-
-* `interval` - The height of each point represents how long it has been
- since the previous post.
-* `perday` - Each point represents a day; the height represents how
- 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
- many posts were made that year.
-
-The `time` parameter has a default value of "ctime", since forumae use
-the creation times of pages by default. If you instead want
-them to use the modification times of pages, set it to "mtime".
-
-To change the color used to draw the sparkline, use the `color` parameter.
-For example, "color=red".
-
# adding formulae
Additional formulae can be added without modifying this plugin by writing