TouchGraphPlugin

This plugin supports browsing your TWiki webs by visualizing it as a TWiki:Codev.TouchGraph.

The plugin is based on TWiki:Plugins/TouchGraphAddOn but instead of a standalone java app with its own HTML browser, TouchGraphPlugin provides a popup window containing an applet.

Advantages:

• no need to install anything but a Java Runtime on the clients.
• interacts with standard, full featured browsers instead of Java HTML component.

Syntax Rules

• Insert %TGPOPUP% where you'd like to have a link to a popup window containing the applet, i. e. in the WEBTOPICLIST of your webs WebPreferences.

You can still use the unmodified standalone TGWikiBowser as well e. g. from the command line:

java -jar /path/to/p/pub/TWiki06x01/TouchGraphPlugin/TGWikiBrowser.jar \ 
 https://twiki.org/p/pub/Plugins/touchgraph.txt \
 https://twiki.org/cgi-bin/view/Plugins/

Examples

Test it here: Graph .

The window popping up should resemble this.

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Displays the relations between topics of a web in a TouchGraph applet

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• You may redefine TGPOPUP to your needs.

      * Set TGPOPUP = <script>window.name = 'wiki'</script> <a target="wikigraph" onClick="open('%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=tglaunch', 'wikigraph', 'titlebar=0,width=500,height=600,resizable=no,scrollbars=no'); return false" href="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=tglaunch title="The topology of the topics in this web (java applet)">Graph</a> 

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip TouchGraphPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/TouchGraphPlugin.txt	Plugin topic
  data/TWiki/TouchGraphPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/TouchGraphPlugin.pm	Plugin Perl module (almost empty)
  bin/tgdb	database generator for the TouchGraphBrowser
  data/TWiki/TouchGraphAppletInstructions.txt	howto use the applet
  pub/TWiki/TouchGraphPlugin/TGWikiBrowser.jar	applet code
  pub/TWiki/TouchGraphPlugin/touchgraph_applet.png	screenshot
  pub/TWiki/TouchGraphAppletInstructions/kill.png	icon for the applets stop button
  templates/view.tglaunch.tmpl	special skin for popup window

• Edit your crontab to schedule /path/to/twiki/bin/tgdb like mailnotify, e. g.:
  4,19,34,49 * * * * cd /path/to/twiki/bin; ./tgdb > /dev/null

• You'll get an applet error unless you have run tgdb once.

Plugin Info

Plugin Author:	TWiki:Main/ChristopherHuhn
Plugin Version:	03 Mar 2004 (V1.000)
Change History:
08 Jul 2004:	Made TGWikiBrowser.java work with https connections
04 Mar 2004:	Bug fix for tgdb
03 Mar 2004:	Initial version
CPAN Dependencies:	none
Other Dependencies:	Java Runtime Environment / Java Plugin - tested with 1.4
Perl Version:	5.005
TWiki:Plugins/Benchmark:	GoodStyle nn%, FormattedSearch nn%, TouchGraphPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/TouchGraphPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TouchGraphPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TouchGraphAddOn

-- TWiki:Main/ChristopherHuhn - 03 Mar 2004