The XWiki Contrib Project provides hosting for projects related to XWiki. These projects are not part of the official XWiki distributions and are not maintained by the XWiki development team.

Contrib Project List

The full list projects is available on the xwiki-contrib user on GitHub.

Project NameWhat is it?
CurrikiOpen Source Curriculum Sharing and Editing based on the XWiki Platform.
XWiki OfficeMS Office Integration.
XWiki EclipseRemote/offline browsing of XWiki data in a standalone application or as an Eclipse plugin.

Hosting tools

The project hosting forge can provide contributors with some or all of the following tools :

  • A GitHub repository, under
  • A JIRA project for tracking bugs and feature requests, at and under the "XWiki Contributed projects" category. Note that there will be a generic JIRA project to be used by all projects till they  achieve a first release or till they grow to a size significant enough to warrant a dedicated JIRA project
  • A generic maven groupId: org.xwiki.contrib.<module name> (until the project reaches a certain size and visibility, in which case it can have its own maven group id). For example: org.xwiki.contrib.mailarchive.
  • Project pages on to describe and document the project. When the project reaches a certain visibility and size it can have its own wiki on

Requesting a project

The contrib project is open for anyone with a project that request it. Simply send us an email at devs AT using "[Contrib]" at the beginning of your email's subject. Let us know the name and a short description of your project. If your project has already been made available for download on, please precise it and point us to its page (If it is not, then no need to hurry, you will make it available once it's ready). Finally, let us know which of the listed tools you need. For GitHub access, you will need to register a user on and let us know about it (a best practice is to have a username composed of the first letter of your first name immediately followed by your last name, the whole with no capital letter, for example jdoe if your name is John Doe).

Requesting snapshost builds for your project has a continuous build which builds maven projects each time they are modified on GitHub and put the resulting artifact in our snapshots repository. This is useful when you want people using your project as a dependency to continuously benefit from the improvements.

Your can ask for your project to be added to the continuous build:

  • First you need to use the xwiki parent pom to have the correct distribution management information:
  • Send a vote on the [email protected] mailing list to discuss the addition of your project in the continuous build
    [VOTE] Add myproject to the continuous build

    Hi XWikiers,

    I'm working on myproject and since it's used as a
    dependency by someotherproject it'd be convenient
    if it was built continuously.

    Here's my +1.


Release the project allows you to release your project on its maven repository as long as you follow the following steps:

  • Use org.xwiki.contrib as groupId in your maven module
  • Request for an account on on [email protected]
  • Once you've received your credentials put them in ~/.m2/settings.xml
  • Put the following configuration in your project pom.xml
       <developerConnection>scm:git:[email protected]:xwiki-contrib/{extensionrepository}.git</developerConnection>
         <name>XWiki Staging Repository</name>

    Where {extensionrepository} is the name of the repository in

  • Release the project with the maven release plugin
    mvn release:prepare

