Scripting Documentation Application

Last modified by Admin on 2022/02/28 00:28

bookProvides integrated documentation of all available scripting API directly in your running wiki instance. You may also get additionnal API information at
Developed by

Denis Gervalle

Active Installs245
7 Votes
LicenseGNU Lesser General Public License 2.1
  • 1.4+ requires XWiki 13.10

Installable with the Extension Manager


This application provides the documentation for the XWiki Scripting API. The documentation is dynamically generated based on the available bindings provided to scripts by the running wiki instance, and includes bindings provided by installed extensions. This documentation is based on the Scripting Documentation API to retrieve all informations about existing bindings.


Search interface

You may quickly search for available bindings from a text search box. You may also filter displayed bindings by categories. And finally you may also display deprecated and internal bindings if ever needed


Immediate description

Many bindings provides an immediate description about there usage, simply by moving the mouse over them.


Integrated browsing of the related Javadoc

The corresponding Javadoc for the chosen binding is displayed directly in the XWiki page, and you can freely navigate it using links and back/forward buttons (no iFrame involved).


Dynamic link creation for missing links in the Javadoc (since 1.1)

When crossing projects boundaries, the Javadoc does not provides links to very useful types. Here an example of a return values of a script service defined in platform project that returns a Type from commons project.


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 following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes









Dependencies for this extension (org.xwiki.contrib.scriptingdocumentation:scripting-documentation-ui 1.4):


Get Connected