]> git.sur5r.net Git - bacula/bacula/blobdiff - gui/bacula-web/external_packages/phplot/README.txt
bacula-web: Sync with Davide repos
[bacula/bacula] / gui / bacula-web / external_packages / phplot / README.txt
index fa81bcf42eea021d8c87548539f1566c84a9c969..7219f0b1c8c3b23c4b5f9a20743bb09fe9cf7ebd 100644 (file)
-This is the README file for PHPlot
-Last updated for PHPlot-5.3.1 on 2011-01-15
-The project web site is http://sourceforge.net/projects/phplot/
-The project home page is http://phplot.sourceforge.net/
------------------------------------------------------------------------------
-
-OVERVIEW:
-
-PHPlot is a PHP class for creating scientific and business charts.
-
-The release documentation contains only summary information. For more
-complete information, download the PHPlot Reference Manual from the
-Sourceforge project web site. You can also view the manual online at
-http://phplot.sourceforge.net
-
-For information about changes in this release, including any possible
-incompatibilities, see the NEWS.txt file.
-
-
-CONTENTS:
-
-   COPYING  . . . . . . . . . . . . LGPL 2.1 License file
-   ChangeLog  . . . . . . . . . . . Lists changes to the sources
-   NEWS.txt . . . . . . . . . . . . Highlights changes in releases
-   README.txt   . . . . . . . . . . This file
-   contrib  . . . . . . . . . . . . "Contributed" directory, add-ons
-   phplot.php   . . . . . . . . . . The main PHPlot source file
-   rgb.inc.php  . . . . . . . . . . Optional extended color table
-
-
-REQUIREMENTS:
-
-You need a recent version of PHP5, and you are advised to use the latest
-stable release.  This version of PHPlot has been tested with PHP-5.3.5 and
-PHP-5.2.17 on Linux, and with PHP-5.3.5 on Windows XP.
-
-Use of PHP-5.3.2 or PHP-5.2.13 is not recommended, if you are using
-TrueType Font (TTF) text. A bug with TTF rendering in those versions
-affects PHPlot images. This was fixed in PHP-5.3.3 and PHP-5.2.14.
-
-You need the GD extension to PHP either built in to PHP or loaded as a
-module. Refer to the PHP documentation for more information - see the
-Image Functions chapter in the PHP Manual. We test PHPlot only with the
-PHP-supported, bundled GD library.
-
-If you want to display PHPlot charts on a web site, you need a PHP-enabled
-web server. You can also use the PHP CLI interface without a web server.
-
-PHPlot supports TrueType fonts, but does not include any TrueType font
-files.  If you want to use TrueType fonts on your charts, you need to have
-TrueType support in GD, and some TrueType font files.  By default, PHPlot
-uses a simple font which is built in to the GD library.
-
-
-INSTALLATION:
-
-Unpack the distribution. (If you are reading this file, you have probably
-already done that.)
-
-Installation of PHPlot simply involves copying two script files somewhere
-your PHP application scripts will be able to find them. The scripts are:
-     phplot.php   - The main script file
-     rgb.inc.php  - Optional large color table
-Make sure the permissions on these files allow the web server to read them.
-
-The ideal place is a directory outside your web server document area,
-and on your PHP include path. You can add to the include path in the PHP
-configuration file; consult the PHP manual for details.
-
-
-KNOWN ISSUES:
-
-Here are some of the problems we know about in PHPlot. See the bug tracker
-on the PHPlot project web site for more information.
-
-#3142124 Clip plot elements to plot area
-  Plot elements are not currently clipped to the plot area, and may extend
-  beyond. PHP does not currently support the GD clipping control.
-
-#1795969 The automatic range calculation for Y values needs to be rewritten.  
-  This is especially a problem with small offset ranges (e.g. Y=[999:1001]).
-  You can use SetPlotAreaWorld to set a specific range instead.
-
-#1605558 Wide/Custom dashed lines don't work well
-  This is partially a GD issue, partially PHPlot's fault.
-
-#2919086 Improve tick interval calculations
-  Tick interval calculations should try for intervals of 1, 2, or 5 times
-  a power of 10.
-
-PHP Issues:
-
-  PHP has many build-time and configuration options, and these can affect
-the operation of PHPlot (as well as any other application or library). Here
-are some known issues:
-  + Slackware Linux includes a version of PHP built with --enable-gd-jis-conv
-(JIS-mapped Japanese font support). This prevents the usual UTF-8 encoding
-of characters from working in TrueType Font (TTF) text strings.
-  + The Ubuntu Linux PHP GD package (php5-gd) was built to use the external
-shared GD library, not the one bundled with PHP. This can result in small
-differences in images, and some unsupported features (such as advanced
-truecolor image operations). Also, although this Ubuntu GD library was
-built with fontconfig support, PHP does not use it, so you still need to
-specify TrueType fonts with their actual file names.
-  + Some PHP installations may have a memory limit set too low to support
-large images, especially truecolor images.
-
-
-If you think you found a problem with PHPlot, or want to ask questions or
-provide feedback, please use the Help and Discussion forum at
-     http://sourceforge.net/projects/phplot/
-If you are sure you have found a bug, you can report it on the Bug tracker
-at the same web site. There is also a Features Request tracker.
-
-
-TESTING:
-
-You can test your installation by creating the following two files somewhere
-in your web document area. First, the HTML file:
-
------------- simpleplot.html ----------------------------
-<html>
-<head>
-<title>Hello, PHPlot!</title>
-</head>
-<body>
-<h1>PHPlot Test</h1>
-<img src="simpleplot.php">
-</body>
-</html>
----------------------------------------------------------
-
-Second, in the same directory, the image file producing PHP script file.
-Depending on where you installed phplot.php, you may need to specify a path
-in the 'require' line below.
-
------------- simpleplot.php -----------------------------
-<?php
-require 'phplot.php';
-$plot = new PHPlot();
-$data = array(array('', 0, 0), array('', 1, 9));
-$plot->SetDataValues($data);
-$plot->SetDataType('data-data');
-$plot->DrawGraph();
----------------------------------------------------------
-
-Access the URL to 'simpleplot.html' in your web browser. If you see a
-simple graph, you have successfully installed PHPlot. If you see no
-graph, check your web server error log for more information.
-
-
-COPYRIGHT and LICENSE:
-
-PHPlot is Copyright (C) 1998-2011 Afan Ottenheimer
-
-This is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation;
-version 2.1 of the License.
-
-This software is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this software; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+This is the README file for PHPlot\r
+Last updated for PHPlot-5.3.1 on 2011-01-15\r
+The project web site is http://sourceforge.net/projects/phplot/\r
+The project home page is http://phplot.sourceforge.net/\r
+-----------------------------------------------------------------------------\r
+\r
+OVERVIEW:\r
+\r
+PHPlot is a PHP class for creating scientific and business charts.\r
+\r
+The release documentation contains only summary information. For more\r
+complete information, download the PHPlot Reference Manual from the\r
+Sourceforge project web site. You can also view the manual online at\r
+http://phplot.sourceforge.net\r
+\r
+For information about changes in this release, including any possible\r
+incompatibilities, see the NEWS.txt file.\r
+\r
+\r
+CONTENTS:\r
+\r
+   COPYING  . . . . . . . . . . . . LGPL 2.1 License file\r
+   ChangeLog  . . . . . . . . . . . Lists changes to the sources\r
+   NEWS.txt . . . . . . . . . . . . Highlights changes in releases\r
+   README.txt   . . . . . . . . . . This file\r
+   contrib  . . . . . . . . . . . . "Contributed" directory, add-ons\r
+   phplot.php   . . . . . . . . . . The main PHPlot source file\r
+   rgb.inc.php  . . . . . . . . . . Optional extended color table\r
+\r
+\r
+REQUIREMENTS:\r
+\r
+You need a recent version of PHP5, and you are advised to use the latest\r
+stable release.  This version of PHPlot has been tested with PHP-5.3.5 and\r
+PHP-5.2.17 on Linux, and with PHP-5.3.5 on Windows XP.\r
+\r
+Use of PHP-5.3.2 or PHP-5.2.13 is not recommended, if you are using\r
+TrueType Font (TTF) text. A bug with TTF rendering in those versions\r
+affects PHPlot images. This was fixed in PHP-5.3.3 and PHP-5.2.14.\r
+\r
+You need the GD extension to PHP either built in to PHP or loaded as a\r
+module. Refer to the PHP documentation for more information - see the\r
+Image Functions chapter in the PHP Manual. We test PHPlot only with the\r
+PHP-supported, bundled GD library.\r
+\r
+If you want to display PHPlot charts on a web site, you need a PHP-enabled\r
+web server. You can also use the PHP CLI interface without a web server.\r
+\r
+PHPlot supports TrueType fonts, but does not include any TrueType font\r
+files.  If you want to use TrueType fonts on your charts, you need to have\r
+TrueType support in GD, and some TrueType font files.  By default, PHPlot\r
+uses a simple font which is built in to the GD library.\r
+\r
+\r
+INSTALLATION:\r
+\r
+Unpack the distribution. (If you are reading this file, you have probably\r
+already done that.)\r
+\r
+Installation of PHPlot simply involves copying two script files somewhere\r
+your PHP application scripts will be able to find them. The scripts are:\r
+     phplot.php   - The main script file\r
+     rgb.inc.php  - Optional large color table\r
+Make sure the permissions on these files allow the web server to read them.\r
+\r
+The ideal place is a directory outside your web server document area,\r
+and on your PHP include path. You can add to the include path in the PHP\r
+configuration file; consult the PHP manual for details.\r
+\r
+\r
+KNOWN ISSUES:\r
+\r
+Here are some of the problems we know about in PHPlot. See the bug tracker\r
+on the PHPlot project web site for more information.\r
+\r
+#3142124 Clip plot elements to plot area\r
+  Plot elements are not currently clipped to the plot area, and may extend\r
+  beyond. PHP does not currently support the GD clipping control.\r
+\r
+#1795969 The automatic range calculation for Y values needs to be rewritten.  \r
+  This is especially a problem with small offset ranges (e.g. Y=[999:1001]).\r
+  You can use SetPlotAreaWorld to set a specific range instead.\r
+\r
+#1605558 Wide/Custom dashed lines don't work well\r
+  This is partially a GD issue, partially PHPlot's fault.\r
+\r
+#2919086 Improve tick interval calculations\r
+  Tick interval calculations should try for intervals of 1, 2, or 5 times\r
+  a power of 10.\r
+\r
+PHP Issues:\r
+\r
+  PHP has many build-time and configuration options, and these can affect\r
+the operation of PHPlot (as well as any other application or library). Here\r
+are some known issues:\r
+  + Slackware Linux includes a version of PHP built with --enable-gd-jis-conv\r
+(JIS-mapped Japanese font support). This prevents the usual UTF-8 encoding\r
+of characters from working in TrueType Font (TTF) text strings.\r
+  + The Ubuntu Linux PHP GD package (php5-gd) was built to use the external\r
+shared GD library, not the one bundled with PHP. This can result in small\r
+differences in images, and some unsupported features (such as advanced\r
+truecolor image operations). Also, although this Ubuntu GD library was\r
+built with fontconfig support, PHP does not use it, so you still need to\r
+specify TrueType fonts with their actual file names.\r
+  + Some PHP installations may have a memory limit set too low to support\r
+large images, especially truecolor images.\r
+\r
+\r
+If you think you found a problem with PHPlot, or want to ask questions or\r
+provide feedback, please use the Help and Discussion forum at\r
+     http://sourceforge.net/projects/phplot/\r
+If you are sure you have found a bug, you can report it on the Bug tracker\r
+at the same web site. There is also a Features Request tracker.\r
+\r
+\r
+TESTING:\r
+\r
+You can test your installation by creating the following two files somewhere\r
+in your web document area. First, the HTML file:\r
+\r
+------------ simpleplot.html ----------------------------\r
+<html>\r
+<head>\r
+<title>Hello, PHPlot!</title>\r
+</head>\r
+<body>\r
+<h1>PHPlot Test</h1>\r
+<img src="simpleplot.php">\r
+</body>\r
+</html>\r
+---------------------------------------------------------\r
+\r
+Second, in the same directory, the image file producing PHP script file.\r
+Depending on where you installed phplot.php, you may need to specify a path\r
+in the 'require' line below.\r
+\r
+------------ simpleplot.php -----------------------------\r
+<?php\r
+require 'phplot.php';\r
+$plot = new PHPlot();\r
+$data = array(array('', 0, 0), array('', 1, 9));\r
+$plot->SetDataValues($data);\r
+$plot->SetDataType('data-data');\r
+$plot->DrawGraph();\r
+---------------------------------------------------------\r
+\r
+Access the URL to 'simpleplot.html' in your web browser. If you see a\r
+simple graph, you have successfully installed PHPlot. If you see no\r
+graph, check your web server error log for more information.\r
+\r
+\r
+COPYRIGHT and LICENSE:\r
+\r
+PHPlot is Copyright (C) 1998-2011 Afan Ottenheimer\r
+\r
+This is free software; you can redistribute it and/or\r
+modify it under the terms of the GNU Lesser General Public\r
+License as published by the Free Software Foundation;\r
+version 2.1 of the License.\r
+\r
+This software is distributed in the hope that it will be useful,\r
+but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\r
+Lesser General Public License for more details.\r
+\r
+You should have received a copy of the GNU Lesser General Public\r
+License along with this software; if not, write to the Free Software\r
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\r