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:
Comparison
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.
Characteristics | Java Macro | Wiki Macro |
---|---|---|
Easy to debug | ![]() | ![]() |
Easy to write an automated test for | ![]() | ![]() |
Optimized for performance | ![]() | ![]() |
Advanced parameter metadata support (advanced, deprecated, grouping) | ![]() | ![]() |
Doesn't require development skills | ![]() | ![]() |
Easy for a user to customize | ![]() | ![]() |
Fast to write and manually test | ![]() | ![]() |