Scripting (XWiki.org)

1

#startfloatingbox()

2

*Contents*

#toc ("2" "4" "")

#endfloatingbox()

1 Scripting

XWiki integrates both Velocity and Groovy scripting. Together, these two mechanisms allow you to create basic to complex web applications at the XWiki page (or view) layer without the need for compiling code or deploying software components. In other words, you can use Velocity and Groovy script syntax in addition to wiki and HTML syntax as the contents of an XWiki page.

9

10

1.1 XWiki's Velocity API

11

12

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 accessible via template elements called references and effectively form an API for XWiki.

13

14

The API is documented in Javadoc format and can be accessed here: [XWiki API Javadoc>DevGuide.API]. 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. You should then refer to the [Velocity User Guide>http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html] as an ongoing reference. Finally, you can explore the page code found throughout the [Code Zone>code:Main.WebHome] area to see how others have figured out how to achieve a variety of results.

15

16

You can access in your velocity script to:

17

* The current document: *<tt>\$doc</tt>*

18

* The Context of the request: *<tt>\$context</tt>*

19

* the request object: *<tt>\$request</tt>*

20

* the response object: *<tt>\$response</tt>*

21

* the XWiki Object: *<tt>\$xwiki</tt>*

22

23

In addition the following Velocity tools are also available in the Velocity context:

24

* [List Tool>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/ListTool.html]: *<tt>\$listtool</tt>*

25

* [Number Tool>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/NumberTool.html]: *<tt>\$numbertool</tt>*

26

* [Date Tool>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/DateTool.html]: *<tt>\$datetool</tt>*

27

* [Math Tool>http://velocity.apache.org/tools/releases/1.4/generic/MathTool.html]: *<tt>\$mathtool</tt>*

28

* [Escape Tool>http://velocity.apache.org/tools/releases/1.4/generic/EscapeTool.html]: *<tt>\$escapetool</tt>*

29

* [Sort Tool>http://velocity.apache.org/tools/releases/1.4/javadoc/org/apache/velocity/tools/generic/SortTool.html]: *<tt>\$sorttool</tt>*

30

31

#info("If you wish to add new Velocity tools you'll need to edit your <tt>xwiki.properties</tt> file and follow the instructions in there.")

32

33

You can also [use HQL to query the XWiki database>velocityHqlExamples] from your velocity scripts.

34

35

To include Velocity scripts in other Velocity scripts, see [How to include a velocity page into another page>DevGuide.IncludeInVelocity].

36

37

1.1.1 Other Velocity Variables

38

39

#info("These variables can be used but are subject to change in the future.")

40

41

1.1.1.1 Controlling whether to display Comments/History/Attachment/Information sections or not

42

43

It's possible to control whether to display these sections by setting some velocity variable to "no":

44

45

{code:none}

46

#set ($showcomments = "no")

47

#set ($showattachments = "no")

48

#set ($showhistory = "no")

49

#set ($showinformation = "no")

50

{code}

51

52

To remove them all you can set:

53

54

{code:none}

55

#set($docextras = [])

56

{code}

57

58

1.1 XWiki's Groovy API

59

60

Currently Groovy is only allowed for admins of a wiki (or users having the 'programming' right).

61

62

* See Groovy examples in the [Code Zone>code:Main.WebHome], more specifically in the [Code Snippets area>code:Snippets.WebHome]

63

* [Feeling Groovy>http://www-128.ibm.com/developerworks/java/library/j-alj08034.html]

64

* [MVC programming with Groovy templates>http://www-128.ibm.com/developerworks/java/library/j-pg02155/]

65

* [Guillaume Laforge on Groovy, XWiki etc.>http://www.stelligent.com/content/view/44/71/]

1.1.1 Groovy Example

The following example demonstrates how to use a groovy script directly inside your page. This example performs a reverse DNS lookup from the velocity variable <tt>\$address</tt> and store the result into the variable <tt>\$hostname</tt>.

70

71

{code}

72

#set ($address = "172.20.12.61")

IP Address: $address

<%