diff options
author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/sparkline.mdwn | |
parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/sparkline.mdwn')
-rw-r--r-- | doc/plugins/sparkline.mdwn | 57 |
1 files changed, 2 insertions, 55 deletions
diff --git a/doc/plugins/sparkline.mdwn b/doc/plugins/sparkline.mdwn index 19b07b812..5f5d08b5e 100644 --- a/doc/plugins/sparkline.mdwn +++ b/doc/plugins/sparkline.mdwn @@ -1,9 +1,8 @@ [[!template id=plugin name=sparkline author="[[Joey]]"]] [[!tag type/chrome]] -This plugin allows for easily embedding sparklines into wiki pages. A -sparkline is a small word-size graphic chart, that is designed to be -inlined alongside text. +This plugin implements the [[ikiwiki/directive/sparkline]] [[ikiwiki/directive]]. +The directive allows for easily embedding sparklines into wiki pages. # requirements @@ -22,55 +21,3 @@ On a Debian system, this can be accomplished by installing these packages: This plugin also uses the [[!cpan Digest::SHA1]] perl module. -# examples - - \[[!sparkline 1 3 5 -3 10 0 width=40 height=16 - featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]] - -This creates a simple line graph, graphing several points. -[[!if test="enabled(sparkline)" then=""" -[[!sparkline 1 3 5 -3 10 0 width=40 height=16 -featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]] -"""]] -It will be drawn 40 pixels wide and 16 pixels high. The high point in the -line has a green marker, and the low point has a red marker. - - \[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2 - barspacing=1 height=13]] - -This more complex example generates a bar graph. -[[!if test="enabled(sparkline)" then=""" -[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) -style=bar barwidth=2 barspacing=1 height=13]] -"""]] -The bars are 2 pixels wide, and separated by one pixel, and the graph is 13 -pixels tall. Width is determined automatically for bar graphs. The points -with negative values are colored red, instead of the default black. - -# usage - -The form for the data points is "x,y", or just "y" if the x values don't -matter. Bar graphs can also add "(color)" to specify a color for that bar. - -The following named parameters are recognised. Most of these are the same -as those used by the underlying sparkline library, which is documented in -more detail in [its wiki](http://sparkline.wikispaces.com/usage). - -* `style` - Either "line" (the default) or "bar". -* `width` - Width of the graph in pixels. Only needed for line graphs. -* `height` - Height of the graph in pixels. Defaults to 16. -* `barwidth` - Width of bars in a bar graph. Default is 1 pixel. -* `barspacing` - Spacing between bars in a bar graph, in pixels. Default is - 1 pixel. -* `ymin`, `ymax` - Minimum and maximum values for the Y axis. This is - normally calculated automatically, but can be explicitly specified to get - the same values for multiple related graphs. -* `featurepoint` - Adds a circular marker to a line graph, with optional - text. This can be used to label significant points. - - The value is a comma-delimited list of parameters specifying the feature - point: X value, Y value, color name, circle diameter, text (optional), - and text location (optional). Example: `featurepoint="3,5,blue,3"` - - Available values for the text location are: "top", "right", "bottom", and - "left". |