XWiki Syntax Guide

Last modified by Simon Urli on 2020/11/02

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

activityActivity (legacy)NotificationsProvide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream.Current Wiki
ajaxajaxDelays the content of this macro as an Ajax Request callCurrent 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
backwardCompatibilityReport134API Backward Compatiblity ReportcontentUses Revapi ignores defined in XML format.Current Wiki
backwardCompatiblityReportAPI Backward Compatiblity ReportcontentCurrent Wiki
backwardCompatiblityReportXmlAPI Backward Compatiblity ReportcontentUses Revapi ignores defined in XML format.Current Wiki
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
blogPostLayoutCardsCards Blog Post LayoutThis macro is used to display a blog post using the 'Cards' layoutCurrent Wiki
blogPostLayoutCompactBlog Post Layout CompactThis macro is used to display a full blog post in a compact modeCurrent Wiki
blogPostLayoutFullBlog Post Layout FullThis macro is used to display a full blog postCurrent Wiki
blogPostLayoutImageBlog Post Layout ImageThis macro is used to display a full blog post with a thumbnail imageCurrent Wiki
blogPostLayoutLinkBlog Post Layout LinkThis macro is used to display a blog post as a simple linkCurrent 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
blogsAll Blogs LivetableThe blogs macro is used to list on a livetable all the blog available on the wiki.Current Wiki
boxBoxFormattingDraw a box around provided content.Global
browserBrowserDisplays a browser entry containing the browser's icon, name and version. Meant to be used in Release Notes or Support browsers sections.Global
cacheCacheDevelopmentCaches content.Global
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
checkCheck MacroDisplaying a check or cross iconCurrent Wiki
childrenChildrenNavigationDisplays a tree of children pages of the current pageCurrent Wiki
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
codePrescodePresCurrent Wiki
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
contributorsTop ContributorsCurrent Wiki
dashboardDashboardLayoutA macro to define a dashboard to fill with gadgets.Global
databaseDatabaseDisplays a database entry containing the database's icon, name and version. Meant to be used in Release Notes or Support databases sections.Global
diagramDiagramContentDisplays a diagram.Current Wiki
displayDisplayContentDisplay other pages into the current page.Global
displayChangesDisplay ChangescontentDisplay Release ChangesCurrent Wiki
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
faqFAQLists FAQ entriesCurrent 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
getChangesGet ChangesdevelopmentCollect Release Changes into an XWiki Context variableCurrent Wiki
groovyGroovyDevelopmentExecute a groovy script.Global
htmlHTMLDevelopmentInserts HTML or XHTML code into the page.Global
html5videoHTML5 VideoContentPlay videos using the native HTML5 player.Current Wiki
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
imageImagecontentDisplays an image in a boxGlobal
imagePresimagePresCurrent Wiki
includeIncludeContentInclude other pages into the current page.Global
infoInfo MessageFormattingDisplays an info message note.Global
jiraJIRAContentFetches information from a JIRA server and displays them as a table, list or enumeration.Global
languageLanguageList the flag and name for a given list of languagesGlobal
latestBlogPostsLatest Blog PostsShows the latest blog posts articlesGlobal
liveDataLive DataContentDisplay dynamic lists of data.Global
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
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
pdftocPDF Table of ContentsInternalGenerates the table of contents for the PDF export.Global
pdfviewerPDF ViewerContentPDF Viewer based on Mozilla pdf.jsCurrent Wiki
plantumlPlantUMLContentConvert various text input formats into diagram images using PlantUML.Global
pollsrecentRecent PollsDisplays the N most recent polls.Current Wiki
poweredByPowered ByDisplays a random reference summaryGlobal
productVersionsProduct VersionscontentDisplay product versions for testingGlobal
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
releasenotechangesRelease Note ChangescontentCurrent Wiki
remotecodeRemote CodeDisplays the code (using the code macro) of a remote fileGlobal
scmscmDocumentationProduce scm linkGlobal
scriptScriptDevelopmentExecute script in provided script language.Global
showhideshowhidecontentShow Hide MacroGlobal
spaceindexSpace IndexDeprecatedLists the pages in a space.Current Wiki
spacesSpacesDeprecatedDisplays all the spaces in this wiki.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
templateTemplateDevelopmentInsert a template.Global
tocTable of contentsNavigationGenerates a table of contents.Global
todoTodocontentTodo macroGlobal
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
velocityVelocityDevelopmentExecutes a Velocity script.Global
versionVersionContentSpecifies since which versions of XWiki the content of the macro corresponds to.Global
videoCardVideo CardDisplays a card with an embedded videoCurrent 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
workspacesWorkspaces (Legacy)DeprecatedDeprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead.Current Wiki

Get Connected