Merge remote branch 'upstream/master' into prv/po
[ikiwiki.git] / doc / plugins / sparkline.mdwn
1 [[!template id=plugin name=sparkline author="[[Joey]]"]]
2 [[!tag type/widget]]
3
4 This plugin provides the [[ikiwiki/directive/sparkline]]
5 [[ikiwiki/directive]], which allows for easily embedding sparklines into
6 wiki pages. A sparkline is a small word-size graphic chart, that is designed
7 to be displayed alongside text.
8
9 # requirements
10
11 The plugin uses the [Sparkline PHP Graphing Library](http://sparkline.org/)
12 as it has better output than the native perl sparkline library. Therefore,
13 to use the plugin, you will need:
14
15 * The Sparkline PHP Graphing Library, installed in php's path so that
16   php can find it when `sparkline/Sparkline.php` is required.
17 * The GD PHP module used by the Sparkline library.
18 * A "php" program in the path, that can run standalone php programs.
19 * [[!cpan Digest::SHA1]]
20
21 On a Debian system, this can be accomplished by installing these packages:
22 `libsparkline-php` `php5-gd` `php5-cli` `libdigest-sha1-perl`