Wiki source code of API
Version 171.1 by Thomas Mortagne on 2009/11/27
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | 1 XWiki API Reference | ||
| 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). | ||
| 4 | |||
| 5 | #set($versionStable = "2.0.4") | ||
| 6 | #set($nameStable = $versionStable) | ||
| 7 | #set($versionDev = "2.1-milestone-1") | ||
| 8 | #set($nameDev = "2.1 Milestone 1") | ||
| 9 | |||
| 10 | The latest API documentation is available as JavaDoc: | ||
| 11 | #set ($url1 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-${versionStable}-javadoc.jar", "index.html")) | ||
| 12 | #if ($versionDev)#set ($url2 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-${versionDev}-javadoc.jar", "index.html"))#end | ||
| 13 | #set ($url3 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-rendering-api-${versionStable}-javadoc.jar", "index.html")) | ||
| 14 | #if ($versionDev)#set ($url4 = $xwiki.getPlugin("zipexplorer").getFileLink($doc, "xwiki-core-rendering-api-${versionDev}-javadoc.jar", "index.html"))#end | ||
| 15 | ##* [Javadoc for XWiki Platform Core - Trunk>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/index.html] (generated every day automatically) | ||
| 16 | * <a href="$url1">Javadoc for XWiki Platform Core - $nameStable</a> | ||
| 17 | #if ($versionDev)* <a href="$url2">Javadoc for XWiki Platform Core - $nameDev</a>#end | ||
| 18 | |||
| 19 | You might too be interested by the Rendering Engine API: | ||
| 20 | |||
| 21 | * <a href="$url3">Javadoc for XWiki Platform Rendering API - $nameStable</a> | ||
| 22 | #if ($versionDev)* <a href="$url4">Javadoc for XWiki Platform Rendering API - $nameDev</a>#end | ||
| 23 | |||
| 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/]. |
