0 Votes

XWiki Syntax Guide

Last modified by Ryan C on 2025/03/06 17:59

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
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
awmkanban	Kanban board for AppWithinMinutes		Display XWiki Documents from an AWM as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board).	Global
box	Box	Formatting	Draw a box around provided content.	Global
button	Button Macro		Insert a noticeable, clickable button on your XWiki page to highlight links and create call to actions!	Current Wiki
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
comment	Comment	Development	Allows putting comments in the source content. This macro doesn't output anything.	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
content-report-table	Content Report Table Macro	Content	Provides a content report in table format, based on labels.	Current Wiki
context	Context	Development	Executes content in the context of the passed page	Global
contributors	Contributors	Content	Contributors Confluence Bridge macro to show the contributors of a given document.	Current Wiki
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
error	Error Message	Formatting	Displays an error message note.	Global
example	Example	Formatting	Shows an example and its source code.	Current Wiki
excerpt	Excerpt		Excerpt macro. It marks part of the page's content for use by other macros. It is compatible with the Confluence Excerpt macro.	Current Wiki
excerpt-include	Excerpt include	Content	Includes excerpts from other documents into the current page. The included pages need to contain the simple `excerpt` macro.	Global
expand	Expand		Add the Expand macro to your page to provide content in an expandable / collapsible section. This is one of Confluence's most popular macros. It's great for: visually reducing the amount of information on a page, breaking process information down into clickable steps, hiding background or obsolete information, while still keeping it on the page for future reference. The macro is collapsed by default, people need to click each one to expand it. There's no way to expand all macros on a page at once, however all Expand macros are automatically expanded when you print or export the page to PDF.	Current Wiki
expandableThumbnailSkinExtensionID	expandableThumbnailSkinExtension		Skin extension to automatically create expandable thumbnails for images.	Current Wiki
faq	FAQ		Lists FAQ entries	Current Wiki
fileManager.recentFiles	Recent Files		Lists the files that have been recently uploaded through the File Manager.	Current Wiki
filemanagerdoc	File Manager Document		Inserts a file manager document in a page, with or without preview	Current Wiki
filetagcloud	FileManager tag cloud		Displays the cloud of file tags in this wiki or in the specified space, if any.	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
gdprSettings	Gdpr settings		Get what kind of cookies the current user has consented to. (preferences, statistics or marketing)	Current Wiki
glossaryEntries	glossaryEntries	Navigation	Lists all glossary entries from a glossary, as a list	Global
glossaryReference	GlossaryReference	Navigation	References a glossary entry	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
ideasrecent	Recent Ideas		Displays the N most recent ideas.	Current Wiki
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
kanban	Kanban		Kanban macro allowing to display and edit a kanban	Current Wiki
kanbanboard	Kanban board - Task Manager	Content	Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board).	Current Wiki
liveData	Live Data	Content	Display dynamic lists of data.	Global
locationSearch	Location search		Search in the given location.	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
missingLicenseMessage	Missing License Message		Display an error message when the extension does not have a valid license.	Global
msStream	Microsoft Stream		Embed a Microsoft Stream video in a page by simply passing the URL and any customization parameters.	Current Wiki
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
panel	Panel Macro		Panel macro to display XWiki content inside a panel.	Current Wiki
pdftoc	PDF Table of Contents	Internal	Generates the table of contents for the PDF export.	Global
pdfviewer	PDF Viewer	Content	PDF Viewer based on Mozilla pdf.js	Global
profile-picture	Profile Picture	Content	Display the profile picture of selected user.	Current Wiki
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
recently-updated	Recently Updated	Content	Add the Recently Updated macro to a page to show a list of pages, blogs, files, and comments that have been created or edited recently. This is great for project landing, information pages, or team space home pages. It's very flexible, you can limit the list to specific people, spaces, types of content, and more.	Current Wiki
script	Script	Development	Execute script in provided script language.	Global
show-if	Show if	Content	Show the content of this macro if the condition set through the parameters is met.	Global
status	Status		Insert a colored label in the text to highlight the status of an item.	Current Wiki
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
tagList	Tag list		Show a list of all the macros in your instance.	Current Wiki
task	Task	Content	Create a task that you can assign an user to using the mention macro and use the date macro to set a deadline.	Global
task-report	Task report macro	Content	Create a custom report of the tasks within the wiki.	Current Wiki
taskcard	Task card	Content	Display a task and its information as a card.	Current Wiki
taskgantt	Gantt Diagram	Content	Display tasks from Task Manager Application in a Gantt diagram.	Current Wiki
tasks	Tasks	Content	Display one or more tasks identified by their IDs.	Global
tasks-report-macro	Legacy Confluence bridge for Tasks Report	Content	Legacy Confluence bridge for Tasks Report.	Current Wiki
team	Team		Display avatars of the members of a team.	Current Wiki
template	Template	Development	Insert a template.	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 list of users with a customizable set of their properties	Global
userProfile	User Profile	Content	Displays a user profile with custom properties	Global
velocity	Velocity	Development	Executes a Velocity script.	Global
video	Video	Content	Display in your wiki page any video from Youtube, Dailymotion, Google Video or Vimeo. Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported. The video macro can also plays a DASH video (Dynamic Adaptive Streaming over HTTP).	Current Wiki
videoupload	Video upload		Display an input html element that allow you to upload videos and transcode them in order to play videos using DASH. For each uploaded video an entry will be added in the XWikiTube application home page.	Current Wiki
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
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}}