Show last authors
author | version | line-number | content |
---|---|---|---|
1 | #startfloatingbox() | ||
2 | *Contents* | ||
3 | #toc ("2" "3" "") | ||
4 | #endfloatingbox() | ||
5 | |||
6 | 1 Wiki Macro Tutorial | ||
7 | |||
8 | Wiki macros allow macro authors to develop reusable and distributable macro modules. There is no java code involved; hence no compiling or packaging. Macro author simply needs to create a wiki page according to a particular specification and that's all! | ||
9 | |||
10 | 1.1 Prerequisites | ||
11 | |||
12 | * Wiki macros are only available on XWiki Enterprise 2.0M2 and later versions | ||
13 | * Wiki macro authors need to have programming rights | ||
14 | * Wiki macros can only be defined inside the main wiki, though they can be used throughout a farm | ||
15 | |||
16 | 1.1 Hello World Macro | ||
17 | |||
18 | We are going to start with a very simple xwiki/2.0 wiki macro which prints a greeting message to the document content. It isn't a very useful macro but the idea is to get you familiarised with the wiki macro creation process. | ||
19 | |||
20 | 1.1.1 XWiki.WikiMacroClass | ||
21 | |||
22 | Wiki macros are defined using objects of type XWiki.WikiMacroClass. You define a wiki macro by creating a new wiki page and attaching it an object of type XWiki.WikiMacroClass. This class contains following fields: | ||
23 | |||
24 | * Macro name: Name of the macro, which will be used by users to invoke your macro | ||
25 | |||
26 | * Macro description: A short description of the macro, this description will be made available on the WYSIWYG editor (More on this later) | ||
27 | |||
28 | * Macro content: The actual wiki content that will be evaluated when the macro is executed, can be any wiki content (should be in the same syntax as the document) | ||
29 | |||
30 | Now we can define our hello world wiki macro as shown below: | ||
31 | |||
32 | {image:macro1.png} |