Display a dynamic map of your wiki pages and tags

Description

The Just Map It! application for XWiki allows you to insert an interactive map of your wiki pages and tags in the page of your choice.
This application is composed of the following packages:

• A XAR file that contains the Main.JMIPage wiki page with a macro "jmimap" and a Flash client
• A REST service extension that exposes a wiki space tags and pages in a way that is understandable by the Just Map It! server

How does it work

The macro adds the Just Map It! Flash client on a wiki page with the given parameters.
When a user asks for a page that contains the map, the Flash client calls a Just Map It! server. This server is located at the url that is provided in the serverurl parameter. Then, the Just Map It! server queries the XWiki REST Service to get the necessary data. The map is generated and sent to the Flash client.

Licence

The code of the macro and the REST service are provided under the GNU LGPL v2.1 licence. The flash client however is closed source and copyrighted to Social Computing. It is provided freely to XWiki users as an attachement of the JMIPage contained in the XAR package for demos and non commercial use only. Social Computing disclaims any warranty or SLA around this package that is provided "as is" to the XWiki community.

Screenshots

Usage

• Display a map of all the wiki pages:

{{velocity}}
{{jmimap serverurl="http://server.just-map-it.com" width="1024" height="600" planname="xwikirest" xwikiurl="[Host]/xwiki/rest/wikis/xwiki/sc/tags?media=json" xwikilogin="login" xwikipassword="password"/}}
{{/velocity}}

• Display a map of tags, centered on a specific tag:

{{velocity}}
#set($tag = "$!{request.get('tag')}")
{{jmimap serverurl="http://server.just-map-it.com" planname="xwikitagsrest" analysisprofile="DiscoveryProfile" attributeid="$tag" xwikiurl="[Host]/xwiki/rest/wikis/xwiki/sc/tags?media=json" xwikilogin="login" xwikipassword="password"/}}
{{/velocity}}

Replace the [Host] part in the xwikiurl parameter by your XWiki host url.
The login and password are the one that protect the REST service access.

Macro parameters

• serverurl
  Location of the Just Map It! server. You should use the default value: http://server.just-map-it.com.

• planname
  Name of the map configuration to use. Two configurations are available:
  • xwikirest: create a map of the wiki pages linked by the tags
  • xwikitagsrest: create a map of the tags linked by the wiki pages where they are assigned

• width and height
  Dimension of the map in pixels.

• analysisprofile
  This parameter can take 3 values
  • GlobalProfile: global map not centered on one specific item
  • AnalysisProfile: when the map is focused on links between the wiki pages (planname = xwikirest), the generated map will highlight the node element with the id that is set in the entityid parameter.
  • DiscoveryProfile: when the map is focused on links between the wiki pages (planname = xwikirest), the generated map will highlight the link element with the id that is set in the attibuteid parameter.

• Login and password

Authentication information required to access the XWiki REST service. Leave them blank if they are not needed.

InformationWe provide a freely accessible Just Map It! server at http://server.just-map-it.com that is hosted on a cloud plateform.
However, we do not give any warranty on this server performance, response time or availablity.
If you want to display a high number of maps or have a high number of users on your wiki and you need some SLA,
please contact us by mail at [email protected] or visit our website http://feeds.just-map-it.com/ and click on contact.

Prerequisites & Installation Instructions

XAR extension

1. Log in the wiki with a user having Administrative rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions

REST Service

1. Download the xwiki-rest-map.jar package
2. Copy the downloaded file in your xwiki installation folder under the xwiki/WEB-INF/lib folder
3. Restart your application server
4. (Optional) Add an user that has enough rights to call the service for the desired wiki space