XWiki Syntax Guide

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

XWiki Syntax 2.1: 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"/}}

FeatureXWiki Syntax 2.1Result
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
Information

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

Macros in this wiki

IdNameCategoriesDescriptionVisibility
activityActivity (legacy)NotificationsProvide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.Current Wiki
addCheckboxColumnToLivetableLivetable Checkbox Column MacroAdding 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
addExcelExportToLivetableAdd Excel export to LivetableAdd a button that can export the current livetable as an Excel file.Global
asyncAsync macroContentExecute asynchronously and/or cache the macro content.Global
attachmentGalleryPickerAttachment PickerDevelopmentGrid based attachment picker.Global
attachmentsAttachmentsDisplays the list of attachments for a given document using a live table.Current Wiki
attachmentSelectorAttachment SelectorDevelopmentA 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
awmkanbanKanban board for AppWithinMinutesDisplay XWiki Documents from an AWM as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board).Global
boxBoxFormattingDraw a box around provided content.Global
cacheCacheDevelopmentCaches content.Global
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
childrenChildrenNavigationDisplays a tree of children pages of the current pageCurrent Wiki
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
commentCommentDevelopmentAllows putting comments in the source content. This macro doesn't output anything.Global
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
contentContentContentAllows writing content in any wiki markupGlobal
contextContextDevelopmentExecutes content in the context of the passed pageGlobal
dashboardDashboardLayoutA macro to define a dashboard to fill with gadgets.Global
diagramDiagramContentDisplays a diagram.Global
displayDisplayContentDisplay other pages into the current page.Global
displayIconIconContentDisplay an icon.Global
documentsPagesContentDisplays a list of pages in a LivetableCurrent Wiki
documentTreePage TreeNavigationDisplays the tree of XWiki pages.Current Wiki
errorError MessageFormattingDisplays an error message note.Global
exampleExampleFormattingShows an example and its source code.Current Wiki
figureFigureDevelopmentTag content as an illustration and with an optional caption.Global
figureCaptionFigure CaptionDevelopmentProvide a figure caption when used inside the Figure macro.Global
figureTypeRecognizerFigure Type RecognizerInternalInternal macro used to recognize the type of a figure.Global
footnoteFootnoteContentGenerates a footnote to display at the end of the page.Global
galleryGalleryLayoutDisplays the images found in the provided content using a slide-show view.Global
glossaryglossaryNavigationLists all the Glossary Entries located under the current page, in a tableCurrent Wiki
glossaryEntriesglossaryEntriesNavigationLists all glossary entries from a glossary, as a listGlobal
glossaryReferenceGlossaryReferenceNavigationReferences a glossary entryGlobal
groovyGroovyDevelopmentExecute a groovy script.Global
htmlHTMLDevelopmentInserts HTML or XHTML code into the page.Global
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Current Wiki
idIdNavigationAllows 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
includeIncludeContentInclude other pages into the current page.Global
infoInfo MessageFormattingDisplays an info message note.Global
jobJobDevelopmentExecute the macro content asynchronously and display progress.Global
jobprogressJob ProgressInternalProvide a UI to follow asynchronous job progressionCurrent Wiki
kanbanKanbanKanban macro allowing to display and edit a kanbanCurrent Wiki
krokiKrokiMacro inserting a diagram in a chosen format generated by krokiGlobal
liveDataLive DataContentDisplay dynamic lists of data.Global
livetablelivetablenavigationDisplays a standard livetable for a specific XWiki class and the chosen fieldsGlobal
livetableExporterAdd exporter button to a livetableAdd a button that can export the current livetable to a CSV or Excel file.Global
mentionUser MentionNotificationsInsert a user mention.Current Wiki
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Global
missingLicenseMessageMissing License MessageDisplay an error message when the extension does not have a valid license.Global
notificationsNotificationsNotificationsDisplay notifications about events happened on the wiki.Current Wiki
notificationsApplicationsPreferencesNotifications Applications PreferencesNotificationsDisplay the preferences of the current user about notification applications.Current Wiki
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsDisplay the preferences of the current user about auto watched pages.Current Wiki
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Current Wiki
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Current Wiki
notificationsFiltersPreferencesNotifications Filters Preferences (deprecated)NotificationsDisplay 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
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Current Wiki
officeOffice Document ViewerContentView office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.Global
parentschildrenlivetableParents and Children LivetableDisplay 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
pdftocPDF Table of ContentsInternalGenerates the table of contents for the PDF export.Global
phpPHPDevelopmentExecutes a PHP script.Global
plantumlPlantUMLContentConvert various text input formats into diagram images using PlantUML.Global
putFootnotesPut FootnotesContentDisplays all the footnotes from the page. If missing, all footnotes are displayed by default at the end of the page.Global
pythonPythonDevelopmentExecutes a python script.Global
queryquerycontentShows results of a query in a tableGlobal
rubyRubyDevelopmentExecute a ruby script.Global
scriptScriptDevelopmentExecute script in provided script language.Global
sortable_tablesSorteable TablesMakes all tables in the content of the current page sortable.Global
successSuccess MessageFormattingDisplays a success message note.Global
SuggestLiveTableFilterSuggest LiveTable FilterDevelopmentTransform 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
tagcloudTag CloudContentDisplays the cloud of tags in this wiki or in the specified space, if any.Current Wiki
templateTemplateDevelopmentInsert a template.Global
tocTable of contentsNavigationGenerates a table of contents.Global
translationTranslationContentDisplay a translation message.Global
treeTreeNavigationDisplays a tree hierarchy defined by the macro content or the source parameter.Global
uiextensionUI ExtensionDevelopmentInsert a UI extension.Global
uiextensionsUI ExtensionsDevelopmentInsert UI extensions.Global
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
velocityVelocityDevelopmentExecutes a Velocity script.Global
warningWarning MessageFormattingDisplays a warning message note.Global
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
wikimacroparameterWikiMacro ParameterDevelopmentDisplay editable parameter of a wikimacro.Global
wikisWikisNavigationList all wikisCurrent Wiki
workspacesWorkspaces (Legacy)DeprecatedDeprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.Current Wiki
xumlXWiki Class UML DiagraminformationDisplay a class diagram for XWiki class(es) defined in a specific space, by default current space.Global