cogXWiki Platform - Wiki Manager - API
TypeJAR
Developed by

XWiki Development Team

Active Installs29
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise Manager

Installable with the Extension Manager

Description

Since XWiki 5.3, this API was replaced with a new API backing the new Wiki Application, which has the same features but also improve the way we manage subwikis. You should consider using it if you're developping new code or refactoring old code. This API is still available for installation in order to ensure functioning of older applications developped using the old APIs. 

Current features :

  • create empty wiki
  • create wiki from template wiki
  • create wiki from xar package
  • delete wiki

For now HSQLDB, Derby and Postgre are not fully supported. You will have to use MySQL or Oracle databases engines.

Dependencies

The Wiki Manager Plugin depends on the Application Manager Plugin.

This plugin is mostly written to be used by the Wiki Manager Application.

Usage

Since 3.3

The plugin way of accessing the API is still valid if you registered the plugin in xwiki.cfg but the recommended way is now

{{velocity}}
$services.wikimanager
{{/velocity}}

Before 3.3

You can access the plugin API using

{{velocity}}
$xwiki.wikimanager
{{/velocity}}

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.


You have to make sure the xwiki.virtual property is set to xwiki.virtual=1 in the xwiki.cfg file.

Since 3.3

  • Add the JAR in your container classpath (WEB-INF/lib)

Before 3.3

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>.

The <plugin name> for Wiki Manager is wikimanager.

Dependencies

Tags:
Created by ThomasMortagne on 2007/09/19 17:14
    

Get Connected