XWiki Syntax Guide

Last modified by Ricardo Julio Rodríguez Fernández on 2024/01/24 10:12

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
addCheckboxColumnToLivetable	Livetable Checkbox Column Macro		Adding a column containing checkboxes that allows selecting multiple rows in a given livetable and manipulating the values of a given column by sending the data to the given service.	Current Wiki
addExcelExportToLivetable	Add Excel export to Livetable		Add a button that can export the current livetable as an Excel file.	Global
async	Async macro	Content	Execute asynchronously and/or cache the macro content.	Global
attachmentGalleryPicker	Attachment Picker	Development	Grid based attachment picker.	Global
attachments	Attachments		Displays the list of attachments for a given document using a live table.	Current Wiki
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
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
diagram	Diagram	Content	Displays a diagram.	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
figure	Figure	Development	Tag content as an illustration and with an optional caption.	Global
figureCaption	Figure Caption	Development	Provide a figure caption when used inside the Figure macro.	Global
figureTypeRecognizer	Figure Type Recognizer	Internal	Internal macro used to recognize the type of a figure.	Global
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
glossary	glossary	Navigation	Lists all the Glossary Entries located under the current page, in a table	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
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
job	Job	Development	Execute the macro content asynchronously and display progress.	Global
jobprogress	Job Progress	Internal	Provide a UI to follow asynchronous job progression	Current Wiki
kanban	Kanban		Kanban macro allowing to display and edit a kanban	Current Wiki
kroki	Kroki		Macro inserting a diagram in a chosen format generated by kroki	Global
liveData	Live Data	Content	Display dynamic lists of data.	Global
livetable	livetable	navigation	Displays a standard livetable for a specific XWiki class and the chosen fields	Global
livetableExporter	Add exporter button to a livetable		Add a button that can export the current livetable to a CSV or Excel file.	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
missingLicenseMessage	Missing License Message		Display an error message when the extension does not have a valid license.	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
parentschildrenlivetable	Parents and Children Livetable		Display a livetable containing one level of parent-children granularity, where parent is defined by a document in the given space that is not the space home page, has no parent or it's parent is the space home page.	Current Wiki
pdftoc	PDF Table of Contents	Internal	Generates the table of contents for the PDF export.	Global
php	PHP	Development	Executes a PHP script.	Global
plantuml	PlantUML	Content	Convert various text input formats into diagram images using PlantUML.	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
query	query	content	Shows results of a query in a table	Global
ruby	Ruby	Development	Execute a ruby script.	Global
script	Script	Development	Execute script in provided script language.	Global
sortable_tables	Sorteable Tables		Makes all tables in the content of the current page sortable.	Global
success	Success Message	Formatting	Displays a success message note.	Global
SuggestLiveTableFilter	Suggest LiveTable Filter	Development	Transform the LiveTable filter input into suggest inorder to filter by the key ( for eg : XWiki.User1 ), we can use this macros on a dbList field property. This macro should be called before the livetable macro	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.	Global
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
xuml	XWiki Class UML Diagram	information	Display a class diagram for XWiki class(es) defined in a specific space, by default current space.	Global

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}}