Summary

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

Details

Page properties

Content

...	...	@@ -5,6 +5,8 @@
5	5
6	6	1 Wiki Macro Tutorial
7	7
	8	+#error("This document is still under development")
	9	+
8	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	9
10	10	1.1 Prerequisites
...	...	@@ -13,7 +13,7 @@
13	13	* Wiki macro authors need to have programming rights
14	14	* Wiki macros can only be defined inside the main wiki, though they can be used throughout a farm
15	15
16		-1.1 Hello World Macro
	18	+1.1 Hello Macro
17	17
18	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	19
...	...	@@ -25,13 +25,13 @@
25	25
26	26	* Macro description: A short description of the macro, this description will be made available on the WYSIWYG editor (More on this later)
27	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)
	30	+* 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)
29	29
30		-Now we can define our hello world wiki macro as shown below:
	32	+Now we can define our hello macro as shown below:
31	31
32	32	{image:macro1.png}
33	33
34		-1.1.1 Invoking Hello World Macro
	36	+1.1.1 Macro Invocation
35	35
36	36	A wiki macro can be invoked just as any other macro is invoked. Since we are writing a xwiki/2.0 wiki macro, we can invoke our hello world macro as below:
37	37
...	...	@@ -41,7 +41,7 @@
41	41
42	42	And if you view the result it would say "Hello World!" (of course).
43	43
44		-1.1.1 Hello World Macro In WYSIWYG
	46	+1.1.1 WYSIWYG Access
45	45
46	46	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:
47	47
...	...	@@ -52,3 +52,4 @@
52	52
53	53
54	54
	57	+