Date: Sat, 2 Aug 2008 14:15:24 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id: Help%2FPloticusPlugin,v 1.6 2008-08-03 16:30:46 vargenau Exp $
Content-Type: application/x-phpwiki;
  pagename=Help%2FPloticusPlugin;
  flags=PAGE_LOCKED;
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

The *Ploticus* plugin passes all its arguments to the ploticus
binary and displays the result as PNG, GIF, EPS, SVG, SVGZ or SWF.
Ploticus is a free, GPL, non-interactive software package
for producing plots, charts, and graphics from data.
See http://ploticus.sourceforge.net/doc/welcome.html

Ploticus uses a cache expire date of days.

!!! Usage
<verbatim>
  <?plugin Ploticus device||=png [ploticus options...]
     multiline ploticus script ...
  ?>
</verbatim>

or without any script: (not tested)

<verbatim>
<?plugin Ploticus -prefab vbars
	data=myfile.dat delim=tab y=1 
	clickmapurl="http://mywiki.url/wiki/?pagename=@2" 
	clickmaplabel="@3" -csmap 
?>
</verbatim>

TODO: ~PloticusSql - create intermediate data from SQL. Similar to [SqlResult|Help:SqlResultPlugin], 
just in graphic form.
For example to produce nice looking pagehit statistics or ratings statistics.
Ploticus has its own sql support within #getproc data, but this would expose security information.

!!! Arguments
__device__: |
  gif, png, jpeg, svg, svgz, eps, swf. Any -T parameter supported by ploticus. Default: png
__data__:  |
  optionally add data by <!plugin-list !> pagelist plugins.  See [WikiPlugin|Help:WikiPlugin]
__alt__:  |
  alt text for the image
__-prefab__:  |
  use the given prefab script (may need PLOTICUS_PREFABS)
__-csmap__:  |
  If a clickable map should be produced (not yet tested)
  passed to ploticus as -csmap -mapfile $tempfile.map 
__help__:  |
  Show a help screen

All other arguments are used as source to ploticus.

!!! Known Problems

For Windows you need either a gd library with GIF support or
a Ploticus with PNG support. This comes only with the Cygwin 
build so far.

!!! Optional Configuration

config.ini:
  PLOTICUS_EXE = pl.exe (on windows)
  PLOTICUS_EXE = /usr/local/bin/pl (elsewhere)

prefabs need the environment variable PLOTICUS_PREFABS. Default: /usr/share/ploticus.
Maybe also set by the config variable PLOTICUS_PREFABS.

See also [WikiPluginCached|Help:WikiPluginCached] options in config.ini.

!!! Examples

<?plugin Ploticus device||=png
#proc page
#if @DEVICE in gif,png
  scale: 0.7
#endif

//  specify data using {proc getdata}
#proc getdata
data:	Brazil 22
	Columbia 17
	"Costa Rica" 22
	Guatemala 3
	Honduras 12
	Mexico 14
	Nicaragua 28
	Belize 9
 	United\nStates 21
	Canada 8

//  render the pie graph using {proc pie}
#proc pie
firstslice: 90
explode: .2 0 0 0 0  .2 0
datafield: 2
labelfield: 1
labelmode: line+label
center: 4 4
radius: 2
colors: yellow pink pink pink pink yellow pink
labelfarout: 1.05
?>

The pie chart above was produced by this code from the ploticus
testsuite:

<verbatim>
<?plugin Ploticus device||=png alt="Sample Pie Chart"
#proc page
#if @DEVICE in gif,png
  scale: 0.7
#endif

//  specify data using {proc getdata}
#proc getdata
data:	Brazil 22
	Columbia 17
	"Costa Rica" 22
	Guatemala 3
	Honduras 12
	Mexico 14
	Nicaragua 28
	Belize 9
 	United\nStates 21
	Canada 8

//  render the pie graph using {proc pie}
#proc pie
firstslice: 90
explode: .2 0 0 0 0  .2 0
datafield: 2
labelfield: 1
labelmode: line+label
center: 4 4
radius: 2
colors: yellow pink pink pink pink yellow pink
labelfarout: 1.05
?>
</verbatim>


!!! Author
[Reini Urban|PhpWiki:ReiniUrban]

!!! See Also
Help:GraphVizPlugin
----
[PhpWikiDocumentation] [CategoryWikiPlugin]