Wiki Macro Tutorial

Version 5.1 by Asiri Rathnayake on 2009/07/20

Wiki Macro Tutorial

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!


  • Wiki macros are only available on XWiki Enterprise 2.0M2 and later versions
  • Wiki macro authors need to have programming rights
  • Wiki macros can only be defined inside the main wiki, though they can be used throughout a farm

Hello World Macro

We are going to start with a very simple wiki macro which prints the text "Hello World!" to the document content. It's not a very useful macro but the idea is to get you familiarised with the wiki macro creation process.

The XWiki.WikiMacroClass

Get Connected