lib/MLIB/Graph/external/jpgraph/README

   1 README FOR JPGRAPH
   2 ==================
   3
   4 This is JpGraph 1.13 an Object Oriented PHP4 Graph Plotting library.
   5
   6 The libray is Copyright (C) 2001,2002,2003 Johan Persson and
   7 released under dual license QPL 1.0 for open source and educational
   8 use amd JpGraph Professional License for commercial use.
   9
  10 Please see full license details at http://www.aditus.nu/jpgraph/
  11
  12 Included files
  13 --------------
  14 README                  This file
  15 QPL.txt                 QPL 1.0  Licensee
  16
  17 /src
  18   Changelog               Changelog
  19   jpgraph.php             Base library
  20   jpgraph_log.php         Extension: logarithmic scales
  21   jpgraph_line.php        Extension: line plots
  22   jpgraph_bar.php         Extension: bar plots
  23   jpgraph_error.php       Extension: error plots
  24   jpgraph_scatter.php     Extension: scatter/impuls plots
  25   jpgraph_radar.php       Extension: radar plots
  26   jpgraph_pie.php         Extension: pie plots
  27   jpgraph_canvas.php      Extension: drawing canvas
  28   jpgraph_canvtools.php   Extension: utility classes for working with canvas
  29   jpgraph_pie3d.php       Extension: 3D pie plots
  30   jpgraph_gantt.php       Extension: Gantt chart
  31   jpgraph_regstat.php     Extension: Statistics and cubic splines.
  32   jpgraph_stock.php       Extension: Stock and box plots.
  33   jpgraph_gradient.php    Extension: Color gradient class
  34   jpgraph_gb2312.php      Extension: Chinese GB2312 to Unicode translation
  35   jpgraph_plotmark.php    Extension: Handle plotmarks in plots
  36   jpgraph_polar.php       Extension: Polar plot extension
  37   jpgraph_flags.php       Extension: Country flags
  38   imgdata_*.inc           Extension: Encoded images for plot marks
  39   flags*.dat              Image data: Pre-compiled data for country flags.
  40
  41 /src/utils/misc         Various _unsupported_ small utilities to do
  42                         image manipulation, create background images
  43                         and help create graphical DB schema.
  44
  45 /src/utils/jpdocgen     DDDA architecture to produce JpGraph class reference
  46
  47 /src/Examples           A directory with around 215 example graphs with source.
  48                         Run jpgraph_testsuit.php to get a list of all
  49                         files and you can easily click on a file to
  50                         see the code and the resulting image.
  51
  52 /docs/index.html        Documentation portal
  53
  54
  55 Requirements:
  56 -------------
  57 Miminum:
  58 * PHP 4.1 or higher
  59 * GD 1.8.x or higher
  60
  61 Recommended:
  62 * PHP 4.3.2
  63 * GD 2.12 or builtin GD
  64
  65 CAVEAT:
  66 To get background images working with GD 2.0.1 you MUST enable
  67 Truecolor images by setting the constant USE_TRUECOLOR to true. If you
  68 don't fo this the background images will just be a black rectangle.
  69 The problem with this is that the antialias for Truetype font
  70 is broken using truecolor images in GD 2.0.1. This means you can't have
  71 background and TTF fonts in the same image with GD 2.01.
  72
  73 By upgrading to the latest GD (2.08 as of this writing)y
  74 ou will fix this problem.
  75
  76 Installation
  77 ------------
  78 0. Make sure your PHP is AT LEAST 4.1 (preferrable 4.3.1)
  79    and that you have compiled support for GD library.
  80    You must make aboslutely sure that you have GD working.
  81    Please run phpinfo() to check if GD library
  82    is supported in your installation. If you don't have the GD library
  83    please consult the PHP manual under section "Image" for
  84    instructions on where to find this library.
  85
  86 1. Unzip and copy the files to a directory of your choice.
  87
  88 2. Check that the default directory paths in jpgraph.php
  89    for cache directory and TTF directory suits your installation.
  90    Note1: The default directories are different depending on if
  91    the library is running on Windows or UNIX.
  92    Note2: Apache/PHP must have write permission to your cache
  93    directory.
  94
  95 3. Check that all rest of the DEFINE in the top of JpGraph.php
  96    is setup to your preference. The default should be fine
  97    for most users. (See also Note 5. below)
  98
  99 4. Make sure PHP have write privileges to your cache directory if
 100    you plan on using the cache feature.
 101
 102 5. Read (really!) the FAQ on http://www.aditus.nu/jpgraph/jpg_faq.php.
 103
 104
 105 Troubleshooting
 106 ---------------
 107 1. Any error about "parent::" undefined means that you are not using
 108    PHP 4.02 or above. You _NEED_ PHP 4.02 or higher.
 109    This problem has also been
 110    reported to sometimes occur under Windows. This problem has also
 111    been reported by people running Zend-cache and is a bug in Zend. A
 112    workaround is to move all files into one single file.
 113
 114 2. If you don't get any background images (but rather a solid black
 115    box) you are using GD 2.x but have forgotten to enable truecolor
 116    support. Correct this by enabling the USE_TRUECOLOR define.
 117
 118 3. If background images does not work make sure the settings of
 119    USE_GD2_LIBRARY corresponds to your installation, i.e. If you
 120    don't have GD2 then this define must be false!
 121
 122 4. If you are running PHP 4.06 and get an error saying "GD was not
 123    built with truetype support" you should know that this is a known
 124    problem with GD+PHP 4.06. There are some workarounds (search the
 125    net!) but it is really recommended that you instead upgrade to at least
 126    PHP 4.1.1 and configure PHP with --with-gd-native-ttf
 127    (Please also note that the built in TTF uses point size for fonts
 128    whereas Truetype 2 uses pixels.)
 129    Please DON't ask me how to resolve the GD Font problem. All mail
 130    regarding this will go straight to /dev/null. Upgrade to 4.1.1!
 131
 132 5. If you are running IIS and Win2k and get the error "Can't find
 133    font' when trying to use TTF fonts then try to change you paths
 134    to UNIX style, i.e. "/usr/local/fonts/ttf/". Remember that the
 135    path is absolute and not relative to the htdocs catalogue. Some
 136    versions of GD for Windows also need you to set the environment
 137    variable GDFONTPATH for GD to find the fonts.
 138
 139 6. If you are using the cache please make sure that you have
 140    set the permissions correctly for the cache directory so that
 141    Apache/PHP can write to that directory.
 142
 143 7. If you have problem building GD 2.0.1 for PHP you might want
 144    to try the following tip from Rasmus L.
 145
 146    ----< QUOTE >----
 147
 148    Build GD 2.0.1 with these two lines in your GD2 Makefile
 149
 150    CFLAGS=-g -DHAVE_LIBPNG -DHAVE_LIBJPEG -DHAVE_LIBFREETYPE
 151    LIBS=libgd.a -lpng -lz -ljpeg -freetype -lm
 152
 153    Don't install the lib anywhere, just leave it in the GD-2.1.1
 154    directory.
 155
 156    Then build PHP using a minimum of:
 157
 158    --with-gd=/home/<your_dir>/gd-2.0.1
 159    --with-freetype-dir=/use
 160    --enable-gd-native-ttf
 161    --enable-gd-imgstrttf
 162    --with-jpeg-dir=/usr
 163    --with-png-dir=/usr
 164    --with-xpm-dir=/usr/X11R6
 165
 166    The above assumes you have freetype2 installed along with the
 167    libjpeg and libpng libs under /usr
 168
 169    ----< END QUOTE >----
 170
 171 8. Some windows installations seems to have a problem with a PHP
 172    script ending in a newline (This newline seems to be sent to the
 173    browser and will cause a Header already sent error).
 174    If you have this problem try remove all trailing newlines in the
 175    jpgraph* files
 176
 177
 178 Bug reports and suggestions
 179 ---------------------------
 180 Should be sent to (jpgraph aditus nu) [insert at and dot]
 181
 182 Change history:
 183 ------------------------------------------------------------------------
 184 Date        Ver        Comment
 185 ------------------------------------------------------------------------
 186 2003-08-24  1.13BETA2  Very Minor update before official test release
 187 2003-08-19  1.13BETA   Improved Gantt graphs various other changes and bug fixes
 188 2003-02-02  1.11       Stock charts and some minor oter changes.
 189 2002-12-16  1.10       Alpha blending, cubic splines and field plots
 190 2002-10-30  1.9.1      Fixed two stupid mistakes in 1.9
 191 2002-10-25  1.9        TTF font change. Many small additional improvements
 192 2002-09-17  1.8        Documentation update.
 193 2002-09-09  1.8BETA    Functional improvements.
 194 2002-07-05  1.7        Functional improvements. Rotated bar graphs.
 195 2002-06-17  1.7BETA    Functional improvements.
 196 2002-05-15  1.6.3      Enhancements to Gantt graphs anbd minor bug fixes.
 197 2002-04-19  1.6.2      Addition of image maps for line and scatter plot
 198 2002-04-07  1.6.1      Bug fixes for 3D pies and image maps for pie's
 199 2002-04-01  1.6        Functional improvments
 200 2002-04-01  1.6BETA    Beta candidate for 1.6
 201 2002-03-01  1.5.3      Fix minor release problem in 1.5.2
 202 2002-02-29  1.5.2      Minor bug fixes.
 203 2002-02-11  1.5.1      Minor bug fixes.
 204 2002-01-27  1.5        Functional improvements. Gantt charts.
 205 2002-01-17  1.5BETA2   Functional improvements, bug fixes
 206 2001-12-16  1.5BETA    Functional improvements, gantt-charts, bug fixes.
 207 2001-11-12  1.4        Functional improvements, bug fixes.
 208 2001-09-23  1.3.1      Minor bug fixes
 209 2001-09-13  1.3        Major functional enhancements and minor bugfixes
 210 2001-04-29  1.2.2      Minor bug fixes. Addded background image support
 211 2001-03-29  1.2.1      Minor bug fixes. Experimental support for 3D pie plots
 212 2001-03-18  1.2        Second release see changes.txt
 213 2001-02-18  1.1        Second release see changes.txt
 214 2001-02-04  1.0        First public release
 215
 216 -------------------------------------------------------------------------
 217
 218 Stockholm/London 2003-08-24
 219 Johan Persson (jpgraph aditus nu) [insert at and dot]
 220
 221 <EOF>