/[drupal]/contributions/modules/sparkline/INSTALL.txt
ViewVC logotype

Contents of /contributions/modules/sparkline/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.5 - (show annotations) (download)
Tue Mar 31 18:02:20 2009 UTC (7 months, 3 weeks ago) by chris
Branch: MAIN
CVS Tags: HEAD
Changes since 1.4: +3 -1 lines
File MIME type: text/plain
#394084.  Updated README and INSTALL documentation, many thanks to Andrew Berry (http://drupal.org/user/71291).
1 INSTALL REQUIREMENTS
2 --------------------
3 1. Requires the PHP binary to have been built with the GD library, which is
4 used by the PHP Sparkline library for generating the sparklines images. A
5 version is included with this module as it requires some changes to not
6 conflict with Drupal functions.
7
8 INSTALL PROCEDURE
9 -----------------
10
11 1. Enable module from admin interface.
12 2. Make sure the temporary image path is valid and working (default will probably be ok).
13
14 USAGE
15 -----
16 After enabling the module, you'll need to do a couple of other things.
17
18 Go into your input formats and enable the sparkline filter, if you want to use the filtered format you outlined above.
19
20 Then to use the filter, you create a node (blog, story, etc.) using one of the input formats for which the sparkline filter has been enabled. A sample sparkline embedded into such a posting might be like this:
21
22 Fish caught this year by month:
23 [sparkline style=bar height=15 0,0,0,4,25,33,12,18,10,0,0,19]
24
25 That's how the filter feature is used.
26
27 If you want to display dynamic data, such as from a database or feed, you'll need to write some PHP code, probably in your own module. The sparkline module exposes an application programming interface (API) to the sparkline library which you can call to generate sparklines.

  ViewVC Help
Powered by ViewVC 1.1.2