lib/MECON/Graph/external/jpgraph/src/utils/Readme

   1 Ver: $Id: Readme,v 1.7 2003/05/30 20:06:06 aditus Exp $
   2
   3 Utility directory with a few _COMPLETELY_ UNSUPPORTED utilities.
   4 They are only made available due to some requests.
   5
   6 Summary
   7 =======
   8 Most of the file in this directory form the basis of the JpGraph
   9 internal documentation system as used to generate the class reference.
  10 It works very well for us in our environment but it might completely
  11 fail in your setup.
  12
  13 Directory ./misc
  14 ----------------
  15
  16 adjimg.php
  17         Lets you adjust the contrast, brightness and saturation
  18         in a image.
  19         Usage:adjimg.php?file=name&[b=value][&c=value][&s=scale][&sat=saturation]
  20
  21 gencolorchart.php
  22         Generates a color chart with all colors available in
  23         JpGraph
  24
  25 mkgrad.php
  26         A tool to easily generate gradient images for use as backgounds
  27
  28 imgdbschema.inc
  29         A set of utility classes used to easy generate DB schema reading the
  30         data straight from the DB.
  31
  32
  33 Directory ./jpdocgen
  34 --------------------
  35 This directory contains all the scripts that make up the DDDA
  36 documentation architecture that is used to generate the database
  37 based documentation architecture used for JpGraph. This is completely
  38 generic and could be used for any PHP project which needs to combine
  39 both automtic and manual documentation.
  40
  41 The main entry point is jpdocedit.php
  42
  43
  44 jpdb.php
  45         An OO interface to a MySQL database.
  46
  47 jplintphp.php
  48         A very rudimentary "lint" and parser for PHP which parses
  49         a valid PHP file and extracts funtions, variables and classes.
  50         It also checks for unused class variables and missing
  51         '$this->' Used as a base library for extracting class and method
  52         information in jpgendb.php. This contains generic classes which
  53         are meant to be overridden.
  54
  55 jplintdriver.php
  56         A simple driver for the parser in jplintphp.php you invoke
  57         this with a URL variable 'target' which is set to the file
  58         you would like to parse. This could be considered as a test
  59         harness for jplintphp.php
  60
  61 jpgendoc.php
  62         A "fancy" version of jplintdriver.php which applies some
  63         formatting to generate a nice template to do reference
  64         documentation for a PHP script file. Again, this could be
  65         considered a proof of concept of the basic design of the
  66         jplintphp.php
  67
  68 jpgendb.php
  69         Read one or several PHP file and add classes and methods
  70         to database. The classes to populate the DB from source
  71         are normally instantiated from jpgendoc.php and this
  72         script is not meant to be called directly.
  73
  74 jpdbdelclass.php
  75         Safely delete a class from the database. Some extra safety
  76         features built in to avoid greaf.
  77
  78 jpclassref.php
  79         Basic framework to read information from DB and generate
  80         indexed documentation. This is a framework which needs
  81         a "formatter" plugin which does the actual formatting
  82         of the data, see jpgenhtmldoc.php for a simple implementation
  83         of a HTML formatter plugin.
  84
  85 jpgenhtmldoc.php
  86         Basic formatter plugin + driver to generate a HTML based
  87         documentation from the information stored in the DB. The
  88         generation of documentation is normally initialted from
  89         jpdocgen.php
  90
  91 de_utils.php
  92         A number of utility classes which are used throughout the
  93         DDDA architecture.
  94
  95 jpd_editclass.php
  96         Main form to edit DB data for a class
  97
  98 jpd_editmethod.php
  99         Main form to edit DB data for methods
 100
 101 jpd_editproject.php
 102         Main form to edit project meta data
 103
 104 jpdocedit.php
 105         Main entry point for the DDDA architecture. Opens the main
 106         meny and lets the user work and update different projects as
 107         well as presenting statictics on the various projects.
 108
 109 <EOF>
 110
 111
 112
 113