Wiki source code of API
Version 340.1 by Sergiu Dumitriu on 2011/09/28
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | #set($versionStable = "3.1") | ||
| 2 | #set($nameStable = $versionStable) | ||
| 3 | #set($versionDev = "3.2-milestone-3") | ||
| 4 | #set($nameDev = "3.2 Milestone 3") | ||
| 5 | #* | ||
| 6 | #set($versionOldStable = "3.0") | ||
| 7 | #set($nameOldStable = $versionOldStable) | ||
| 8 | *# | ||
| 9 | |||
| 10 | |||
| 11 | 1 XWiki API Reference | ||
| 12 | |||
| 13 | 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). | ||
| 14 | |||
| 15 | #macro(coreJavadocUrl $version) | ||
| 16 | http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-platform-oldcore/${version}/xwiki-platform-oldcore-${version}-javadoc.jar/!/index.html | ||
| 17 | #end | ||
| 18 | #macro(renderingJavadocUrl $version) | ||
| 19 | http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/rendering/xwiki-rendering-api/${version}/xwiki-rendering-api-${version}-javadoc.jar/!/index.html | ||
| 20 | #end | ||
| 21 | ## | ||
| 22 | ## This is here because the format of the url has recently changed, | ||
| 23 | ## after the oldstable release is 3.1, this can be removed. | ||
| 24 | #macro(coreJavadocOldUrl $version) | ||
| 25 | http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/com/xpn/xwiki/platform/xwiki-core/${version}/xwiki-core-${version}-javadoc.jar/!/index.html | ||
| 26 | #end | ||
| 27 | |||
| 28 | The latest scripting API documentation is available as JavaDoc: | ||
| 29 | |||
| 30 | ## TODO: these will have to be ported over to the new format | ||
| 31 | ## xwiki-platform-oldcore-${version}-javadoc.jar | ||
| 32 | ## instead of xwiki-core-${version}-javadoc.jar | ||
| 33 | |||
| 34 | ##* [Javadoc for XWiki Platform Core - Trunkhttp://maven.xwiki.org/site/xwiki-core-parent/xwiki-core/apidocs/index.html] (generated every day automatically) | ||
| 35 | * [Javadoc for XWiki Platform Core - $nameStable>#coreJavadocUrl($versionStable)] (stable) | ||
| 36 | #if ($versionDev) | ||
| 37 | * [Javadoc for XWiki Platform Core - $nameDev>#coreJavadocUrl($versionDev)] (dev) | ||
| 38 | #end | ||
| 39 | #if ($versionOldStable) | ||
| 40 | * [Javadoc for XWiki Platform Core - $nameOldStable>#coreJavadocOldUrl($versionOldStable)] (older stable)#end | ||
| 41 | |||
| 42 | You might also be interested in the Rendering Engine API: | ||
| 43 | |||
| 44 | * [Javadoc for XWiki Platform Rendering API - $nameStable>#renderingJavadocUrl($versionStable)] (stable) | ||
| 45 | #if ($versionDev) | ||
| 46 | * [Javadoc for XWiki Platform Rendering API - $nameDev>#renderingJavadocUrl($versionDev)] (dev) | ||
| 47 | #end | ||
| 48 | #if ($versionOldStable) | ||
| 49 | * [Javadoc for XWiki Platform Rendering API - $nameOldStable>#renderingJavadocUrl($versionOldStable)] (older stable) | ||
| 50 | #end | ||
| 51 | |||
| 52 | 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/]. |
