The
FreeMindPlugin implements the
%FREEMIND% tag to render
FreeMind mindmaps from a Twiki topic. It requires Adobe's flash player plugin to run from the browser. FreeMind is open-source, "free" graphical mind-mapping software written in Java.
Syntax
%FREEMIND{ mindMap="pathToMindMap.mm" <optional attributes>}
Attribute |
Description |
Required |
mindMap |
specify the mindmap (.mm file) to display |
Yes |
width |
specify the display area width in pixels or percentage |
No |
height |
specify the display area height in pixels or percentage |
No |
Example
%FREEMIND{ mindMap="%ATTACHURL%/Wiki.mm" width="200" height="200"}}%
This example uses %ATTACHURL% to locate a mindmap file attached to the same page.
If this plugin is installed, you will see the sample mindmap displayed via flash player.
Flash plugin or Javascript are turned off.
Activate both and reload to view the mindmap
Settings
FreeMindPlugin settings are stored as preferences variables. To reference a plugin setting, write %FreeMindPlugin_<setting>%, e.g. %FreeMindPlugin_SHORTDESCRIPTION%
Installation
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 TWiki server.
- Download the ZIP file from the Plugin Home (see below)
- Unzip FreeMindPlugin.zip in your twiki installation directory. Content:
File: |
Description: |
data/TWiki/FreeMindPlugin.txt |
Plugin topic |
data/TWiki/FreeMindPlugin.txt,v |
Plugin topic repository |
lib/TWiki/Plugins/FreeMindPlugin.pm |
Plugin Perl module |
pub/TWiki/FreeMindPlugin/swfobject.js |
SWFobject, a flash player loader |
pub/TWiki/FreeMindPlugin/expressInstall.swf |
Adobe flash player installer |
pub/TWiki/FreeMindPlugin/Wiki.mm |
sample FreeMind mindmap |
pub/TWiki/FreeMindPlugin/visorFreemind.swf |
Flash application to render mindmaps |
- Configure the Plugin:
- TWiki 4.0 and up: run the configure script to enable the Plugin
- Change the Plugin settings as needed
- If successful, the example mindmap on your local copy of topic FreeMindPlugin, will render in your browser.
Plugin Info
Related Topics:
TWikiPlugins,
DeveloperDocumentationCategory,
AdminDocumentationCategory,
TWikiPreferences
%TOPICCREATE{ template="Plugins.PluginDevTemplate" topic="FreeMindPluginDev" disable="NewPluginTemplate" parameters="pluginName=FreeMindPlugin&RelatedTopics=FreeMindPlugin,
FreeMindPluginAppraisal" }% %TOPICCREATE{ template="Plugins.PluginAppraisalTemplate" topic="FreeMindPluginAppraisal" disable="NewPluginTemplate" parameters="RelatedTopics=FreeMindPlugin,
FreeMindPluginDev" }% --
TWiki:Main.JohnPoplett - 01 Dec 2008