Easily create and manage Spaces

Description

Features

The space manager plugin allows to easily create and manage Spaces. A Space is a XWiki object that defines properties for a wiki space (formerly known as wiki web), which properties are distinct from the one defined by XWiki.XWikiPreferences (although the Space object is also hosted in the space's WebPreferences document). This allows to add, when needed, an actual existence to wiki spaces beyond their documents and preferences.

The default properties defined by the standard Space are :

• A display name
• A description
• A type (to allow, for example, Space retrieving by type)
• A membership policy (open to join, or closed)
• A language

The plugin provides a extension mechanism that allows to easily extend this Space definition to define new custom types of spaces with any needed XWiki properties for the use case envisaged.

The plugin and its API also offers :

• Spaces creation, retrieving, archiving, and deletion facilities
• Members and admins group management for the space : easily add, retrieve and remove members and admins to/from the Space

Installation

Activate the plugin by following these steps:

• Copy the downloaded file int your WEB-INF/lib directory
• Edit your WEB-INF/xwiki.cfg file as follows below
• Restart your XWiki instance

xwiki.plugins=[...],com.xpn.xwiki.plugin.spacemanager.impl.SpaceManagerImpl

There are also additional parameters you can use to configure the plugin, which are optional :

xwiki.spacemanager.prefix=Space_
xwiki.spacemanager.mailnotification=1

Where :

• prefix will be the prefix of the wiki space names (webs) of your Spaces.
• mailnotifications activates the email notification on space creation and when a member join a space.

Documentation

You can download the javadoc of the plugin from here

Prerequisites & Installation Instructions

Follow these steps:

• Add the JAR in your container classpath (WEB-INF/lib)
• Edit xwiki.cfg and add the following line to the list of plugins :

  xwiki.plugins=\
        [...]
         ... ,\
        <plugin package>

• Restart your container
• Verify the plugin is properly installed by typing the following in a wiki page :

  {{velocity}}
  $xwiki.<plugin name>.name
  {{/velocity}}

  If the installation has been successful, you will see <plugin name>.

Release Notes

v1.1.1

See [The releases notes on JIRA>https://jira.xwiki.org/secure/ReleaseNote.jspa?version=10766&styleName=Text&projectId=10301]

v1.0.2

See [http://tinyurl.com/4adfuq]

v1.0

See https://jira.xwiki.org/secure/ReleaseNote.jspa?version=10512&styleName=Html&projectId=10301

v1.1

See https://jira.xwiki.org/secure/ReleaseNote.jspa?version=10648&styleName=Html&projectId=10301