Wiki source code of API

Version 307.1 by Thomas Mortagne on 2010/08/05

Hide last authors
Silvia Macovei 239.1 1 1 XWiki API Reference
Vincent Massol 1.1 2
Silvia Macovei 239.1 3 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>DevGuide.Scripting] (either Velocity or Groovy).
Vincent Massol 1.1 4
Thomas Mortagne 305.1 5 #macro(coreJavadocUrl $version)
6 http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/com/xpn/xwiki/platform/xwiki-core/$version/xwiki-core-$version-javadoc.jar/!/index.html
7 #end
8 #macro(renderingJavadocUrl $version)
9 http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-core-rendering-api/$version/xwiki-core-rendering-api-$version-javadoc.jar/!/index.html
10 #end
11
Sergiu Dumitriu 304.1 12 #set($versionStable = "2.4")
Thomas Mortagne 128.1 13 #set($nameStable = $versionStable)
Sergiu Dumitriu 304.1 14 ##set($versionDev = "2.5-rc-1")
15 ##set($nameDev = "2.5M1")
16 #set($versionOldStable = "2.3.2")
17 #set($nameOldStable = $versionOldStable)
Thomas Mortagne 128.1 18
Vincent Massol 1.24 19 The latest API documentation is available as JavaDoc:
Silvia Macovei 239.1 20
Vincent Massol 100.2 21 ##* [Javadoc for XWiki Platform Core - Trunk>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/index.html] (generated every day automatically)
Thomas Mortagne 306.1 22 * [Javadoc for XWiki Platform Core - $nameStable>>#coreJavadocUrl($versionStable)] (stable)
Thomas Mortagne 305.1 23 #if ($versionDev)
Thomas Mortagne 306.1 24 * [Javadoc for XWiki Platform Core - $nameDev>>#coreJavadocUrl($versionDev)] (dev)
Thomas Mortagne 305.1 25 #end
26 #if ($versionOldStable)
Thomas Mortagne 306.1 27 * [Javadoc for XWiki Platform Core - $nameOldStable>>>#coreJavadocUrl($versionOldStable)] (older stable)#end
Thomas Mortagne 189.1 28
Jerome 104.2 29 You might too be interested by the Rendering Engine API:
30
Thomas Mortagne 306.1 31 * [Javadoc for XWiki Platform Rendering API - $nameStable>>#renderingJavadocUrl($versionStable)] (stable)
Thomas Mortagne 305.1 32 #if ($versionDev)
Thomas Mortagne 306.1 33 * [Javadoc for XWiki Platform Rendering API - $nameDev>>#renderingJavadocUrl($versionDev)] (dev)
Thomas Mortagne 305.1 34 #end
35 #if ($versionOldStable)
Thomas Mortagne 306.1 36 * [Javadoc for XWiki Platform Rendering API - $nameOldStable>>#renderingJavadocUrl($versionOldStable)] (older stable)
Thomas Mortagne 305.1 37 #end
Thomas Mortagne 189.1 38
Silvia Macovei 239.1 39 Older Javadocs of XWiki can be found in our [Maven Release repository>http://maven.xwiki.org/releases]. For example for XWiki Platform Core Javadocs check the files suffixed by <tt>javadoc</tt> for the version you wish under [this directory>http://maven.xwiki.org/releases/com/xpn/xwiki/platform/xwiki-core/].

Get Connected