XWiki - Available Macros 

Page / - last modified by Bimit Administrator on 29.04.2025, 12:21 

Available Macros 
last modified by Bimit Administrator
on 29.04.2025, 12:21

Table of Contents

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	
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	
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	
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	
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	
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	
groovy	Groovy	Development	Execute a groovy script.	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	
liveData	Live Data	Content	Display dynamic lists of data.	Global	
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	
messageSender	Message Sender	Social	A control that allows users to enter messages that are handled by the MessageStream module.	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	
pdftoc	PDF Table of Contents	Internal	Generates the table of contents for the PDF export.	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	
spaceindex	Space Index	Deprecated	Lists the pages in a space.	Current Wiki	
spaces	Spaces	Deprecated	Displays all the spaces in this wiki.	Current Wiki	
success	Success Message	Formatting	Displays a success message note.	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	
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	
velocity	Velocity	Development	Executes a Velocity script.	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