XWiki API Reference

Version 346.5 by Vincent Massol on 2011/11/08
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.DevGuide.API.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

XWiki's APIs are the methods that the XWiki development team consider safe for you to use (i.e. for which backward compatibility is guaranteed). They can be called from Java or directly from your wiki pages using a scripting language (Velocity, Groovy, Python, Ruby, etc).

The latest scripting API documentation is available as JavaDoc:

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.DevGuide.API.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

You might also be interested in the Rendering Engine API:

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.DevGuide.API.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Older Javadocs of XWiki can be found in our Maven Release repository. For example for XWiki Platform Core Javadocs, check the files suffixed by javadoc for the version you wish under this directory.

Get Connected