XWiki API Reference
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(Velocity, Groovy, Python, Ruby, etc).
Scripting Reference Documentation
- For XWiki versions >= 6.2.5+ you should install the in your wiki. You can (but beware, it'll show the Scripting API available on the XWiki version installed for xwiki.org, which may differ from your locally installed XWiki version).
- For XWiki versions <= 5.0.x you can browse the old (a.k.a SRD).
How to find a class
You can get the maven module where to find a Java class by using. Put the complete class name and you will get all modules containing it. Nexus also allows you to see what's in those artifacts and read the javadoc.
XWiki is made of various extensions/modules and each module offers API for both developers coding in Java and for Scripts written in wiki pages. In the future our goal is to have Javadoc links directly from each extension page located in the.
Right now we're providing all Javadocs for all modules:
Theis also available ( ).
Older Javadocs of XWiki can be found in our. For example for XWiki Platform Core Javadocs, check the files suffixed by javadoc for the version you wish under .