Developer's Guide

Version 33.1 by Marius Dumitru Florea on 2015/07/28

If you are interested in participating to the XWiki project development itself or in building it from sources, you should refer to the Community wiki.
You still have a question?
Subscribe to the mailing lists!

XWiki is a second generation wiki that provides all the basic content management and administration features of common wikis, but with much more. XWiki takes the wiki approach to a whole new level by providing enhanced features and capabilities. With XWiki, you can build simple applications, extend the platform with custom plugins, or even build complex Web applications. 

Quick Start

App Within Minutes
Tool to build Applications without any technical knowledge

Reference documentation

XWiki Architecture
Understanding how XWiki is architected and how to extend it.
XWiki Data Model
You should start by understanding XWiki's data model of Classes, Properties, and Objects. They'll be needed to build applications at the presentation (document) level.
XWiki Scripting
Once you understand XWiki's Data Model you'll be able to program directly in the documents you edit. XWiki integrates both Velocity and Groovy scripting. Together, Classes and Scripting will allow you to create basic to complex web applications at the XWiki document layer without the need for compiling code or deploying software components.
XWiki API Guide
Guide that explains the main XWiki APIs. Quick access to the XWiki API Reference.
Extension Points List
List all available Extension Points.
Front-end Resources
A description of the tools and frameworks used in XWiki. You'll find information about how you can use external libraries such as  YUI and SmartClient and internal XWiki libraries for your the development of your in-wiki applications or for the development of XWiki products themselves. You'll also find the documentation of StyleSheet resources created specifically for the XWiki project.
XWiki Module Reference
Reference documentation for the various Modules of XWiki.
Saving Data
Description of all the possibilities you have to save Data from within the XWiki Platform
URL Architecture
Explains how XWiki URLs work, the format of the Standard URL Scheme and how to configure them.

Tutorials and Guides

How to use Velocity in XWiki pages
A presentation that explains how to write applications in XWiki (using Velocity, the XWiki Class system, and the API...).
Creating a FAQ application
Demonstrates how to create a FAQ application much like the one you can find on this Wiki FAQ page, either using Classes/Objects/Sheets/Templates and Scripting or using the App Within Minutes extension to produce a FAQ application. Completing this tutorial is a recommended prerequisite for anyone who wants to build custom applications on the XWiki engine at the document or presentation layer.
Creating a Groovy Class
Demonstrates how to put Groovy code in one page and then reuse it by importing it from another page.
Writing an Event Listener
Explains how to write an Event Listener in order to perform some action when an event happens in the wiki. Examples of events are Document changed, Object modified, and more.
Creating a TODO application in XWiki
Another helpful tutorial to using XWiki's classes, velocity scripts, hibernate queries for a dashboard.
 Shows well the power of XWiki.
Creating a form with validation and tooltips
Quick and efficient tutorial to set-up validation using regular expression and groovy scripts, as well as tooltips
Writing XWiki Rendering Macros
How to develop XWiki Rendering macros (available in XWiki Syntax 2.0 only)
Writing an XWiki Component
Getting started with the new XWiki components architecture: introduction to this new design, a step-by-step guide to writing an XWiki component (the recommended way of creating XWiki plugins) and some guidelines and development good practices in this area.
Skin eXtensions
Illustrate XWiki's Skin eXtensions mechanism that allows developers to pull extra Javascript and stylesheet files on demand or for all wiki pages without modifying the wiki templates and skin. The tutorial guides through the creation of minimal stylesheet and Javascript extensions, and continues with a complete exemple of a real-world extension to demonstrate the power of XWiki's skin eXtensions!
Internationalizing Applications
Learn how to write internationalized applications.
Creating New XClass Property Types
See how you can easily extend the class editor with new custom property types.
Custom Mapping
Learn how to use Custom Mapping when you need to map XWiki Classes to your own database tables or when you need extra performance for complex data.
Creating Plugins
After you've learnt how to write applications at the document level you may want to go further and program plugins in Java to extend XWiki's view engine, as well as add hooks into different parts of the core engine.
Writing a custom SOLR search for an AppWithinMinutes application
Tutorial to show how to write a customized SOLR search screen in XWiki for an AWM application. For this example we have used the "Expense Report" application.
Performing Asynchronous Tasks
A tutorial on how to perform long-running and expensive operations in XWiki from a background thread using the Job Module.
Best Practices
A set of best practices for developing applications with XWiki.

Further reading

XWiki API Reference
The API is available as a JavaDoc. It presents the objects and properties that you can access with scripting.
Database Schema
For advanced users who like to know everything, check out the database tables created by XWiki.

Draft documentation

See the Draft space of the Development Wiki.


Get Connected