DirectedGraphWebMapPlugin

Extends the DirectedGraphPlugin? and draws a map of a web, part of a web, or of the structure around a single topic.

Example: Main Web

This is a sample of a web drawn by DirectedGraphWebMapPlugin - the "Main" web in a default installation of TWiki.

As you will notice, most topics are clickable when touched by the mouse, through clientside areamaps. (Only Web* system topics are not linked).

Syntax Rules

• Place %WEBMAP% somewhere on the page to display a map of the entire web.
• %WEBMAP{web="web" excludesystem="1" lr="1"}%
  • optional web="web" gives a map of the given web. Default 'this web'.
  • optional excludesystem="1" ignore TWiki system topics (WebNotify and friends). Default OFF
  • optional lr="1" orient graph left to right. Default orient graph top to bottom
  • optional size="2,1" maximum size of graph in inches (92dpi). For i.e. a maximum of ~800x600 use "8.5,6.5"

• Place %TOPICMAP% somewhere on the page to display links for the given topic, to a given radius.
• %TOPICMAP{web="web" topic="topic" links="2" backlinks="1" excludesystem="1" lr="1"}%
  • optional web="web" gives a map of the given web. Default 'this web'.
  • optional topic="topic" gives a map of the given topic. Default 'this topic'.
  • optional links="number" set the length of chain linking FROM the given topic. If not given, then take LINKS plugin setting, then 2.
  • optional backlinks="number" set the length of chain linking TO the given topic. If not given then take links then BACKLINKS plugin setting, then LINKS plugin setting, then 1.
  • optional excludesystem="1" ignore TWiki system topics (WebNotify and friends). Default OFF
  • optional lr="1" orient graph left to right. Default orient graph top to bottom
  • optional size="2,1" maximum size of graph in inches (92dpi). For i.e. a maximum of ~800x600 use "8.5,6.5"

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 = Directed Graph of (part of) a web
• Default forward links to display (2 if not set here)
  • Set LINKS = 2
• Default backward links to display (1 if not set here)
  • Set BACKLINKS = 1
• Default maximum size of graph, in inches (8.5,6.5 if not set here, translates to ~800x600 pixels)
  • Set SIZE = 8.5,6.5
• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

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.

• Make sure that TWiki:Plugins/DirectedGraphPlugin is installed and working properly

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

  File:	Description:
  data/TWiki/DirectedGraphWebMapPlugin.txt	Plugin topic
  lib/TWiki/Plugins/DirectedGraphWebMapPlugin.pm	Plugin Perl module
  lib/TWiki/Plugins/DirectedGraphWebMapPlugin/sample.png	Sample WebMap
  lib/TWiki/Plugins/DirectedGraphWebMapPlugin/SampleMainWebMap.png	Sample WebMap

• (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:

• Verbatim:
  %TOPICMAP{links="1"}%

• Simulated:
  

• Plugin:
  %TOPICMAP{links="1"}%

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.MagnusLewisSmith - 04 Jul 2005