[Sommaire] [Imprimer]

   1  Version: $Id: README 18250 2005-05-07 14:13:43Z ralfbecker $
   2  
   3  README FOR JPGRAPH
   4  ==================
   5  
   6  This is JpGraph 1.5.2 an Object Oriented PHP4 Graph Plotting library.
   7  The library is released under GPL 2.0. See COPYING for details 
   8  about this license.
   9  
  10  The whole libray is Copyright (C) 2001,2002 Johan Persson and
  11  released under GPL 2.0
  12  
  13  Included files
  14  --------------
  15  README                    This file
  16  COPYING                 GPL 2.0  Licensee
  17  
  18  /image_gallery        Point your browser to index.html in this 
  19              directoryt to have a quick view on images
  20              from the examples in ./src/Examples
  21  
  22  /src
  23    Changelog               Changelog for JpGraph
  24    Todo              ToDo list for future releases
  25    jpgraph.php             Base library
  26    jpgraph_dir.php         Directory paths for base library
  27    jpgraph_log.php         Extension: logarithmic scales
  28    jpgraph_line.php        Extension: line plots 
  29    jpgraph_bar.php         Extension: bar plots
  30    jpgraph_error.php       Extension: error plots
  31    jpgraph_scatter.php     Extension: scatter/impuls plots
  32    jpgraph_spider.php      Extension: spider (Web) plots
  33    jpgraph_pie.php         Extension: pie plots
  34    jpgraph_canvas.php      Extension: drawing canvas
  35    jpgraph_pie3d.php      Extension: 3D pie plots
  36    jpgraph_gantt.php      Extension: Gantt chart
  37  
  38  /src/utils/
  39    gencolorchart.php     Unsupported utility to generate a sample color
  40              chart of all named colors
  41    adjimg.php        Unsupported utility to change
  42              contrast/brightness for an image.
  43    jplintphp.php        Unsupported base library to parse PHP files
  44    jplintdriver.php    Simply driver for running lint over a file and 
  45              warns for unused instance variables and
  46              possible forgotten $this->
  47    jpgendoc.php        Extended driver which uses jplintphp base 
  48              library to generate a HTML template for a
  49              class reference.
  50  
  51  /src/Examples        A directory with over 80 example graphs.
  52              Run jpgraph_testsuit.php to get a list of all
  53              files and you can easily click on a file to
  54              see the code and the resulting image.
  55              
  56              
  57  Requirements:
  58  -------------
  59  * PHP 4.02 or higher
  60  * GD 1.8.x, Experimental support for GD 2.x
  61  
  62  CAVEAT 1: 
  63  JpGraph is developed under Unix and is known to work well.
  64  Please note that you may or may not encounter some known 
  65  issues when trying to run on PHP/Apache/Windows or a 
  66  combination of PHP/IIS. See below.
  67  
  68  CAVEAT 2:
  69  To get background images working with GD 2.0.1 you MUST enable
  70  Truecolor images by setting the constant USE_TRUECOLOR to true. If you
  71  don't fo this the background images will just be a black rectangle.
  72  The bad thing with this is that the antialias for Truetypes is broken
  73  using truecolor images in GD 2.0.1. This means you can't have 
  74  background and TTF fonts in the same image.
  75  
  76  Installation
  77  ------------
  78  0. Make sure your PHP is AT LEAST 4.02 (preferrable 4.1.1) 
  79     and that you have compiled
  80     support for GD library. You must make aboslutely sure that you
  81     have GD working. Please run phpinfo() to check if GD library
  82     is supported in your installation. Please not that JpGraph only
  83     fully supports GD 1.x. There are known issues with GD 2.0.1.
  84     
  85  1. Unzip and copy the files to a directory of your choice.
  86  
  87  2. Set up the directory paths in jpgraph_dir.php where the cache directory
  88     should be and where your TTF directory is. Note that Apache/PHP must
  89     have write permission in your cache directory. 
  90  
  91     Caveat: On windows there seems to be some problem with including
  92     this file and you might have to move all the defines directly into
  93     jpgraph.php. If you get an error saying "Font not found" and you
  94     have specified the correct font path try the above mentioned
  95     workaround.  (See also paragraph 5 below)
  96     
  97  4. Check that all rest of the DEFINE in the top of JpGraph.php 
  98     is setup to your preference. The default should be fine
  99     for most users. (See also Note 5. below)
 100     
 101  3. Make sure PHP have write privileges to your cache directory.
 102  
 103  4. Some windows installations seems to have a problem with a PHP
 104     script ending in a newline (This newline seems to be sent to the
 105     browser and will cause a Header already sent error). 
 106     If you have this problem try remove all trailing newlines in the
 107     jpgraph* files 
 108  
 109  5. It has been reported that PHP 4.06 under IIS has problem correctly
 110     interpreting file paths. This can be solved by hardcoding the
 111     CACHE_DIRECTORY and FONT_DIRECTORY const ants directly in the code
 112     instead of using the defined constants. 
 113  
 114  6. Read the FAQ on http://www.aditus.nu/jpgraph/jpg_faq.php.
 115  
 116  Troubleshooting
 117  ---------------
 118  1. Any PHP errors about function "imagecreate" does not exist indicates that
 119     your PHP installation does not include the GD library. This must be present.
 120  
 121  2. Any error about "parent::" undefined means that you are not using PHP 4.02 or
 122     above. You _NEED_ PHP 4.02 or higher. This problem has also been
 123     reported to sometimes occur under Windows. This problem has also
 124     been reported by people running Zend-cache and is a bug in Zend. A
 125     workaround is to move all files into one single file.
 126  
 127  3. If you don't get any background images (but rather a black
 128     background) you are most likely using GD 2.x which
 129     is not yet supported. JpGraph has only been verified with GD 1.x
 130  
 131  4. If you are running PHP 4.06 and get an error saying "GD was not
 132     built with truetype support" you should know that this is a known
 133     problem with GD+PHP 4.06. There are some workarounds (search the
 134     net!) but it is really recommended that you instead upgrade to at least
 135     PHP 4.1.1 and configure PHP with --with-gd-native-ttf 
 136     (Please also note that the built in TTF uses point size for fonts
 137     whereas Truetype 2 uses pixels.)
 138     Please DON't ask me how to resolve the GD Font problem. All mail
 139     regarding this will go straight to /dev/null. Upgrade to 4.1.1!
 140  
 141  5. If you are running IIS and Win2k and get the error "Can't find
 142     font' when trying to use TTF fonts then try to change you paths
 143     to UNIX style, i.e. "/usr/local/fonts/ttf/". Remember that the
 144     path is absolute and not relative to the htdocs catalogue.
 145  
 146  6. If you are using the cache please make sure that you have
 147     set the permissions correctly for the cache directory so that
 148     Apache/PHP can write to that directory.
 149  
 150  
 151  Documentation
 152  -------------
 153  The latest documentation, both on-line, and off-line may be found at
 154  http://www.aditus.nu/jpgraph/
 155  
 156  Bug reports and suggestions
 157  ---------------------------
 158  Should be sent to (jpgraph aditus nu) [insert at and dot]
 159  
 160  Change history:
 161  ------------------------------------------------------------------------
 162  Date        Ver        Comment
 163  ------------------------------------------------------------------------
 164  2002-02-29  1.5.2      Minor bug fixes.
 165  2002-02-11  1.5.1      Minor bug fixes.
 166  2002-01-27  1.5           Functional improvements. Gantt charts.
 167  2002-01-17  1.5-BETA2  Functional improvements, bug fixes
 168  2001-12-16  1.5-BETA   Functional improvements, gantt-charts, bug fixes.
 169  2001-11-12  1.4        Functional improvements, bug fixes.
 170  2001-09-23  1.3.1      Minor bug fixes
 171  2001-09-13  1.3        Major functional enhancements and minor bugfixes
 172  2001-04-29  1.2.2      Minor bug fixes. Addded background image support 
 173  2001-03-29  1.2.1      Minor bug fixes. Experimental support for 3D pie plots
 174  2001-03-18  1.2        Second release see changes.txt
 175  2001-02-18  1.1        Second release see changes.txt
 176  2001-02-04  1.0        First public release
 177  
 178  -------------------------------------------------------------------------
 179  
 180  Stockholm/London 2002-02-29
 181  Johan Persson (jpgraph aditus nu) [insert at and dot]
 182  
 183  <EOF>
 184  
 185  
 186  
 187  
 188  
 189  
 190  
 191  
 192  
 193  
 194