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

Radeox macros cannot be used in XWiki Syntax 2.1. Thus they have been rewritten as Rendering macros.

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

Macros in this wiki

tocTable Of ContentsNavigationGenerates a Table Of Contents.Global
scmscmDocumentationProduce scm linkGlobal
iconPickerIcon PickerDevelopmentSelect an icon within the XWiki icon set.Current Wiki
formulaFormulaContentDisplays a mathematical formula.Global
wikimacrocontentWikiMacro ContentDevelopmentDisplay editable content of a wikimacro.Global
blogPostLayoutFullBlog Post Layout FullThis macro is used to display a full blog postCurrent Wiki
ajaxajaxDelays the content of this macro as an Ajax Request callCurrent 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
asyncAsyncContentAsynchronous and cached execution of wiki content.Global
spaceindexSpace IndexDeprecatedLists documents 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
backwardCompatiblityReportAPI Backward Compatiblity ReportcontentCurrent Wiki
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
workspacesWorkspacesDeprecatedDeprecated macro that should not be used, here for compatibility reason. Please use the "wikis" macro instead.Current Wiki
displayChangesDisplay ChangescontentDisplay Release ChangesCurrent Wiki
releasenotechangesRelease Note ChangescontentCurrent Wiki
displayDisplayContentDisplay other pages into the current page.Global
translationTranslationContentDisplay a translation message.Global
contributorsTop ContributorsCurrent Wiki
contextContextDevelopmentExecutes content in the context of the passed documentGlobal
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
rssRSSContentOutput latest feed entries from a RSS feed.Global
blogsBlogs LivetableThe blogs macro is used to list on a livetable all the blog available on the wiki Current Wiki
successSuccess MessageFormattingDisplays a success message note.Global
documentTreeDocument TreeNavigationDisplays the tree of XWiki documents.Current Wiki
templateTemplateDevelopmentInsert a template.Global
notificationsAutoWatchPreferencesNotifications Auto Watch PreferencesNotificationsCurrent Wiki
chartChartContentDisplays a graphical chart generated from miscellaneous data sourcesGlobal
checkCheck MacroDisplaying a check or cross iconCurrent Wiki
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
blogPostLayoutLinkBlog Post Layout LinkThis macro is used to display a blog post as a simple linkCurrent 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
blogPostLayoutCardsCards Blog Post LayoutThis macro is used to display a blog post using the 'Cards' layoutCurrent Wiki
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
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
dashboardDashboardLayoutA macro to define a dashboard.Global
putFootnotesPut FootnoteContentDisplays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page.Global
wikisWikisNavigationList all wikisCurrent Wiki
html5videoHTML5 VideoContentPlay videos using the native HTML5 player.Current Wiki
attachmentSelectorAttachment SelectorDevelopmentA control to be used for object properties of the current document that are supposed to contain the name of an attachment from the current (or target) document. Allows uploading new attachments, and deleting attachments from the target document.  If no target document is specified, the current document will be used. Object properties are only saved to the current document.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
blogPostLayoutCompactBlog Post Layout CompactThis macro is used to display a full blog post in a compact modeCurrent 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
browserBrowserDisplays a browser entry containing the browser's icon, name and version. Meant to be used in Release Notes or Support browsers sections.Global
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
todoTodocontentTodo macroGlobal
imagePresimagePresCurrent Wiki
getChangesGet ChangesdevelopmentCollect Release Changes into an XWiki Context variableCurrent Wiki
documentsDocumentsContentDisplays a list of documents 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 PreferencesNotificationsDisplay the preferences of the current user about notification filters.Current Wiki
notificationsNotificationsNotificationsCurrent Wiki
velocityVelocityDevelopmentExecutes a Velocity script.Global
pdfviewerpdfviewerContentPDF Viewer based on Mozilla pdf.jsCurrent Wiki
faqFAQLists FAQ entriesCurrent Wiki
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
videoCardVideo CardDisplays a card with an embedded videoCurrent Wiki
latestBlogPostsLatest Blog PostsShows the latest blog posts articlesGlobal
codeCodeFormattingHighlights code snippets of various programming languagesGlobal
calendarCalendarContentDisplays a CalendarCurrent 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
Created by Admin on 2008/02/20

Get Connected