FreeMindPlugin
The FreeMindPlugin implements the
%FREEMIND% variable 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 |
Examples
%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.
%FREEMIND{ mindMap="https://twiki.org/p/pub/Plugins/FreeMindPlugin/Wiki.mm" width="200" height="200"}%
Plugin Settings
Plugin settings are stored as preferences variables. To reference a plugin setting write
%<plugin>_<setting>%
, i.e.
%FREEMINDPLUGIN_SHORTDESCRIPTION%
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Render FreeMind mind maps in TWiki topics
- Debug plugin: (See output in data/debug.txt)
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.
- 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