Wiki source code of API

Version 165.1 by Jean-Vincent Drean on 2009/11/18

Hide last authors
Vincent Massol 1.1 1 1 XWiki API Reference
2
Vincent Massol 156.2 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 159.1 5 #set($versionStable = "2.0.3")
Thomas Mortagne 128.1 6 #set($nameStable = $versionStable)
Jean-Vincent Drean 163.1 7 #set($versionDev = "2.1-milestone-1")
8 #set($nameDev = "2.1 Milestone 1")
Thomas Mortagne 128.1 9
Vincent Massol 1.24 10 The latest API documentation is available as JavaDoc:
Thomas Mortagne 128.1 11 #set ($url1 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-${versionStable}-javadoc.jar", "index.html"))
Thomas Mortagne 151.1 12 #if ($versionDev)#set ($url2 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-${versionDev}-javadoc.jar", "index.html"))#end
Thomas Mortagne 128.1 13 #set ($url3 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-rendering-api-${versionStable}-javadoc.jar", "index.html"))
Thomas Mortagne 151.1 14 #if ($versionDev)#set ($url4 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-rendering-api-${versionDev}-javadoc.jar", "index.html"))#end
Vincent Massol 100.2 15 ##* [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 128.1 16 * <a href="$url1">Javadoc for XWiki Platform Core - $nameStable</a>
Thomas Mortagne 151.1 17 #if ($versionDev)* <a href="$url2">Javadoc for XWiki Platform Core - $nameDev</a>#end
Vincent Massol 1.1 18
Jerome 104.2 19 You might too be interested by the Rendering Engine API:
20
Thomas Mortagne 128.1 21 * <a href="$url3">Javadoc for XWiki Platform Rendering API - $nameStable</a>
Thomas Mortagne 151.1 22 #if ($versionDev)* <a href="$url4">Javadoc for XWiki Platform Rendering API - $nameDev</a>#end
Jerome 104.2 23
Vincent Massol 1.24 24 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/].
Thomas Mortagne 1.43 25
Thomas Mortagne 98.1 26

Get Connected