In the recent versions of xwiki, we started signing the produced artifacts ( This helps downloaders check that indeed the binary is what was initially put in there, and was not replaced by an intruder.

The signing maven plugin is configured in the toplevel pom ( <groupId>org.xwiki.commons</groupId><artifactId>xwiki-commons</artifactId> ) so any module that's inheriting from that will have the gpg plugin configured by default. To find out, get the effective pom of your module ( mvn help:effective-pom ) and check if the gpg maven plugin is there (maven-gpg-plugin).

If you're gonna try to release like that, it will probably fail since the gpg plugin expects you to have a gnupg key with a password. You now have 2 options:

  • Overwrite the settings of the gpg plugin in your pom to disable signing
  • Configure your setup to sign properly. To do that, you will have to:
    • generate a gpg key which will be stored in your home folder and will be used by maven. On linux you can do that using the default gpg command (gpg --gen-key
      , read the man page if you want to know more about the options). On win and/or mac, you can use tools like GNUPG or GPGTools. If you don't know what to fill in for the options requested by the tool, keep the defaults.
    • Tell maven the passphrase of this key (the one you entered upon key generation), either in the command line when performing the release mvn release:perform -Darguments=-Dgpg.passphrase=PASSWORD or set it in your maven settings.xml like this

You're done now, you can go on releasing.

mvn release:perform
  • Note that you'll need to push the changes done by the release plugin: git push origin master
  • Ask for someone to promote your release (ie. make it available on in the thread you've created earlier
  • After that your release will be available for download on and anyone will be able to use it as a dependency for his own project

Publishing on

The first step is to release your extension in the XWiki Maven Remote Repository. Then go the Extension wiki home page and click on the Import button located inside the Contribute box (you'll need to be logged in). Then fill in your extension id (the format is <maven groupId>:<maven artifactId>), select the maven-xwiki repository and press the import button.

If you have already created an extension page manually on, the import will locate it (provided you've filled the correct extension id in your extension page, you can edit it in Object mode to fill it if that's not the case) and will overwrite data that it finds in your extension's pom.xml file, preserving the rest of the information you've manually entered (like the description).

Implementing your Maven build

Here's an example of how your pom.xml should look like (adapt to your need) if you're contributing an application (XAR):

<?xml version="1.0" encoding="UTF-8"?>

 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site:

<project xmlns="" xmlns:xsi="" xsi:schemaLocation="">
 <name>Your extension's name</name>
 <description>Your extension's description</description>
   <connection>scm:git:git:// extension id).git</connection>
   <developerConnection>scm:git:[email protected]:xwiki-contrib/(your extension id).git</developerConnection>
   <url> extension id)</url>
     <id>id of developer 1</id>
     <name>Full Name of developer 1 as registered on, e.g. Vincent Massol</name>
     <id>id of developer N</id>
     <name>Full Name of developer N as registered on, e.g. Vincent Massol</name>
   <!-- Don't run CLIRR here since there's no Java code. -->
   <!-- Needed to add support for the XAR packaging -->
     <!-- The XAR packaging uses the XAR plugin and thus we need to define what version to use -->
     <name>XWiki Staging Repository</name>

It's very important that you set the following information as they'll be used when you publish your extension on

  • Extension id
  • Name
  • Description
  • Developers

You'll also need to set the SCM information since using the Maven Release plugin will require those to be set.

Application Design

This section provides suggested best practices for writing an application. It is there to ensure your application is nice and easy to use by XWiki users.

  • Put all your pages in a space dedicated for your application. This makes your application nicely compartmented. Pick a short space name (e.g. UserDirectory). Examples of space names:


  • Ensure that all technical pages of your application are marked as hidden so that users don't see them by default. To do so, edit those pages and tick the hidden checkbox


  • Make sure you add a User Interface Extension (UIX) for the Application Panel extension point. This registers your application into the Application Panel:


    This is done by adding an object of type XWiki.UIExtensionClass in a page in your application space. We recommend having a page named <your space>.ApplicationsPanelEntry (e.g. Blog.ApplicationPanelEntry). For example:

    In order to have a nice-looking UIX page, We also recommend to have the following content on that page (insert it in wiki edit mode):

    {{include document="XWiki.UIExtensionSheet" /}}


After you've published your extension in the XWiki Maven Remote Repository, import it on (click on "Import" on that page, you'll need to be logged in after registering yourself). This creates an extension page. Verify that your extension is marked as "Installable with the Extension Manager". This makes it easy for users to install it from within their XWiki instances.

Verify the value of the fields filled automatically by the import, namely:

  • The page name
  • The description
  • The authors

If they're wrong you'll need to publish a new version of your extension and re-import it.

Edit it and provide nice user-friendly documentation. We recommend the following elements to be present:

  • Description of what the extension does and the features it has (briefly). Provides an overview screenshot if it makes sense.
  • Usage: explains how to use it
  • Document each feature with some text but very importantly with a screenshot
  • Fill the Compatibility section with the minimal version of XWiki your extension requires or has been tested with

Make sure to follow the Documentation guide. For example:

  • Use the {{image/}} macro
  • Don't take large screenshots. And don't resize the image after the screenshot has been taken (this results in blurred images). Instead reduce your browser viewport before taking the screenshot and focus the screenshot on what you wish to show (eliminate unnecessary parts or white/empty parts).

Make sure that you add documentation for your extension as soon as it's published on Otherwise nobody is going to start using it and people will start wondering what it's about.

Generally speaking check out documentation of existing extensions and try to mimic what you see (don't hesitate to go beyond the quality of what you see; you want your extension to be the most used, right? emoticon_smile Documentation goes a long way towards achieving this!).


Get Connected