Developer Guide

Last modified by Manuel Leduc on 2024/01/22

Scripting API Guide

Guide that show how to use important XWiki APIs from a script.

API Reference

The API is available as a JavaDoc. It presents the objects and properties that you can access with scripting.


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.


Understanding how XWiki is architected and how to extend it.
Data Model
Describes XWiki's data model of Classes, Properties, and Objects. They'll be needed to build applications at the presentation (document) level.
Database Schema
For advanced users who like to know everything, check out the database tables created by XWiki.

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?
Post on the forum!

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 asYUI 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.
Extension Points List
List all available Extension Points.
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.
Module Reference
Reference documentation for the various Modules of XWiki.


Tutorials & Guides

Creating a FAQ application
Demonstrates how to create a FAQ application, either using Classes/Objects/Sheets/Templates and Scripting or using the App Within Minutes. 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.
Skin Extensions
Illustrates 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. Creation minimal Stylesheet and Javascript extensions, and continue with a complete example of a real-world extension.
Creating 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.
Creating Rendering Macros
How to develop XWiki Rendering macros (available in XWiki Syntax 2.0+ only).
Creating an Extension
Explains how to create an XWiki Extension.
Creating a Groovy Class
Demonstrates how to put Groovy code in one page and then reuse it by importing it from another page.

Creating New XClass Property Types
See how you can easily extend the class editor with new custom property types.
Creating and using UI Extension Points
UI Extension Points are ways to modify the UI without having to write a full skin. Learn how to create new Extension Points and how to use existing ones.
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
Creating a Tree View
A tutorial on how to create a tree view for any tree structure you may have in XWiki, using the Tree Macro.
Creating 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.
Creating a Master-Detail view
Shows how to implement a Master-Details view
Creating 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 Plugin
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.
Creating a Custom Authenticator
You can now dive deeper in XWiki's core and create your own custom authenticator.
How to use Velocity in wiki pages
A presentation that explains how to write applications in XWiki (using Velocity, the XWiki Class system, and the API...).
Internationalizing Applications
Learn how to write internationalized applications.
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.
Integrating JavaScript Libraries
A tutorial on how we can use WebJars and RequireJS to integrate JavaScript libraries in XWiki. Moreover, you'll see how you can package your own JavaScript code as a WebJar in order to benefit from various code quality tools (static code analysis with jshint, integration testing with Jasmine).
Performing Asynchronous Tasks
A tutorial on how to perform long-running and expensive operations in XWiki from a background thread using the Job Module.
AJAX and JSON calls
How to perform AJAX calls, retrieve JSON results from a Velocity page and to update your application's UI.
In-place editing for object properties
Demonstrates how to set up in-place editing for object properties.
Best Practices
A set of best practices for developing applications with XWiki.



See the Drafts page for other topics that are still under review.

Get Connected