
README FOR PROFESSIONAL JPGRAPH
===============================
This is JpGraph 1.12 an Object Oriented PHP4 Graph Plotting library.
The whole libray is Copyright (C) 2001,2002,2003 Johan Persson and
released under QPL 1.0

To read all documentation point your favourite browser to 
docs/index.html 

Included files
--------------
README	                This file

/src
  Changelog               Changelog
  jpgraph.php             Base library
  jpgraph_log.php         Extension: logarithmic scales
  jpgraph_line.php        Extension: line plots 
  jpgraph_bar.php         Extension: bar plots
  jpgraph_error.php       Extension: error plots
  jpgraph_scatter.php     Extension: scatter/impuls plots
  jpgraph_radar.php       Extension: radar plots
  jpgraph_pie.php         Extension: pie plots
  jpgraph_canvas.php      Extension: drawing canvas
  jpgraph_canvtools.php	  Extension: utility classes for working with canvas
  jpgraph_pie3d.php	  Extension: 3D pie plots
  jpgraph_gantt.php	  Extension: Gantt chart
  jpgraph_stock.php       Extension: Stock charts
  jpgraph_regstat.php     Extension: Statistical utility classes

  imgdata_*.inc           Encoded image data for built-in images
  jprgaph_plotmark.inc    Internal module to handle plotmarks


/src/utils/misc		Various _unsupported_ small utilities to do 
                        image manipulation, create background images
                        and help create graphical DB schema.

/src/examples		A directory with around 210 example graphs with source.
			Run jpgraph_testsuit.php to get a list of all
			files and you can easily click on a file to
			see the code and the resulting image.
		
/docs/index.html        Index page for all documentation

			
Requirements:
-------------
Miminum:
* PHP 4.1 or higher
* GD 1.8.x or higher

Recommended:
* PHP 4.3.1 
* GD 2.11 or higher
Or:
* PHP 4.3.1 with budled GD library. 
  (Note: 4.3.1 has a minor bug in GD which causes text at an
  angle to be a few pixels off its correct position.)

Installation
------------
0. Make sure your PHP is at least 4.1 (preferrable 4.3.1) 
   and that you have compiled support for GD library. 
   You must make aboslutely sure that you have GD working. 
   Please run phpinfo() to check if GD library
   is supported in your installation.
   
1. Unzip and copy the files to a directory of your choice.

2. Verify that the default paths for Font and Cache directory
   suits your installation. 

3. Verify that the runtime parameters for the library at 
   top of jpgraph.php is setup to your preference. 
   The default values should suit most users. 
   
4. Make sure that the process running PHP have write privileges 
   to your cache directory if you have enabled the cache.
   The cache is disabled by default.

5. Read (really!) the FAQ on http://www.aditus.nu/jpgraph/jpg_faq.php.


A final note on GD library.
---------------------------
If you are using an older version of GD 2.x (2.07 or lower) you 
_really_ need to upgrade. 


Troubleshooting
---------------
1. Any PHP errors about function "imagecreate" does not exist indicates that
   your PHP installation does not include the GD library. This must be present.

2. Any error about "parent::" undefined means that you are not using PHP 4.1 or
   above. 
   This problem has also
   been reported by people running Zend-cache and is a bug in Zend. A
   workaround is to move all files into one single file.

3. If you don't get any background images (but rather a solid black
   box) you are using GD 2.x but have disabled truecolor
   support. Correct this by enabling the USE_TRUECOLOR define.

4. If you are running IIS and Win2k and get the error "Can't find
   font' when trying to use TTF fonts then try to change you paths
   to UNIX style, i.e. "/usr/local/fonts/ttf/". Remember that the
   path is absolute and not relative to the htdocs catalogue.

5. If you are using the cache please make sure that you have
   set the permissions correctly for the cache directory so that
   Apache/PHP can write to that directory.


Known problem
-------------
1. A bug in GD 2.08 makes text at an angle != 0 to be a few pixels
   if the expected position.


Bug reports and suggestions
---------------------------
Please report bugs at http://www.aditus.nu/bugtraq/
Comments and questions regarding jpgraph should be sent 
to support@aditus.nu

Change history:
------------------------------------------------------------------------
Date        Ver        Comment
------------------------------------------------------------------------
2003-04-06  1.12       Added polar and stock charts
2003-02-02  1.11       Added barcode module
2002-12-26  1.10       Functional improvements
2002-11-07  1.9p       Functional improvements
2002-10-30  1.9.1      Fixed glitch in 1.9
2002-10-25  1.9        TTF font change. Many small additional improvements
2002-09-17  1.8	       Documentation update.
2002-09-09  1.8 BETA   Functional improvements.
2002-07-05  1.7        Functional improvements. Rotated bar graphs.
2002-06-17  1.7 BETA   Functional improvements.        
2002-05-15  1.6.3      Enhancements to Gantt graphs anbd minor bug fixes.
2002-04-19  1.6.2      Addition of image maps for line and scatter plot
2002-04-07  1.6.1      Bug fixes for 3D pies and image maps for pie's
2002-04-01  1.6	       Functional improvments
2002-04-01  1.6 BETA   Beta candidate for 1.6
2002-03-01  1.5.3      Fix minor release problem in 1.5.2
2002-02-29  1.5.2      Minor bug fixes.
2002-02-11  1.5.1      Minor bug fixes.
2002-01-27  1.5	       Functional improvements. Gantt charts.
2002-01-17  1.5-BETA2  Functional improvements, bug fixes
2001-12-16  1.5-BETA   Functional improvements, gantt-charts, bug fixes.
2001-11-12  1.4        Functional improvements, bug fixes.
2001-09-23  1.3.1      Minor bug fixes
2001-09-13  1.3        Major functional enhancements and minor bugfixes
2001-04-29  1.2.2      Minor bug fixes. Addded background image support 
2001-03-29  1.2.1      Minor bug fixes. Experimental support for 3D pie plots
2001-03-18  1.2        Second release see changes.txt
2001-02-18  1.1        Second release see changes.txt
2001-02-04  1.0        First public release

-------------------------------------------------------------------------

Stockholm/London 2003-04-06
Johan Persson (jpgraph  aditus nu) [insert at and dot]

<EOF>
