Available Macros

Last modified by Simon Urli on 2023/05/26 11:05

tocTable of contentsNavigationGenerates a table of contents.Global
scmscmDocumentationProduce scm linkGlobal
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Current Wiki
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
mentionUser MentionNotificationsInsert a user mention.Current Wiki
exampleExampleFormattingShows an example and its source code.Current Wiki
plantumlPlantUMLContentConvert various text input formats into diagram images using PlantUML.Global
asyncAsync macroContentExecute asynchronously and/or cache the macro content.Global
spaceindexSpace IndexDeprecatedLists the pages in a space.Current Wiki
poweredByPowered ByDisplays a random reference summaryGlobal
boxBoxFormattingDraw a box around provided content.Global
spacesSpacesDeprecatedDisplays all the spaces in this wiki.Current Wiki
errorError MessageFormattingDisplays an error message note.Global
attachmentGalleryPickerAttachment PickerDevelopmentGrid based attachment picker.Global
remotecodeRemote CodeDisplays the code (using the code macro) of a remote fileGlobal
warningWarning MessageFormattingDisplays a warning message note.Global
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
displayDisplayContentDisplay other pages into the current page.Global
translationTranslationContentDisplay a translation message.Global
contextContextDevelopmentExecutes content in the context of the passed pageGlobal
pdftocPDF Table of ContentsInternalGenerates the table of contents for the PDF export.Global
jiraJIRAContentFetches information from a JIRA server and displays them as a table, list or enumeration.Global
infoInfo MessageFormattingDisplays an info message note.Global
treeTreeNavigationDisplays a tree hierarchy defined by the macro content or the source parameter.Current Wiki
liveDataLive DataContentDisplay dynamic lists of data.Global
rssRSSContentOutput latest feed entries from a RSS feed.Global
successSuccess MessageFormattingDisplays a success message note.Global
documentTreePage TreeNavigationDisplays the tree of XWiki pages.Current Wiki
templateTemplateDevelopmentInsert a template.Global
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsDisplay the preferences of the current user about auto watched pages.Current Wiki
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
containerContainerLayoutA macro to enclose multiple groups and add decoration, such as layout.Global
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
pythonPythonDevelopmentExecutes a python script.Global
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
scriptScriptDevelopmentExecute script in provided script language.Global
languageLanguageList the flag and name for a given list of languagesGlobal
useravatarUser AvatarContentAllows displaying the avatar for a specific user.Global
displayIconIconContentDisplay an icon.Global
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
uiextensionsUI ExtensionsDevelopmentInsert UI extensions.Global
dashboardDashboardLayoutA macro to define a dashboard to fill with gadgets.Global
putFootnotesPut FootnoteContentDisplays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page.Global
diagramDiagramContentDisplays a diagram.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
notificationsApplicationsPreferencesNotifications Applications PreferencesNotificationsDisplay the preferences of the current user about notification applications.Current Wiki
imageImagecontentDisplays an image in a boxGlobal
cacheCacheDevelopmentCaches content.Global
menuMenuNavigationDisplays a menu created using simple wiki syntax (nested lists and links).Global
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
productVersionsProduct VersionscontentDisplay product versions for testingGlobal
documentsPagesContentDisplays a list of pages in a LivetableCurrent 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
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
notificationsNotificationsNotificationsDisplay notifications about events happened on the wiki.Current Wiki
velocityVelocityDevelopmentExecutes a Velocity script.Global
versionVersionContentSpecifies since which versions of XWiki the content of the macro corresponds to.Global
wikimacroparameterWikiMacro ParameterDevelopmentDisplay editable parameter of a wikimacro.Global
groovyGroovyDevelopmentExecute a groovy script.Global
showhideshowhidecontentShow Hide MacroGlobal
footnoteFootnoteContentGenerates a footnote to display at the end of the page.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