Summary

• Page properties (4 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+XWiki API Reference

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.Sergiu
	1	+XWiki.VincentMassol

Syntax

...	...	@@ -1,1 +1,1 @@
1		-XWiki 1.0
	1	+XWiki 2.0

Content

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