XWiki Syntax Guide

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

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

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
anchorAnchor MacroConfluence Anchor macro bridge to the XWiki Id macroCurrent Wiki
asyncAsync macroContentExecute asynchronously and/or cache the macro content.Global
attachmentGalleryPickerAttachment PickerDevelopmentGrid based attachment picker.Global
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
boxBoxFormattingDraw a box around provided content.Global
buttonButton MacroInsert a noticeable, clickable button on your XWiki page to highlight links and create call to actions!Current Wiki
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
columnColumn MacroAdd the column macro to a page to organize your content in columns. This macro is used in conjunction with the Section macro, and provides more flexibility than page layouts.Current Wiki
commentCommentDevelopmentAllows putting comments in the source content. This macro doesn't output anything.Global
confluence_attachmentsAttachmentsConfluence attachment macro support for XWikiCurrent Wiki
confluence_childrenChildren PagesA wrapper for the document tree macro that supports confluence parameter names.Current Wiki
confluence_galleryConfluence Gallery contentBridge for the Confluence gallery macro.Current Wiki
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
contentContentContentAllows writing content in any wiki markupGlobal
content-report-tableContent Report Table MacrocontentProvides a content report in table format, based on labels.Current Wiki
contextContextDevelopmentExecutes content in the context of the passed pageGlobal
contributorsContributorsContributors Confluence Bridge macro to show the contributors of a given document.Current Wiki
dashboardDashboardLayoutA macro to define a dashboard to fill with gadgets.Global
diagramDiagramContentDisplays a diagram.Current Wiki
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
drawioDrawioBridge between the Confluence Drawio macro and the XWiki Diagram macro. By default it displays the PNG file used by Drawio to preview the diagram. The user has the option to convert the Drawio diagram into an XWiki Diagram for being able to modify it.Current Wiki
errorError MessageFormattingDisplays an error message note.Global
exampleExampleFormattingShows an example and its source code.Current Wiki
excerptExcerptcontentBridge for the Confluence Excerpt macro. It marks part of the page's content for use by other macros.Current Wiki
excerpt-includeExcerpt includeBridge for the Confluence Excerpt Include macro, includes excerpts from other document.Current Wiki
expandExpandAdd 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
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
gliffyGliffyBridge between the Confluence Gliffy macro and the XWiki Diagram macro. By default it displays the PNG file used by Gliffy to preview the diagram. The user has the option to convert the Gliffy diagram into an XWiki Diagram for being able to modify it.Current Wiki
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
jwplayerJW PlayerContentThe 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
layoutLayout MacrocontentConfluence bridge macro to define a layout, containing layout sections (using the layout-section macro).Current Wiki
layout-cellLayout Cell MacrocontentConfluence bridge macro used for defining a part a layout section, used inside the layout-section macro.Current Wiki
layout-sectionLayout Section MacrocontentConfluence bridge macro to define a section of a layout, used inside the layout macro and containing layout cells.Current Wiki
liveDataLive DataContentDisplay dynamic lists of data.Global
locationSearchLocation SearchSearch in the given location.Current Wiki
mathblockMath BlockConfluence bridge macro for LaTeX math blocks.Current Wiki
mathblock-refMath Block ReferenceConfluence bridge macro to reference math blocks.Current Wiki
mathinlineMath InlineConfluence bridge macro for LaTeX math inline expressions.Current Wiki
mathjaxMathJaxcontentCurrent Wiki
mentionUser MentionNotificationsInsert a user mention.Current Wiki
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Global
messageSenderMessage SenderSocialA control that allows users to enter messages that are handled by the MessageStream module.Current Wiki
missingLicenseMessageMissing License MessageDisplay an error message when the extension does not have a valid license.Global
mockupMockupBridge for the Confluence Balsamiq macro. It only displays the image preview of the mockup. Current Wiki
msStreamMicrosoft StreamContentEmbed a Microsoft Stream video in a page by simply passing the URL and any customization parameters.Current Wiki
multimediaMultimedia MacroBridge for the Confluence Multimedia macro.Current Wiki
net-presago-stream-macroMicrosoft Stream Confluence BridgeContentBridge for the Confluence Microsoft Stream Macro.
noteNoteAdd a Note macro to your page to make important information stand out. The macro is used to format your text in a colored panel.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
pagetreePage Tree (Confluence bridge)Bridge for the Confluence Page Tree macro.Current Wiki
panelPanel MacrocontentPanel macro to display XWiki content inside a panel.Current Wiki
paste-code-macroPaste Code MacroBridge between the Confluence Paste Code macro and the XWiki Code macro.Current Wiki
pdftocPDF Table of ContentsInternalGenerates the table of contents for the PDF export.Global
pdfviewerPDF ViewerPDF Viewer based on Mozilla pdf.jsGlobal
profile-pictureProfile PictureConfluence Profile Picture macroCurrent Wiki
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
recently-updatedRecently UpdatedconfluenceAdd 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
scriptScriptDevelopmentExecute script in provided script language.Global
sectionSection MacrocontentAdd the Section macro to a page to organize your content in sections and columns. This macro is used in conjunction with the Column macro, and provides more flexibility than page layouts.
spaceindexSpace IndexDeprecatedLists the pages in a space.Current Wiki
spacesSpacesDeprecatedDisplays all the spaces in this wiki.Current Wiki
statusStatusInsert a colored label in the text to highlight the status of an item.Current Wiki
successSuccess MessageFormattingDisplays a success message note.Global
tagcloudTag CloudContentDisplays the cloud of tags in this wiki or in the specified space, if any.Current Wiki
teamTeamDisplay avatars of the members of a team.Current Wiki
templateTemplateDevelopmentInsert a template.Global
timeTime MacroConfluence Time macroCurrent Wiki
tipTipConfluence Tip macro bridge to the XWiki Success macroCurrent Wiki
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.Current Wiki
uiextensionUI ExtensionDevelopmentInsert a UI extension.Global
uiextensionsUI ExtensionsDevelopmentInsert UI extensions.Global
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
userListUser ListDisplays a list of users with a customizable set of their propertiesGlobal
userlisterUser ListerConfluence bridge macro to list users of groupsCurrent Wiki
userProfileUser ProfileDisplays a user profile with custom propertiesGlobal
velocityVelocityDevelopmentExecutes a Velocity script.Global
view-fileView FilescontentShow files using PDF Viewer Macro or Office ViewerCurrent Wiki
viewdocView DoccontentView Office Word documents.Current Wiki
viewpdfView PdfcontentView Pdf documents.Current Wiki
viewpptView PptcontentView Office Powepoint documents.Current Wiki
viewxlsView XlscontentView Office Excel documents.Current Wiki
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
wireframeBalsamiq WireframeBridge for the Confluence Balsamiq macro. It only displays the image preview of the wireframe. Current Wiki
workspacesWorkspaces (Legacy)DeprecatedDeprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.Current Wiki