XWiki Syntaxes

Last modified by Vincent Massol on 2022/03/21

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!");
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

tocTable of contentsNavigationGenerates a table of contents.Global
ajaxajaxDelays the content of this macro as an Ajax Request callCurrent Wiki
mentionUser MentionNotificationsInsert a user mention.Current Wiki
exampleExampleFormattingShows an example and its source code.Current Wiki
blogPostLayoutImageBlog Post Layout ImageThis macro is used to display a full blog post with a thumbnail imageCurrent Wiki
asyncAsync macroContentExecute asynchronously and/or cache the macro content.Global
spaceindexSpace IndexDeprecatedLists the pages in a space.Current Wiki
spacesSpacesDeprecatedDisplays all the spaces in this wiki.Current Wiki
errorError MessageFormattingDisplays an error message note.Global
backwardCompatiblityReportAPI Backward Compatiblity ReportcontentCurrent Wiki
attachmentGalleryPickerAttachment PickerDevelopmentGrid based attachment picker.Global
warningWarning MessageFormattingDisplays a warning message note.Global
workspacesWorkspaces (Legacy)DeprecatedDeprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.Current Wiki
contributorsTop ContributorsCurrent Wiki
contextContextDevelopmentExecutes content in the context of the passed pageGlobal
pdftocPDF Table of ContentsInternalGenerates the table of contents for the PDF export.Global
liveDataLive DataContentDisplay dynamic lists of data.Global
rssRSSContentOutput latest feed entries from a RSS feed.Global
successSuccess MessageFormattingDisplays a success message note.Global
templateTemplateDevelopmentInsert a template.Global
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsDisplay the preferences of the current user about auto watched pages.Current Wiki
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
pythonPythonDevelopmentExecutes a python script.Global
blogPostLayoutCardsCards Blog Post LayoutThis macro is used to display a blog post using the 'Cards' layoutCurrent Wiki
scriptScriptDevelopmentExecute script in provided script language.Global
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
displayIconIconContentDisplay an icon.Global
languageLanguageList the flag and name for a given list of languagesGlobal
dashboardDashboardLayoutA macro to define a dashboard to fill with gadgets.Global
uiextensionsUI ExtensionsDevelopmentInsert UI extensions.Global
diagramDiagramContentDisplays a diagram.Current Wiki
wikisWikisNavigationList all wikisCurrent Wiki
html5videoHTML5 VideoContentPlay videos using the native HTML5 player.Current Wiki
cacheCacheDevelopmentCaches content.Global
blogPostLayoutCompactBlog Post Layout CompactThis macro is used to display a full blog post in a compact modeCurrent Wiki
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Current Wiki
browserBrowserDisplays a browser entry containing the browser's icon, name and version. Meant to be used in Release Notes or Support browsers sections.Global
todoTodocontentTodo macroGlobal
getChangesGet ChangesdevelopmentCollect Release Changes into an XWiki Context variableCurrent Wiki
imagePresimagePresCurrent Wiki
productVersionsProduct VersionscontentDisplay product versions for testingGlobal
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
databaseDatabaseDisplays a database entry containing the database's icon, name and version. Meant to be used in Release Notes or Support databases sections.Global
notificationsNotificationsNotificationsDisplay notifications about events happened on the wiki.Current Wiki
velocityVelocityDevelopmentExecutes a Velocity script.Global
pdfviewerPDF ViewerContentPDF Viewer based on Mozilla pdf.jsCurrent Wiki
versionVersionContentSpecifies since which versions of XWiki the content of the macro corresponds to.Global
faqFAQLists FAQ entriesCurrent Wiki
wikimacroparameterWikiMacro ParameterDevelopmentDisplay editable parameter of a wikimacro.Global
latestBlogPostsLatest Blog PostsShows the latest blog posts articlesGlobal
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
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
scmscmDocumentationProduce scm linkGlobal
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Current Wiki
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
blogPostLayoutFullBlog Post Layout FullThis macro is used to display a full blog postCurrent Wiki
plantumlPlantUMLContentConvert various text input formats into diagram images using PlantUML.Global
poweredByPowered ByDisplays a random reference summaryGlobal
boxBoxFormattingDraw a box around provided content.Global
remotecodeRemote CodeDisplays the code (using the code macro) of a remote fileGlobal
backwardCompatiblityReportXmlAPI Backward Compatiblity ReportcontentUses Revapi ignores defined in XML format.Current Wiki
messageSenderMessage SenderSocialA control that allows users to enter messages that are handled by the MessageStream module.Current Wiki
childrenChildrenNavigationDisplays a tree of children pages of the current pageCurrent Wiki
displayChangesDisplay ChangescontentDisplay Release ChangesCurrent Wiki
releasenotechangesRelease Note ChangescontentCurrent Wiki
displayDisplayContentDisplay other pages into the current page.Global
translationTranslationContentDisplay a translation message.Global
pollsrecentRecent PollsDisplays the N most recent polls.Current Wiki
jiraJIRAContentFetches information from a JIRA server and displays them as a table, list or enumeration.Global
codePrescodePresCurrent Wiki
infoInfo MessageFormattingDisplays an info message note.Global
treeTreeNavigationDisplays a tree hierarchy defined by the macro content or the source parameter.Current Wiki
blogsAll Blogs LivetableThe blogs macro is used to list on a livetable all the blog available on the wiki.Current Wiki
documentTreePage TreeNavigationDisplays the tree of XWiki pages.Current Wiki
checkCheck MacroDisplaying a check or cross iconCurrent Wiki
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Current Wiki
tagcloudTag CloudContentDisplays the cloud of tags in this wiki or in the specified space, if any.Current Wiki
activityActivity (legacy)NotificationsProvide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.Current Wiki
blogPostLayoutLinkBlog Post Layout LinkThis macro is used to display a blog post as a simple linkCurrent Wiki
commentCommentDevelopmentAllows putting comments in the source content. This macro doesn't output anything.Global
htmlHTMLDevelopmentInserts HTML or XHTML code into the page.Global
contentContentContentAllows writing content in any wiki markupGlobal
officeOffice Document ViewerContentView office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them.Global
galleryGalleryLayoutDisplays the images found in the provided content using a slide-show view.Global
uiextensionUI ExtensionDevelopmentInsert a UI extension.Global
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Current Wiki
putFootnotesPut FootnoteContentDisplays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page.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
notificationsApplicationsPreferencesNotifications Applications PreferencesNotificationsDisplay the preferences of the current user about notification applications.Current Wiki
imageImagecontentDisplays an image in a boxGlobal
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Global
blogpostcreateBlog Post CreateThe Blog Post Create macro is used to insert a post creation form. The macro takes a blog descriptor document as parameter. The new blog posts will belongs to the blog specified in the parameter.Current Wiki
backwardCompatibilityReport134API Backward Compatiblity ReportcontentUses Revapi ignores defined in XML format.Current Wiki
blogpostlistBlog post listThe BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates.Current Wiki
documentsPagesContentDisplays a list of pages in a LivetableCurrent Wiki
groovyGroovyDevelopmentExecute a groovy script.Global
showhideshowhidecontentShow Hide MacroGlobal
footnoteFootnoteContentGenerates a footnote to display at the end of the page.Global
videoCardVideo CardDisplays a card with an embedded videoCurrent Wiki

Get Connected