Wiki source code of WikiMacroTutorial

Version 62.1 by Asiri Rathnayake on 2009/08/27

Show last authors
1 #warning("This page is being updated");
2
3 #startfloatingbox()
4 *Contents*
5 #toc ("2" "3" "")
6 #endfloatingbox()
7
8 1 Writing a XWiki Rendering Macro in wiki pages
9
10 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!
11
12 1.1 Prerequisites
13
14 * Wiki macros are only available on XWiki Enterprise 2.0M2 and later versions
15 * Wiki macro authors need to have programming rights
16 * Wiki macros can only be defined inside the main wiki, though they can be used throughout a farm
17
18 1.1 Hello Macro
19
20 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.
21
22 1.1.1 Definition
23
24 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:
25
26 * Macro id: Id of the macro to be used by users when invoking your macro from wiki code
27
28 * Macro name: Name of the macro to be displayed on the wysiwyg editor
29
30 * Macro description: A short description of the macro to be displayed on the WYSIWYG editor
31
32 * Default category: Default category under which this macro should be listed
33
34 * Supports inline mode: Whether the macro can be used in an inline context or not
35
36 * Macro content type: Whether this macro should support a body or not
37
38 * Content description: A short description about the macro's content to be displayed on the WYSIWYG editor
39
40 * Macro code: The actual wiki code that will be evaluated when the macro is executed, can be any xwiki content (should be in the same syntax as the document)
41
42 Now we can define our hello macro as shown below:
43
44 {image:macro1.png}
45
46 1.1.1 Invocation
47
48 A wiki macro can be invoked just like any other macro is invoked. Since we are writing a xwiki/2.0 wiki macro, we can invoke our hello macro as below:
49
50 {code}
51 {{hello/}}
52 {code}
53
54 And if you view the result it would say "Hello World!" (of course).
55
56 1.1.1 Parameters
57
58 Introducing a parameter to a wiki macro is pretty straight forward; you simply need to add an object of type XWiki.WikiMacroParameterClass into your wiki macro document (one object per parameter). This class contains several fields that allow you to define your parameter clearly:
59
60 * Parameter name: Name of the parameter, users will refer this name when invoking your macro with parameters
61
62 * Parameter description: A short description of the parameter, this description will be made available on the WYSIWYG editor
63
64 * Parameter mandatory: Indicates if this particular parameter is mandatory, wiki macro will fail to execute if a mandatory parameter is missing
65
66 Now we're going to extend our hello macro with a parameter. We will introduce a parameter named ~~greetUser~~ that will indicate if the greeting message should be tailored for current user viewing the page. The definition of the parameter is show below:
67
68 {image:macro3.png}
69
70 A macro parameter defined this way can be accessed from any scripting language within the macro code. For an example, we are going to utilize our ~~greetUser~~ parameter within hello macro as below:
71
72 {image:macro4.png}
73
74 As you might have realized already, direct binding of parameters is not supported at the moment. That is, you cannot access ~~greetUser~~ parameter with *$greetUser*. Instead you must use *$context.macro.params.greetUser*. We plan to introduce some form of direct parameter binding in near future.
75
76 Finally, we can test our new version of hello macro with the following invocation:
77
78 {code}
79 {{hello greetUser="true"/}}
80 {code}
81
82
83
84
85
86
87
88
89
90 1.1 WYSIWYG Access
91
92 A wiki macros is treated just like any other rendering macro in the system. As such, the moment you save your wiki macro it will be available to the users through the WYSIWYG editor's *Insert Macro* dialog box:
93
94 {image:macro2.png}
95
96 1.1 Scripting Tips
97
98 Following are few useful hints if you plan to do advanced scripting inside your wiki macros:
99
100 * Access parameters: Use the context object (Ex. $context.macro.params.param1)
101
102 * Access macro body (if your macro defines one): Use the context object (Ex. $context.macro.content)
103
104 * Access [MacroTransformationContext>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rendering/xwiki-rendering-api/src/main/java/org/xwiki/rendering/transformation/MacroTransformationContext.java]: Use the context object (Ex. $context.macro.context)

Get Connected