Version: $Id: README,v 1.4 2002/02/11 13:08:54 aditus Exp $

README FOR JPGRAPH
==================

This is JpGraph 1.5.2 an Object Oriented PHP4 Graph Plotting library.
The library is released under GPL 2.0. See COPYING for details 
about this license.

The whole libray is Copyright (C) 2001,2002 Johan Persson and
released under GPL 2.0

Included files
--------------
README	                This file
COPYING                 GPL 2.0  Licensee

/image_gallery		Point your browser to index.html in this 
			directoryt to have a quick view on images
			from the examples in ./src/Examples

/src
  Changelog               Changelog for JpGraph
  Todo			  ToDo list for future releases
  jpgraph.php             Base library
  jpgraph_dir.php         Directory paths for 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_spider.php      Extension: spider (Web) plots
  jpgraph_pie.php         Extension: pie plots
  jpgraph_canvas.php      Extension: drawing canvas
  jpgraph_pie3d.php	  Extension: 3D pie plots
  jpgraph_gantt.php	  Extension: Gantt chart

/src/utils/
  gencolorchart.php     Unsupported utility to generate a sample color
			chart of all named colors
  adjimg.php		Unsupported utility to change
			contrast/brightness for an image.
  jplintphp.php		Unsupported base library to parse PHP files
  jplintdriver.php	Simply driver for running lint over a file and 
			warns for unused instance variables and
			possible forgotten $this->
  jpgendoc.php		Extended driver which uses jplintphp base 
			library to generate a HTML template for a
			class reference.

/src/Examples		A directory with over 80 example graphs.
			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.
			
			
Requirements:
-------------
* PHP 4.02 or higher
* GD 1.8.x, Experimental support for GD 2.x

CAVEAT 1: 
JpGraph is developed under Unix and is known to work well.
Please note that you may or may not encounter some known 
issues when trying to run on PHP/Apache/Windows or a 
combination of PHP/IIS. See below.

CAVEAT 2:
To get background images working with GD 2.0.1 you MUST enable
Truecolor images by setting the constant USE_TRUECOLOR to true. If you
don't fo this the background images will just be a black rectangle.
The bad thing with this is that the antialias for Truetypes is broken
using truecolor images in GD 2.0.1. This means you can't have 
background and TTF fonts in the same image.

Installation
------------
0. Make sure your PHP is AT LEAST 4.02 (preferrable 4.1.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. Please not that JpGraph only
   fully supports GD 1.x. There are known issues with GD 2.0.1.
   
1. Unzip and copy the files to a directory of your choice.

2. Set up the directory paths in jpgraph_dir.php where the cache directory
   should be and where your TTF directory is. Note that Apache/PHP must
   have write permission in your cache directory. 

   Caveat: On windows there seems to be some problem with including
   this file and you might have to move all the defines directly into
   jpgraph.php. If you get an error saying "Font not found" and you
   have specified the correct font path try the above mentioned
   workaround.  (See also paragraph 5 below)
   
4. Check that all rest of the DEFINE in the top of JpGraph.php 
   is setup to your preference. The default should be fine
   for most users. (See also Note 5. below)
   
3. Make sure PHP have write privileges to your cache directory.

4. Some windows installations seems to have a problem with a PHP
   script ending in a newline (This newline seems to be sent to the
   browser and will cause a Header already sent error). 
   If you have this problem try remove all trailing newlines in the
   jpgraph* files 

5. It has been reported that PHP 4.06 under IIS has problem correctly
   interpreting file paths. This can be solved by hardcoding the
   CACHE_DIRECTORY and FONT_DIRECTORY const ants directly in the code
   instead of using the defined constants. 

6. Read the FAQ on http://www.aditus.nu/jpgraph/jpg_faq.php.

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.02 or
   above. You _NEED_ PHP 4.02 or higher. This problem has also been
   reported to sometimes occur under Windows. 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 black
   background) you are most likely using GD 2.x which
   is not yet supported. JpGraph has only been verified with GD 1.x

4. If you are running PHP 4.06 and get an error saying "GD was not
   built with truetype support" you should know that this is a known
   problem with GD+PHP 4.06. There are some workarounds (search the
   net!) but it is really recommended that you instead upgrade to at least
   PHP 4.1.1 and configure PHP with --with-gd-native-ttf 
   (Please also note that the built in TTF uses point size for fonts
   whereas Truetype 2 uses pixels.)
   Please DON't ask me how to resolve the GD Font problem. All mail
   regarding this will go straight to /dev/null. Upgrade to 4.1.1!

5. 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.

6. 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.


Documentation
-------------
The latest documentation, both on-line, and off-line may be found at
http://www.aditus.nu/jpgraph/

Bug reports and suggestions
---------------------------
Should be sent to (jpgraph aditus nu) [insert at and dot]

Change history:
------------------------------------------------------------------------
Date        Ver        Comment
------------------------------------------------------------------------
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 2002-02-29
Johan Persson (jpgraph aditus nu) [insert at and dot]

<EOF>











