<
From version < 1.4 >
edited by Vincent Massol
on 2006/12/05
To version < 1.6 >
edited by vmassol
on 2006/12/11
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.vmassol
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  The concept of the 'context' is central to Velocity. The context is a 'carrier' of data between the Java layer of the XWiki engine and the template or page layer. The programmers of the XWiki core have gathered objects of various types and placed them in the Velocity context. These objects, and their methods and properties, are accessable via template elements called references and effectively form an API for XWiki.
8 8  
9 -The API is documented in Javadoc format and can be accessed here: [XWiki API Javadoc>http://build.xpertnet.biz/doc/api/com/xpn/xwiki/api/Api.html]. If you are not familiar with Java or object oriented programming, you will probably be confused by the API documentation. It is not within the scope of our documentation to teach you all the details about Velocity, Java, or object oriented programming. You can find all of that information already online. Instead, we provide only a high-level overview in [Basic Velocity Scripting Tutorial>Basic Velocity]; it will give you a good sense for how Velocity scripting works in XWiki. You should then refer to the [Velocity User Guide>http://jakarta.apache.org/velocity/docs/user-guide.html#What%20is%20Velocity] as an ongoing reference. Finally, you can explore the page code found throughout the [Code Center>Code.WebHome] area to see how others have figured out how to achieve a variety of results.
9 +The API is documented in Javadoc format and can be accessed here: [XWiki API Javadoc>http://build.xpertnet.biz/doc/api/com/xpn/xwiki/api/Api.html]. If you are not familiar with Java or object oriented programming, you will probably be confused by the API documentation. It is not within the scope of our documentation to teach you all the details about Velocity, Java, or object oriented programming. You can find all of that information already online. Instead, we provide only a high-level overview in [Basic Velocity Scripting Tutorial>Basic Velocity]; it will give you a good sense for how Velocity scripting works in XWiki. You should then refer to the [Velocity User Guide>http://jakarta.apache.org/velocity/docs/user-guide.html#What%20is%20Velocity] as an ongoing reference. Finally, you can explore the page code found throughout the [Code Zone>Code.WebHome] area to see how others have figured out how to achieve a variety of results.
10 10  
11 11  You can access in your velocity script to :
12 12  * The current document: *\$doc*, see the [XWiki Javadoc 0.9.840>http://build.xpertnet.biz/doc/api/com/xpn/xwiki/api/Document.html] [XWiki Javadoc for code in SVN>http://build.xpertnet.biz/doc/nightly/api/com/xpn/xwiki/api/Document.html]
... ... @@ -15,7 +15,7 @@
15 15  
16 16  You can also [use HQL to query the XWiki database>velocityHqlExamples] from your velocity scripts.
17 17  
18 -1.1 XWikis Groovy API
18 +1.1 XWiki's Groovy API
19 19  
20 20  Currently Groovy is only allowed for admins of a wiki (or users having the 'programming' right).
21 21  

Get Connected