root/trunk/flowmon-web/charts/phplot-5.0.5/README.txt

Revision 1, 5.0 kB (checked in by ixs, 16 years ago)

initial checkin of RH revision

Line 
1 This is the README file for PHPlot
2 Last updated for PHPlot-5.0.5 on 2008-01-13
3 The project web site is http://sourceforge.net/projects/phplot/
4 The project home page is http://phplot.sourceforge.net/
5 -----------------------------------------------------------------------------
6
7 OVERVIEW:
8
9 PHPlot is a PHP class for creating scientific and business charts.
10
11 The release documentation contains only summary information. For more
12 complete information, download the PHPlot Reference Manual from the
13 Sourceforge project web site. You can also view the manual online at
14 http://phplot.sourceforge.net
15
16 For important changes in this release, see the NEWS.txt file.
17
18
19 CONTENTS:
20
21    ChangeLog  . . . . . . . . . . . Lists changes to the sources
22    LICENSE.GPL  . . . . . . . . . . License file
23    LICENSE.PHP_3_0  . . . . . . . . License file
24    NEWS.txt . . . . . . . . . . . . Highlights changes in releases
25    README.txt   . . . . . . . . . . This file
26    phplot.php   . . . . . . . . . . The main PHPlot source file
27    phplot_data.php  . . . . . . . . Auxiliary and extended functions
28    rgb.inc.php  . . . . . . . . . . Optional extended color table
29
30
31 REQUIREMENTS:
32
33 You need a recent version of PHP5, and you are advised to use the latest
34 stable release.  This version of PHPlot has been tested with PHP-5.2.5.
35 (PHPlot-5.0.5 does not support PHP4, since the PHP group has discontinued
36 support for PHP4.)
37
38 You need the GD extension to PHP either built in to PHP or loaded as a
39 module. Refer to the PHP documentation for more information - see the
40 Image Functions chapter in the PHP Manual. We test PHPlot only with the
41 PHP-supported, bundled GD library.
42
43 If you want to display PHPlot charts on a web site, you need a PHP-enabled
44 web server. You can also use the PHP CLI interface without a web server.
45
46 PHPlot supports TrueType fonts, but does not include any TrueType font
47 files.  If you want to use TrueType fonts on your charts, you need to have
48 TrueType support in GD, and some TrueType font files.  By default, PHPlot
49 uses a simple font built-in to the GD library.
50
51
52 INSTALLATION:
53
54 Unpack the distribution. (If you are reading this file, you have probably
55 already done that.)
56
57 Installation of PHPlot simply involves copying three script files somewhere
58 your PHP application scripts will be able to find them. The scripts are:
59      phplot.php
60      phplot_data.php
61      rgb.inc.php
62 (Only phplot.php is necessary for most graphs.)
63 Make sure the protections on these files allow the web server to read them.
64
65 The ideal place is a directory outside your web server document area,
66 and on your PHP include path. You can add to the include path in the PHP
67 configuration file; consult the PHP manual for details.
68
69
70 KNOWN ISSUES:
71
72 Here are some of the problems we know about in PHPlot. See the bug tracker
73 on the PHPlot project web site for more information.
74
75 #1795969 The automatic range calculation for Y values needs to be rewritten. 
76   This is especially a problem with small offset ranges (e.g. Y=[999:1001]).
77   You can use SetPlotAreaWorld to set a specific range instead.
78
79 #1605558 Wide/Custom dashed lines don't work well
80   This is partially a GD issue, partially PHPlot's fault.
81
82 #1795972 and #1795971: Default data colors and default point shapes need to
83   be improved.
84
85 Tick interval calculations should try for intervals of 1, 2, or 5 times a
86 power of 10.
87
88
89 If you think you found a problem with PHPlot, or want to ask questions or
90 provide feedback, please use the Help forum at
91      http://sourceforge.net/projects/phplot/
92 If you are relatively sure you have found a bug, you can report it on the
93 bug tracker at the same web site.
94
95
96
97 TESTING:
98
99 You can test your installation by creating the following two files somewhere
100 in your web document area. First, the HTML file:
101
102 ------------ simpleplot.html ----------------------------
103 <html>
104 <head>
105 <title>Hello, PHPlot!</title>
106 </head>
107 <body>
108 <h1>PHPlot Test</h1>
109 <img src="simpleplot.php">
110 </body>
111 </html>
112 ---------------------------------------------------------
113
114 Second, in the same directory, the image file producing PHP script file.
115 Depending on where you installed phplot.php, you may need to specify a path
116 in the 'require' line below.
117
118 ------------ simpleplot.php -----------------------------
119 <?php
120 require 'phplot.php';
121 $plot = new PHPlot();
122 $data = array(array('', 0, 0), array('', 1, 9));
123 $plot->SetDataValues($data);
124 $plot->SetDataType('data-data');
125 $plot->DrawGraph();
126 ---------------------------------------------------------
127
128 Access the URL to 'simpleplot.html' in your web browser. If you see a
129 simple graph, you have successfully installed PHPlot. If you see no
130 graph, check your web server error log for more information.
131
132
133 COPYRIGHT and LICENSE:
134
135 PHPlot is Copyright (C) 1998-2008 Afan Ottenheimer
136
137 This is distributed with NO WARRANTY and under the terms of the GNU GPL
138 and PHP licenses. If you use it - a cookie or some credit would be nice.
139
140 You can get a copy of the GNU GPL at http://www.gnu.org/copyleft/gpl.html
141 You can get a copy of the PHP License at http://www.php.net/license.html
142
143 See http://sourceforge.net/projects/phplot/ for the latest information.
Note: See TracBrowser for help on using the browser.