git.sur5r.net Git - bacula/bacula/blob - gui/bacula-web/external_packages/phplot/README.txt

   1 This is the README file for PHPlot
   2 Last updated for PHPlot-5.2.0 on 2010-10-03
   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    COPYING  . . . . . . . . . . . . LGPL 2.1 License file
  22    ChangeLog  . . . . . . . . . . . Lists changes to the sources
  23    NEWS.txt . . . . . . . . . . . . Highlights changes in releases
  24    README.txt   . . . . . . . . . . This file
  25    contrib  . . . . . . . . . . . . "Contributed" directory, add-ons
  26    phplot.php   . . . . . . . . . . The main PHPlot source file
  27    rgb.inc.php  . . . . . . . . . . Optional extended color table
  28
  29
  30 REQUIREMENTS:
  31
  32 You need a recent version of PHP5, and you are advised to use the latest
  33 stable release.  This version of PHPlot has been tested with PHP-5.3.3 and
  34 PHP-5.2.14 on Linux, and with PHP-5.3.3 on Windows/XP.
  35
  36 Use of PHP-5.3.2 or PHP-5.2.13 is not recommended, if you are using
  37 TrueType Font (TTF) text. A bug with TTF rendering in those versions
  38 affects PHPlot images. This was fixed in PHP-5.3.3 and PHP-5.2.14.
  39
  40 You need the GD extension to PHP either built in to PHP or loaded as a
  41 module. Refer to the PHP documentation for more information - see the
  42 Image Functions chapter in the PHP Manual. We test PHPlot only with the
  43 PHP-supported, bundled GD library.
  44
  45 If you want to display PHPlot charts on a web site, you need a PHP-enabled
  46 web server. You can also use the PHP CLI interface without a web server.
  47
  48 PHPlot supports TrueType fonts, but does not include any TrueType font
  49 files.  If you want to use TrueType fonts on your charts, you need to have
  50 TrueType support in GD, and some TrueType font files.  By default, PHPlot
  51 uses a simple font which is built in to the GD library.
  52
  53
  54 INSTALLATION:
  55
  56 Unpack the distribution. (If you are reading this file, you have probably
  57 already done that.)
  58
  59 Installation of PHPlot simply involves copying two script files somewhere
  60 your PHP application scripts will be able to find them. The scripts are:
  61      phplot.php   - The main script file
  62      rgb.inc.php  - Optional large color table
  63 Make sure the permissions 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 #2919086 Improve tick interval calculations
  83   Tick interval calculations should try for intervals of 1, 2, or 5 times
  84   a power of 10.
  85
  86 PHP Issues:
  87
  88   PHP has many build-time and configuration options, and these can affect
  89 the operation of PHPlot (as well as any other application or library). Here
  90 are some known issues:
  91   + Slackware Linux includes a version of PHP built with --enable-gd-jis-conv
  92 (JIS-mapped Japanese font support). This prevents the usual UTF-8 encoding
  93 of characters from working in TrueType Font (TTF) text strings.
  94   + The Ubuntu Linux PHP GD package (php5-gd) was built to use the external
  95 shared GD library, not the one bundled with PHP. This can result in small
  96 differences in images, and some unsupported features (such as advanced
  97 truecolor image operations). Also, although this Ubuntu GD library was
  98 built with fontconfig support, PHP does not use it, so you still need to
  99 specify TrueType fonts with their actual file names.
 100   + Some PHP installations may have a memory limit set too low to support
 101 large images, especially truecolor images.
 102
 103
 104 If you think you found a problem with PHPlot, or want to ask questions or
 105 provide feedback, please use the Help and Discussion forum at
 106      http://sourceforge.net/projects/phplot/
 107 If you are sure you have found a bug, you can report it on the Bug tracker
 108 at the same web site. There is also a Features Request tracker.
 109
 110
 111 TESTING:
 112
 113 You can test your installation by creating the following two files somewhere
 114 in your web document area. First, the HTML file:
 115
 116 ------------ simpleplot.html ----------------------------
 117 <html>
 118 <head>
 119 <title>Hello, PHPlot!</title>
 120 </head>
 121 <body>
 122 <h1>PHPlot Test</h1>
 123 <img src="simpleplot.php">
 124 </body>
 125 </html>
 126 ---------------------------------------------------------
 127
 128 Second, in the same directory, the image file producing PHP script file.
 129 Depending on where you installed phplot.php, you may need to specify a path
 130 in the 'require' line below.
 131
 132 ------------ simpleplot.php -----------------------------
 133 <?php
 134 require 'phplot.php';
 135 $plot = new PHPlot();
 136 $data = array(array('', 0, 0), array('', 1, 9));
 137 $plot->SetDataValues($data);
 138 $plot->SetDataType('data-data');
 139 $plot->DrawGraph();
 140 ---------------------------------------------------------
 141
 142 Access the URL to 'simpleplot.html' in your web browser. If you see a
 143 simple graph, you have successfully installed PHPlot. If you see no
 144 graph, check your web server error log for more information.
 145
 146
 147 COPYRIGHT and LICENSE:
 148
 149 PHPlot is Copyright (C) 1998-2010 Afan Ottenheimer
 150
 151 This is free software; you can redistribute it and/or
 152 modify it under the terms of the GNU Lesser General Public
 153 License as published by the Free Software Foundation;
 154 version 2.1 of the License.
 155
 156 This software is distributed in the hope that it will be useful,
 157 but WITHOUT ANY WARRANTY; without even the implied warranty of
 158 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 159 Lesser General Public License for more details.
 160
 161 You should have received a copy of the GNU Lesser General Public
 162 License along with this software; if not, write to the Free Software
 163 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA