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

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