Writing XWiki Rendering Macros

Last modified by Vincent Massol on 2021/11/03

These tutorials explain how to implement XWiki Macros using XWiki's Rendering Architecture.

Implementation Options

XWiki Rendering macros can be written either in Java or directly in wiki pages:


If you're wondering whether to write your Rendering Macro in Java or in a wiki page, the following table provides some comparison between both options.

CharacteristicsJava MacroWiki Macro
Easy to debugacceptcancel
Easy to write an automated test foracceptcancel
Optimized for performanceacceptcancel
Advanced parameter metadata support (advanced, deprecated, grouping)acceptcancel
Doesn't require development skillscancelaccept
Easy for a user to customizecancelaccept
Fast to write and manually testcancelaccept

Get Connected