Extension:MMHandler

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
MMHandler
Release status: beta
Implementation Tag
Description Displays FreeMind MindMaps as flash or java applet with full navigation
Author(s) Vitaliy Filippov
Latest version r2 (2015-10-14)
MediaWiki 1.18+
License GNU General Public License 2.0 or later
Download
Example FreeMind wiki
Translate the MMHandler extension if it is available at translatewiki.net
Check usage and version matrix.

The MMHandler extension allows to handle FreeMind/FreePlane mindmap files (*.mm).

Installation[edit]

FreeMind must be installed for this extension to work.
  • Download and place the file(s) in a directory called MMHandler in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/MMHandler/MMHandler.php";
    
  • Configure your wiki to allow the usage of .mm-files - see $wgFileExtensions.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage[edit]

Do not upload .mm files with spaces as the plugin apparently can't parse for spaces in file names.

1. To embed a freemind mind map file which has been uploaded to this wiki, use:

<mm>[[Hello.mm]]</mm> 

2. You can specify if you want to display the map in the flash browser or in the java applet

<mm>[[Hello.mm|flash]]</mm>
<mm>[[Hello.mm|applet]]</mm>

The flash viewer is smaller and starts much faster than the applet viewer. For this reason do not use both flash and applet on the same wiki page, but choose the one you find the best.

3. You can display the map in a separate page by adding a colon in front of the file name:

<mm>[[:Hello.mm]]</mm>
<mm>[[:Hello.mm|description]]</mm>
<mm>[[:Hello.mm|applet]]</mm>

4. Embed map in flash (with height)

<mm>[[Hello.mm|flash|80pt]]</mm>

5. Embed map in flash without title (with height and collapsed to level 1)

<mm>[[Hello.mm|flash|notitle|80pt|parameters startCollapsedToLevel=1]]</mm>

6. Embed map in applet (with height and title)

<mm>[[Hello.mm|applet|150px|title example map]]</mm>

7. Link to special page with the map in flash

<mm>[[:Hello.mm|flash]]</mm>
<mm>[[:Hello.mm|flash|title the map in flash|map in flash]]</mm>
<mm>[[:Hello.mm|flash|notitle|map in flash without title]]</mm>

8. Link to special page with the map in applet

<mm>[[:Hello.mm|applet]]</mm>
<mm>[[:Hello.mm|applet|title the map in applet|map in applet]]</mm>
<mm>[[:Hello.mm|applet|notitle|map in applet without title]]</mm>

9. Link to description page

[[:Image:Hello.mm]]
[[:Image:Hello.mm|Example map]]

10. Link directly to file

[[Media:Hello.mm]]
[[Media:Hello.mm|Example map]]

Advanced options[edit]

1. The full syntax for embedding an map in the wiki page is:

<mm>[[{name}|{options}|parameters {parameters}]]</mm>

2. The full syntax for displaying the map in the separate page is:

<mm>[[:{name}|{options}|parameters {parameters}|different text]]</mm>

3. The options can be zero or more of the following, separated by pipes:

applet, flash: Controls how the image is displayed,
{height}px: Sets the given height in pixels,
{height}pt: Sets the given height in points,
title {title text}:Displayed map caption also used as a reference to the map file.
notitle: Display no title and no reference.

The options can be given in any order.

The parameters can be zero or more of the {key}={value} pairs separated by spaces. They are transferred to the browser showing the map. Consult flash browser documentation as a mind map (http://freemind.sourceforge.net/wiki/extensions/freemind/flashBrowserDocu.html) for more info.

If a given option does not match any of the other possibilities, it is assumed to be the link text.

4. Embedding images in uploaded mind maps

If you want to include pictures in your map, they should be referenced by absolute paths to the images previoulsy iploaded to this site

  1. Upload the pictures first
  2. Every image in the FreeMind wiki becomes it own path. You can obtain it e.g. using wiki special page Special:Imagelist. All images listed there are linked to the image position e.g. http://freemind.sourceforge.net/wiki/images/0/00/Dothiepinscheme.gif
  3. Copy the links and insert them in your local mind map files.
  4. Check that the images are shown properly.
  5. Upload the mind map.

5. External images and map files

You can neither link to nor embed an external map. You can not embed a map including images located on external server.