1 InstallWikiPluginCached
5 I don't know, tested it with the followings:
6 * WikiPluginCached needs
12 ** GNU Ghostscript 6.51
13 ** LaTex2HTML Version 99.2beta8 (1.43)
14 ** Perl >= 5.6.1 built for i586-linux
16 ** graphviz 1.8.x (http://www.graphviz.org/)
19 phpwiki comes with its own copy of PEAR::Cache.
20 You have to configure the PLUGINCACHED Pear/Cache Settings in config/config.ini
22 * set PLUGIN_CACHED_CACHE_DIR to a directory accessible by your apache user.
24 !!!Example Calls from Wiki
26 This produces a little help screen:
30 < ?plugin TexToPng tex="$x^2$" ?>
33 < ?plugin TexToPng tex="$$/int^/infty_{-/infty} dx {1 /over /sqrt {x^2+1}}$$" subslash="on" ?>
37 The available options for TexToPng are:
38 ;tex:TeX Commands (default: text mode), use $...$ for inline math formula style and $$...$$ for large formula style
39 ;img: image type (png, jpeg or gif), if chosen image type is not available use the first possible from png, gif, jpeg (in that order)
40 ;magstep: magnify image by (1.2 to the magstep)
41 ;subslash: substitute slashes by backslashes (to avoid the backslash bug of the database pear interface)
42 ;antialias: render ps to img with antialias option. This produces higher quality output but is slower and needs more disk space.
43 ;transparent: produce transparent background instead of white background. Seems to be buggy (in pstoimg - not my fault)
47 < ?plugin VisualWiki ?>
49 < ?plugin VisualWiki help="1" ?>
54 * VisualWiki and TexToPng use png image type for communication with
55 the image creating scripts (dot and pstoimg), so they rely on
56 CreateImageFronPNG(...)
57 * RecentChangesCached produces a strange RSS-link for the RSS-image
58 when it has to store a new html snippet in the cache immediately
59 after an edit/save cycle.
72 This extension of WikiPlugin replaces my old WikiPluginImageCache and allows to cache the following kinds of output:
75 ** example: [RecentChangesCached - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/RecentChangesCached_php] (RecentChanges with a 15 minutes caching interval)
77 ** example: [TexToPng - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/TexToPng_php] (TeX to image converter)
78 ** and [CacheTest - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/CacheTest_php] (simple example)
80 ** example: [VisualWiki - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/VisualWiki_php] (VisualWiki draws a graph of some [WikiPage]s showing their mutual linkage using [graphviz|http://www.graphviz.org]).
83 I used the following versions
85 * PEAR Cache 1.1 (needed files are included in the tar ball below)
89 ** Perl 5.6.1 built for i586-linux
90 ** GNU Ghostscript 6.51
91 ** LaTex2HTML Version 99.2beta8 (1.43)
93 ** graphviz 1.8.? (http://www.graphviz.org)
98 These files actually belong to WikiPluginCached
100 * [imagecache - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/imagecache_php] (fetches images from the cache)
101 * [WikiPluginCached - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/WikiPluginCached_php] (abstract class for cached [WikiPlugin]s)
102 * [plugincache-config - source|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/plugincache-config_php] (config file for the PEAR Cache)
106 [WikiPluginCached, Examples, and needed Pear Cache as tar.gz|http://amor.rz.hu-berlin.de/~h0444nmx/wiki/wikiplugincached.tar.gz]
109 * EITHER copy the tarball into your phpwiki directory and use
110 tar -xvzf wikiplugincached-0.8.tar.gz
111 * OR copy the following files manually:
112 ** imagecache.php ''into'' lib/imagecache.php
113 ** !WikiPluginCached.php ''into'' lib/!WikiPluginCached.php
114 ** plugincache-config.php ''into'' lib/plugincache-config.php
115 ** !TexToPng.php ''into'' lib/plugin/!TexToPng.php
116 ** !CacheTest.php ''into'' lib/plugin/!CacheText.php
117 ** !VisualWiki.php ''into'' lib/plugin/!VisualWiki.php
118 ** !RecentChangesCached.php ''into'' lib/plugin/!RecentChangesCached.php
119 ** Cache.php ''into'' lib/pear/Cache.php
120 ** Error.php ''into'' lib/pear/Cache/Error.php
121 ** Container.php ''into'' lib/pear/Cache/Container.php
122 ** file.php ''into'' lib/pear/Cache/Container/file.php
123 ** imgfile.php ''into'' lib/pear/Cache/Container/imgfile.php
124 * copy your own index.php config file into getimg.php and substitute the wiki start up instruction (to be found at the end of the file)
125 include "lib/main.php";
127 include "lib/imagecache.php";
128 * modify configuration file plugincache-config.php according to your wishes, %%%especially:
129 ** set 'cache_dir' to a directory accessible by your apache user.
130 ** set database to 'file'
131 ;;:''There is a hack which allows to let apache determine whether the image needs to be recreated. You have to include a symbolic link from your wiki dir to your cache dir and make the getimg.php file the 404 ErrorDocument. So whenever Apache tries to load an image not present in this dir, Apache will call the 404 (=file not found) ErrorDocument which creates the image on the fly. You have to use 'imgfile' as database entry in plugincache-config.php, though. Furthermore you have to replace the old value of 'cache_url' which should be '../getimg.php?' by '../path/to/cache'. Remember: This really is a hack because it needs my modified cache-filesystem-interface which is not part of the official pear distribution.''
134 At the moment, the source documentation is incomplete, but the example files should help a lot
138 * There is a bug in RecentChangesCached which scrambles the rss link during the first run.
139 * VisualWiki and TexToPng use png image type for communication with the image creating scripts (dot and pstoimg), so they rely on CreateImageFromPNG(...) which is not necessary.
144 WikiPlugin TexToPng VisualWiki