XWiki Syntax Guide

Last modified by Frank Fock on 2024/02/07 14:48

XWiki Syntax 2.1: Programming

Macros

2.0 Macros

There is only one kind of macro in XWiki Syntax 2.1, which is called by the syntax: {{macroname param1="value1" ... paramN="valueN"}}...{{/macroname}}. For macros without content there's a short notation: {{macroname param1="value1" ... paramN="valueN"/}}

Feature	XWiki Syntax 2.1	Result
Rendering Macro with a content	{{code language="java"}} System.out.println("Hello World!"); {{/code}}	System.out.println("Hello World!");
Rendering Macro without content	{{include reference="Space.Page"/}}	The referenced page is included in the current page

For the full list of available macros check the Extensions wiki.

Macros in this wiki

Id	Name	Categories	Description	Visibility
activity	Activity (legacy)	Notifications	Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.	Current Wiki
anchor	Legacy Confluence bridge for Anchor	Deprecated	Legacy Confluence bridge for Anchor	Current Wiki
async	Async macro	Content	Execute asynchronously and/or cache the macro content.	Global
attachmentGalleryPicker	Attachment Picker	Development	Grid based attachment picker.	Global
attachmentSelector	Attachment Selector	Development	A control to be used for object properties of the current page that are supposed to contain the name of an attachment from the current (or target) page. Allows uploading new attachments, and deleting attachments from the target page. If no target page is specified, the current page will be used. Object properties are only saved to the current page.	Current Wiki
box	Box	Formatting	Draw a box around provided content.	Global
cache	Cache	Development	Caches content.	Global
chart	Chart	Content	Displays a graphical chart generated from miscellaneous data sources	Global
children	Children	Navigation	Displays a tree of children pages of the current page	Current Wiki
code	Code	Formatting	Highlights code snippets of various programming languages	Global
column	Confluence bridge for Column	Deprecated	Confluence bridge for the Column macro.	Global
comment	Comment	Development	Allows putting comments in the source content. This macro doesn't output anything.	Global
confluence_detailssummary	Confluence bridge for Details Summary	Content	Confluence bridge for the Details Summary (Page Properties Report) macro to display properties attached to a page using the Details macro.	Global
confluence_favpages	Confluence bridge for Favorite Pages	Confluence	Confluence bridge for the Favorite Pages macro	Current Wiki
confluence_jirachart	Confluence Jira chart	Content	Confluence bridge macro for jira chart.	Global
confluence_layout	Confluence bridge for Layout	Confluence	Confluence bridge macro for the Layout macro to define a layout, containing layout sections (using the confluence_layout-section macro).	Current Wiki
confluence_layout-cell	Confluence bridge for Layout Cell	Confluence	Confluence bridge for the Layout Cell macro. It is used for defining a part a layout section, used inside the confluence_layout-section macro.	Current Wiki
confluence_metadata-overview	Confluence Metadata Overview	Content	Confluence bridge macro for metadata-overview	Global
confluence_outgoing-links	Confluence Outgoing Links	Content	Confluence bridge macro for outgoing-links.	Global
confluence_toc-zone	Confluence Toc Zone	Content	Confluence bridge macro for toc-zone.	Global
container	Container	Layout	A macro to enclose multiple groups and add decoration, such as layout.	Global
content	Content	Content	Allows writing content in any wiki markup	Global
context	Context	Development	Executes content in the context of the passed page	Global
dashboard	Dashboard	Layout	A macro to define a dashboard to fill with gadgets.	Global
date	Date	Content	Use the date macro to set and format due dates within task macros and more!	Global
display	Display	Content	Display other pages into the current page.	Global
displayIcon	Icon	Content	Display an icon.	Global
documents	Pages	Content	Displays a list of pages in a Livetable	Current Wiki
documentTree	Page Tree	Navigation	Displays the tree of XWiki pages.	Current Wiki
drawio	Legacy unprefixed Confluence bridge for drawio	Deprecated	Legacy Unprefixed Confluence bridge for drawio (failed to get the description of this macro)	Global
embed	Embed content	Content	Show in your wiki page many external content. Currently this support theses external services: * Youtube, * Dailymotion, * Vimeo, * x.com, * Google doc, sheets and slides, * Google calendar, * Google maps, * Facebook, * Linkedin, * Figma, * Spotify, * Prezi, * Flickr, * Viddler, * Aha! roadmaps, * Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported.	Current Wiki
error	Error Message	Formatting	Displays an error message note.	Global
example	Example	Formatting	Shows an example and its source code.	Current Wiki
excerpt-include	Excerpt		Bridge for the Confluence Excerpt macro. It marks part of the page's content for use by other macros.	Current Wiki
footnote	Footnote	Content	Generates a footnote to display at the end of the page.	Global
gallery	Gallery	Layout	Displays the images found in the provided content using a slide-show view.	Global
gliffy	Legacy unprefixed Confluence bridge for gliffy	Deprecated	Legacy Unprefixed Confluence bridge for gliffy (failed to get the description of this macro)	Global
groovy	Groovy	Development	Execute a groovy script.	Global
hide-if	Hide if	Content	Hide the content of this macro if the condition set through the parameters is met.	Global
html	HTML	Development	Inserts HTML or XHTML code into the page.	Global
iconPicker	Icon Picker	Development	Select an icon within the XWiki icon set.	Current Wiki
id	Id	Navigation	Allows putting a reference/location in a page. In HTML for example this is called an Anchor. It allows pointing to that location, for example in links.	Global
include	Include	Content	Include other pages into the current page.	Global
info	Info Message	Formatting	Displays an info message note.	Global
jwplayer	JW Player	Content	The JW Player is an open-source embeddable media player for web sites, supporting many commonly-used audio and video formats. The player is easy to configure, customize and extend.	Current Wiki
layout	Legacy unprefixed Confluence bridge for Layout	Deprecated	Legacy Unprefixed Confluence bridge macro for the Layout macro to define a layout, containing layout sections (using the confluence_layout-section macro).	Global
layout-cell	Legacy unprefixed Confluence bridge for Layout Cell	Deprecated	Legacy Unprefixed Confluence bridge for the Layout Cell macro. It is used for defining a part a layout section, used inside the confluence_layout-section macro.	Global
layout-section	Legacy unprefixed Confluence bridge for layout-section	Deprecated	Legacy Unprefixed Confluence bridge for layout-section (failed to get the description of this macro)	Global
liveData	Live Data	Content	Display dynamic lists of data.	Global
mathblock	Legacy unprefixed Confluence bridge for mathblock	Deprecated	Legacy Unprefixed Confluence bridge for mathblock (failed to get the description of this macro)	Global
mathblock-ref	Legacy unprefixed Confluence bridge for mathblock-ref	Deprecated	Legacy Unprefixed Confluence bridge for mathblock-ref (failed to get the description of this macro)	Global
mathinline	Legacy unprefixed Confluence bridge for mathinline	Deprecated	Legacy Unprefixed Confluence bridge for mathinline (failed to get the description of this macro)	Global
mathjax	MathJax	Content	Enter content supported by the MathJax javascript engine.	Current Wiki
mention	User Mention	Notifications	Insert a user mention.	Current Wiki
menu	Menu	Navigation	Displays a menu created using simple wiki syntax (nested lists and links).	Global
mockup	Legacy unprefixed Confluence bridge for mockup	Deprecated	Legacy Unprefixed Confluence bridge for mockup (failed to get the description of this macro)	Global
multimedia	Legacy unprefixed Confluence bridge for multimedia	Deprecated	Legacy Unprefixed Confluence bridge for multimedia (failed to get the description of this macro)	Global
net-presago-stream-macro	Legacy unprefixed Confluence bridge for net-presago-stream-macro	Deprecated	Legacy Unprefixed Confluence bridge for net-presago-stream-macro (failed to get the description of this macro)
note	Legacy unprefixed Confluence bridge for note	Deprecated	Legacy Unprefixed Confluence bridge for note (failed to get the description of this macro)	Global
notifications	Notifications	Notifications	Display notifications about events happened on the wiki.	Current Wiki
notificationsApplicationsPreferences	Notifications Applications Preferences	Notifications	Display the preferences of the current user about notification applications.	Current Wiki
notificationsAutoWatchPreferences	Notifications Auto Watch Preferences	Notifications	Display the preferences of the current user about auto watched pages.	Current Wiki
notificationsCustomFiltersPreferences	Notifications Custom Filters Preferences	Notifications	Display the preferences of the given user about custom notification filters.	Current Wiki
notificationsEmailPreferences	Notifications Email Preferences	Notifications	Display the preferences of the current user about notification emails.	Current Wiki
notificationsFiltersPreferences	Notifications Filters Preferences (deprecated)	Notifications	Display the preferences of the current user about notification filters. This macro is now deprecated in favor of Custom Notifications Filters Preferences or System Notifications Filters Preferences.	Current Wiki
notificationsSystemFiltersPreferences	Notifications System Filters Preferences	Notifications	Display the preferences of the given user about system notification filters.	Current Wiki
office	Office Document Viewer	Content	View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.	Global
pagetree	Legacy unprefixed Confluence bridge for pagetree	Deprecated	Legacy Unprefixed Confluence bridge for pagetree (failed to get the description of this macro)	Global
paste-code-macro	Legacy unprefixed Confluence bridge for paste-code-macro	Deprecated	Legacy Unprefixed Confluence bridge for paste-code-macro (failed to get the description of this macro)	Global
pdftoc	PDF Table of Contents	Internal	Generates the table of contents for the PDF export.	Global
pdfviewer	PDF Viewer	Content	View PDF attachments inside wiki pages without downloading or importing them.	Global
putFootnotes	Put Footnotes	Content	Displays all the footnotes from the page. If missing, all footnotes are displayed by default at the end of the page.	Global
python	Python	Development	Executes a python script.	Global
script	Script	Development	Execute script in provided script language.	Global
section	Confluence bridge for Section	Deprecated	Confluence bridge for the Section macro.	Global
show-if	Show if	Content	Show the content of this macro if the condition set through the parameters is met.	Global
success	Success Message	Formatting	Displays a success message note.	Global
tab	Tab	Content	Tab element for the tab group macro. This is expected to be put as the tab-group macro content.	Global
tab-group	Tab group	Content	The main macro which group tab macro elements.	Global
tagcloud	Tag Cloud	Content	Displays the cloud of tags in this wiki or in the specified space, if any.	Current Wiki
template	Template	Development	Insert a template.	Global
time	Legacy unprefixed Confluence bridge for time	Deprecated	Legacy Unprefixed Confluence bridge for time (failed to get the description of this macro)	Current Wiki
tip	Legacy unprefixed Confluence bridge for tip	Deprecated	Legacy Unprefixed Confluence bridge for tip (failed to get the description of this macro)	Global
toc	Table of contents	Navigation	Generates a table of contents.	Global
translation	Translation	Content	Display a translation message.	Global
tree	Tree	Navigation	Displays a tree hierarchy defined by the macro content or the source parameter.	Current Wiki
uiextension	UI Extension	Development	Insert a UI extension.	Global
uiextensions	UI Extensions	Development	Insert UI extensions.	Global
useravatar	User Avatar	Content	Allows displaying the avatar for a specific user.	Global
userList	User list	Content	Displays a custom list of users with their avatar	Global
userProfile	User profile	Content	Displays a user profile with custom set of properties	Global
velocity	Velocity	Development	Executes a Velocity script.	Global
view-file	View file	Content	Show a file using PDF Viewer Macro or Office Viewer.	Global
warning	Warning Message	Formatting	Displays a warning message note.	Global
wikimacrocontent	WikiMacro Content	Development	Display editable content of a wikimacro.	Global
wikimacroparameter	WikiMacro Parameter	Development	Display editable parameter of a wikimacro.	Global
wikis	Wikis	Navigation	List all wikis	Current Wiki
wireframe	Legacy unprefixed Confluence bridge for wireframe	Deprecated	Legacy Unprefixed Confluence bridge for wireframe (failed to get the description of this macro)	Global
workspaces	Workspaces (Legacy)	Deprecated	Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.	Current Wiki

HTML

2.0 HTML

In XWiki Syntax 2.1 HTML or XHTML must be entered by using the HTML macro.

XWiki Syntax 2.1	Result
{{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}}	HTML

Scripts

2.0 Scripts

XWiki supports several scripting languages.

Feature	XWiki Syntax 2.1
Velocity script	{{velocity}} #set ($var = "whatever") {{/velocity}}
Groovy script	{{groovy}} def var = "whatever" {{/groovy}}