alternate suggestion

[git.ikiwiki.info.git] / doc / plugins / sparkline.mdwn

diff --git a/doc/plugins/sparkline.mdwn b/doc/plugins/sparkline.mdwn
index be3c68c421c20a8d17e58b5a9445459e384bf115..19b07b81248f3464b638488bdc4b31ec08785771 100644 (file)
--- a/doc/plugins/sparkline.mdwn
+++ b/doc/plugins/sparkline.mdwn
@@ -1,5 +1,5 @@
-[[template id=plugin name=sparkline author="[[Joey]]"]]
-[[tag type/chrome]]
+[[!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
 
 This plugin allows for easily embedding sparklines into wiki pages. A
 sparkline is a small word-size graphic chart, that is designed to be


@@ -15,44 +15,42 @@ to use the plugin, you will need:
   php can find it when `sparkline/Sparkline.php` is required.
 * The GD PHP module used by the Sparkline library.
 * A "php" program in the path, that can run standalone php programs.
   php can find it when `sparkline/Sparkline.php` is required.
 * The GD PHP module used by the Sparkline library.
 * A "php" program in the path, that can run standalone php programs.

-* [[cpan Digest::SHA1]]
+* [[!cpan Digest::SHA1]]

 
 

-On a Debian system, this can be accomplished by installing the
-`libsparkline-php`, `php5-gd`, `php5-cli`, and `libdigest-sha1-perl`
-packages.
+On a Debian system, this can be accomplished by installing these packages:
+`libsparkline-php` `php5-gd` `php5-cli` `libdigest-sha1-perl`
+
+This plugin also uses the [[!cpan Digest::SHA1]] perl module.

 
 # examples
 
 
 # examples
 

-       \[[sparkline 1 3 5 -3 10 0 width=40 height=16
+       \[[!sparkline 1 3 5 -3 10 0 width=40 height=16

        featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]]
 
        featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]]
 

-[[if test="enabled(sparkline)" then="""
-[[sparkline 1 3 5 -3 10 0 width=40 height=16
+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"]]
 """]]
 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.

 
 

-This creates a simple line graph, graphing several points. 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
+       \[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2

        barspacing=1 height=13]]
 
        barspacing=1 height=13]]
 

-[[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]]
+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]]

 """]]
 """]]

-
-This more complex example generates a bar graph. 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.
+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
 
 
 # usage
 

-The form for the data points is "x,y" for line graphs, or just "y" if the x
-values don't matter. Bar graphs can also add "(color)" to specify a color
-for that bar.
+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
 
 The following named parameters are recognised. Most of these are the same
 as those used by the underlying sparkline library, which is documented in