home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 April / CMCD0404.ISO / Software / Freeware / Programare / dotproject / lib / jpgraph / README < prev    next >
Text File  |  2002-12-11  |  9KB  |  224 lines
  1. Version: $Id: README,v 1.1 2002/12/11 09:41:57 kripper Exp $
  2.  
  3. README FOR JPGRAPH
  4. ==================
  5.  
  6. This is JpGraph 1.9.1 an Object Oriented PHP4 Graph Plotting library.
  7. The whole libray is Copyright (C) 2001,2002 Johan Persson and
  8. released under QPL 1.0
  9.  
  10. Included files
  11. --------------
  12. README                    This file
  13. QPL.txt                 QPL 1.0  Licensee
  14.  
  15. /src
  16.   Changelog               Changelog
  17.   jpgraph.php             Base library
  18.   jpgraph_log.php         Extension: logarithmic scales
  19.   jpgraph_line.php        Extension: line plots 
  20.   jpgraph_bar.php         Extension: bar plots
  21.   jpgraph_error.php       Extension: error plots
  22.   jpgraph_scatter.php     Extension: scatter/impuls plots
  23.   jpgraph_radar.php       Extension: radar plots
  24.   jpgraph_pie.php         Extension: pie plots
  25.   jpgraph_canvas.php      Extension: drawing canvas
  26.   jpgraph_canvtools.php      Extension: utility classes for working with canvas
  27.   jpgraph_pie3d.php      Extension: 3D pie plots
  28.   jpgraph_gantt.php      Extension: Gantt chart
  29.  
  30. /src/utils/misc        Various _unsupported_ small utilities to do 
  31.                         image manipulation, create background images
  32.                         and help create graphical DB schema.
  33.  
  34. /src/Examples        A directory with around 210 example graphs with source.
  35.             Run jpgraph_testsuit.php to get a list of all
  36.             files and you can easily click on a file to
  37.             see the code and the resulting image.
  38.         
  39. /docs/manual/html/    Manual
  40.  
  41. /docs/manual/ref/    Class reference
  42.  
  43.             
  44. Requirements:
  45. -------------
  46. Miminum:
  47. * PHP 4.04 or higher
  48. * GD 1.8.x or higher
  49.  
  50. Recommended:
  51. * PHP 4.2.2 
  52. * GD 1.8.x or higher
  53.  
  54. CAVEAT:
  55. To get background images working with GD 2.0.1 you MUST enable
  56. Truecolor images by setting the constant USE_TRUECOLOR to true. If you
  57. don't fo this the background images will just be a black rectangle.
  58. The bad thing with this is that the antialias for Truetypes is broken
  59. using truecolor images in GD 2.0.1. This means you can't have 
  60. background and TTF fonts in the same image.
  61.  
  62. You can find a bug fix for GD 2.01 and the TTF problem together
  63. with Truecolor images at
  64.  
  65.    http://www.coupin.net/gd-freetype/
  66.  
  67. NOTE: This bug fix has _nothing_ to do with JpGraph and I can't
  68. guarantee anything nor answer any questions regarding this 
  69. specific fix.
  70.  
  71.  
  72. Installation
  73. ------------
  74. 0. Make sure your PHP is AT LEAST 4.04 (preferrable 4.2.2) 
  75.    and that you have compiled support for GD library. 
  76.    You must make aboslutely sure that you have GD working. 
  77.    Please run phpinfo() to check if GD library
  78.    is supported in your installation. Please not that JpGraph only
  79.    fully supports GD 1.x. There are known issues with GD 2.0.1 as
  80.    described in CAVEAT 2 above.
  81.    
  82. 1. Unzip and copy the files to a directory of your choice.
  83.  
  84. 2. Set up the directory paths in jpgraph.php where the cache directory
  85.    should be and where your TTF directory is. Note that Apache/PHP must
  86.    have write permission in your cache directory. 
  87.  
  88. 4. Check that all rest of the DEFINE in the top of JpGraph.php 
  89.    is setup to your preference. The default should be fine
  90.    for most users. (See also Note 5. below)
  91.    Specifically check that the settings of USE_GD2_LIBRARY reflects
  92.    your installation, (should be true if you have GD2 installed,
  93.    false otherwise).
  94.    
  95. 3. Make sure PHP have write privileges to your cache directory if 
  96.    you plan on using the cache feature.
  97.  
  98. 4. Some windows installations seems to have a problem with a PHP
  99.    script ending in a newline (This newline seems to be sent to the
  100.    browser and will cause a Header already sent error). 
  101.    If you have this problem try remove all trailing newlines in the
  102.    jpgraph* files 
  103.  
  104. 5. It has been reported that PHP 4.06 under IIS has problem correctly
  105.    interpreting file paths. This can be solved by hardcoding the
  106.    CACHE_DIRECTORY and FONT_DIRECTORY const ants directly in the code
  107.    instead of using the defined constants. 
  108.  
  109. 6. Read (really!) the FAQ on http://www.aditus.nu/jpgraph/jpg_faq.php.
  110.  
  111.  
  112. Troubleshooting
  113. ---------------
  114. 1. Any PHP errors about function "imagecreate" does not exist indicates that
  115.    your PHP installation does not include the GD library. This must be present.
  116.  
  117. 2. Any error about "parent::" undefined means that you are not using PHP 4.02 or
  118.    above. You _NEED_ PHP 4.02 or higher. This problem has also been
  119.    reported to sometimes occur under Windows. This problem has also
  120.    been reported by people running Zend-cache and is a bug in Zend. A
  121.    workaround is to move all files into one single file.
  122.  
  123. 3. If you don't get any background images (but rather a solid black
  124.    box) you are using GD 2.x but have forgotten to enable truecolor
  125.    support. Correct this by enabling the USE_TRUECOLOR define.
  126.  
  127. 4. If background images does not work make sure the settings of 
  128.    USE_GD2_LIBRARY corresponds to your installation, i.e. If you
  129.    don't have GD2 then this define must be false!
  130.  
  131. 5. 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. 6. 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. 7. 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. 8. If you have problem building GD 2.0.1 for PHP you might want 
  151.    to try the following tip from Rasmus L.
  152.  
  153.    ----< QUOTE >----
  154.  
  155.    Build GD 2.0.1 with these two lines in your GD2 Makefile
  156.  
  157.    CFLAGS=-g -DHAVE_LIBPNG -DHAVE_LIBJPEG -DHAVE_LIBFREETYPE
  158.    LIBS=libgd.a -lpng -lz -ljpeg -freetype -lm
  159.  
  160.    Don't install the lib anywhere, just leave it in the GD-2.1.1
  161.    directory.
  162.  
  163.    Then build PHP using a minimum of:
  164.  
  165.    --with-gd=/home/<your_dir>/gd-2.0.1
  166.    --with-freetype-dir=/use
  167.    --enable-gd-native-ttf
  168.    --enable-gd-imgstrttf
  169.    --with-jpeg-dir=/usr
  170.    --with-png-dir=/usr
  171.    --with-xpm-dir=/usr/X11R6
  172.  
  173.    The above assumes you have freetype2 installed along with the
  174.    libjpeg and libpng libs under /usr
  175.  
  176.    ----< END QUOTE >----
  177.  
  178.  
  179. Known problem
  180. -------------
  181. 1. Image maps does not work with rotated images they assume that the
  182.    image is located at 0 degrees.
  183.  
  184. Bug reports and suggestions
  185. ---------------------------
  186. Should be sent to (jpgraph aditus nu) [insert at and dot]
  187.  
  188. Change history:
  189. ------------------------------------------------------------------------
  190. Date        Ver        Comment
  191. ------------------------------------------------------------------------
  192. 2002-10-30  1.9.1      Fixed glitch in 1.9
  193. 2002-10-25  1.9        TTF font change. Many small additional improvements
  194. 2002-09-17  1.8           Documentation update.
  195. 2002-09-09  1.8 BETA   Functional improvements.
  196. 2002-07-05  1.7        Functional improvements. Rotated bar graphs.
  197. 2002-06-17  1.7 BETA   Functional improvements.        
  198. 2002-05-15  1.6.3      Enhancements to Gantt graphs anbd minor bug fixes.
  199. 2002-04-19  1.6.2      Addition of image maps for line and scatter plot
  200. 2002-04-07  1.6.1      Bug fixes for 3D pies and image maps for pie's
  201. 2002-04-01  1.6           Functional improvments
  202. 2002-04-01  1.6 BETA   Beta candidate for 1.6
  203. 2002-03-01  1.5.3      Fix minor release problem in 1.5.2
  204. 2002-02-29  1.5.2      Minor bug fixes.
  205. 2002-02-11  1.5.1      Minor bug fixes.
  206. 2002-01-27  1.5           Functional improvements. Gantt charts.
  207. 2002-01-17  1.5-BETA2  Functional improvements, bug fixes
  208. 2001-12-16  1.5-BETA   Functional improvements, gantt-charts, bug fixes.
  209. 2001-11-12  1.4        Functional improvements, bug fixes.
  210. 2001-09-23  1.3.1      Minor bug fixes
  211. 2001-09-13  1.3        Major functional enhancements and minor bugfixes
  212. 2001-04-29  1.2.2      Minor bug fixes. Addded background image support 
  213. 2001-03-29  1.2.1      Minor bug fixes. Experimental support for 3D pie plots
  214. 2001-03-18  1.2        Second release see changes.txt
  215. 2001-02-18  1.1        Second release see changes.txt
  216. 2001-02-04  1.0        First public release
  217.  
  218. -------------------------------------------------------------------------
  219.  
  220. Stockholm/London 2002-10-30
  221. Johan Persson (jpgraph  aditus nu) [insert at and dot]
  222.  
  223. <EOF>
  224.