XWiki Syntax Guide
Last modified by Ryan C on 2025/03/06 17:59
XWiki Syntax 2.1 » Programming » Macros
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"/}}
| Feature | XWiki Syntax 2.1 | Result |
|---|---|---|
| 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 |
Macros in this wiki
| Id | Name | Categories | Description | Visibility |
|---|---|---|---|---|
| activity | Activity (legacy) | Notifications | Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream. | Current Wiki |
| actualrights | Actual Rights Macro | This macro will be used to display the actual rights table of a given page. | Current Wiki | |
| async | Async macro | Content | Execute asynchronously and/or cache the macro content. | Global |
| attachmentGalleryPicker | Attachment Picker | Development | Grid based attachment picker. | Global |
| attachmentSelector | Attachment Selector | Development | A 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 |
| awmkanban | Kanban board for AppWithinMinutes | Display XWiki Documents from an AWM as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Global | |
| box | Box | Formatting | Draw a box around provided content. | Global |
| button | Button Macro | Insert a noticeable, clickable button on your XWiki page to highlight links and create call to actions! | Current Wiki | |
| cache | Cache | Development | Caches content. | Global |
| carousel | carousel | Content | Generates a carousel displaying the images attached to the current page or a referenced one. | Current Wiki |
| chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global |
| children | Children | Navigation | Displays a tree of children pages of the current page | Current Wiki |
| code | Code | Formatting | Highlights code snippets of various programming languages | Global |
| comment | Comment | Development | Allows putting comments in the source content. This macro doesn't output anything. | Global |
| container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global |
| content | Content | Content | Allows writing content in any wiki markup | Global |
| content-report-table | Content Report Table Macro | Content | Provides a content report in table format, based on labels. | Current Wiki |
| context | Context | Development | Executes content in the context of the passed page | Global |
| contributors | Contributors | Content | Contributors Confluence Bridge macro to show the contributors of a given document. | Current Wiki |
| dashboard | Dashboard | Layout | A macro to define a dashboard to fill with gadgets. | Global |
| display | Display | Content | Display other pages into the current page. | Global |
| displayIcon | Icon | Content | Display an icon. | Global |
| documents | Pages | Content | Displays a list of pages in a Livetable | Current Wiki |
| documentTree | Page Tree | Navigation | Displays the tree of XWiki pages. | Current Wiki |
| embed | Embed content | Content | Show in your wiki page many external content. Currently this support theses external services: * Youtube, * Dailymotion, * Vimeo, * x.com, * Google doc, sheets and slides, * Google calendar, * Google maps, * Facebook, * Linkedin, * Figma, * Spotify, * Prezi, * Flickr, * Viddler, * Aha! roadmaps, * Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported. | Current Wiki |
| error | Error Message | Formatting | Displays an error message note. | Global |
| example | Example | Formatting | Shows an example and its source code. | Global |
| excerpt | Excerpt | Excerpt macro. It marks part of the page's content for use by other macros. It is compatible with the Confluence Excerpt macro. | Current Wiki | |
| expand | Expand | Add 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 | |
| expandable | Expandable | Similar to an HTML “<details>” element, this macro enables more extensive information to be displayed first in short form and the exact details to be displayed only when the mouse is clicked. If several of these Expandable elements are arranged directly on top of each other, they form an accordion component. | Global | |
| expandableThumbnailSkinExtensionID | expandableThumbnailSkinExtension | Skin extension to automatically create expandable thumbnails for images. | Global | |
| faq | FAQ | Lists FAQ entries | Current Wiki | |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| forum.recentForumDiscussions | Recent Forum Discussions | Content | Lists the top N most recent discussions from all the forums A discussion is considered recent if: * new topic is created on a forum * new topic is edited of a forum * new answer is created on a topic * new answer is edited (this will include comment added and comment edited) | Current Wiki |
| gallery | Gallery | Layout | Displays the images found in the provided content using a slide-show view. | Global |
| gdprSettings | Gdpr settings | Get what kind of cookies the current user has consented to. (preferences, statistics or marketing) | Current Wiki | |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| html | HTML | Development | Inserts HTML or XHTML code into the page. | Global |
| iconPicker | Icon Picker | Development | Select an icon within the XWiki icon set. | Current Wiki |
| id | Id | Navigation | Allows 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 |
| include | Include | Content | Include other pages into the current page. | Global |
| info | Info Message | Formatting | Displays an info message note. | Global |
| infobox | infobox | Current Wiki | ||
| infocard | Info Card | Fancy two-column encyclopedia layout | ||
| jwplayer | JW Player | Content | The 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 |
| kanban | Kanban | Kanban macro allowing to display and edit a kanban | Current Wiki | |
| kanbanboard | Kanban board | Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Current Wiki | |
| label | label | Current Wiki | ||
| link | link | Current Wiki | ||
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| locationSearch | Location search | Search in the given location. | Current Wiki | |
| mention | User Mention | Notifications | Insert a user mention. | Current Wiki |
| menu | Menu | Navigation | Displays a menu created using simple wiki syntax (nested lists and links). | Global |
| msStream | Microsoft Stream | Embed a Microsoft Stream video in a page by simply passing the URL and any customization parameters. | Current Wiki | |
| notifications | Notifications | Notifications | Display notifications about events happened on the wiki. | Current Wiki |
| notificationsApplicationsPreferences | Notifications Applications Preferences | Notifications | Display the preferences of the current user about notification applications. | Current Wiki |
| notificationsAutoWatchPreferences | Notifications Auto Watch Preferences | Notifications | Display the preferences of the current user about auto watched pages. | Current Wiki |
| notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Current Wiki |
| notificationsEmailPreferences | Notifications Email Preferences | Notifications | Display the preferences of the current user about notification emails. | Current Wiki |
| notificationsFiltersPreferences | Notifications Filters Preferences (deprecated) | Notifications | Display 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 |
| notificationsSystemFiltersPreferences | Notifications System Filters Preferences | Notifications | Display the preferences of the given user about system notification filters. | Current Wiki |
| office | Office Document Viewer | Content | View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them. | Global |
| opus | opus | Current Wiki | ||
| panel | Panel Macro | Panel macro to display XWiki content inside a panel. | Current Wiki | |
| PDF Object Embed | This macro allows embedding a PDF file in a wiki page using the <object> tag. | Global | ||
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | Global |
| pdfviewer | PDF Viewer | Content | PDF Viewer based on Mozilla pdf.js | Current Wiki |
| profile-picture | Profile Picture | Content | Display the profile picture of selected user. | Current Wiki |
| putFootnotes | Put Footnotes | Content | Displays all the footnotes from the page. If missing, all footnotes are displayed by default at the end of the page. | Global |
| python | Python | Development | Executes a python script. | Global |
| recently-updated | Recently Updated | Content | Add 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 |
| redmine | Redmine Ticket | Listet Tickets vom Redmine Ticketsystem in einer Tabelle auf. | Global | |
| script | Script | Development | Execute script in provided script language. | Global |
| status | Status | Insert a colored label in the text to highlight the status of an item. | Current Wiki | |
| success | Success Message | Formatting | Displays a success message note. | Global |
| tagcloud | Tag Cloud | Content | Displays the cloud of tags in this wiki or in the specified space, if any. | Current Wiki |
| tagList | Tag list | Show a list of all the macros in your instance. | Current Wiki | |
| taskcard | Task card | Display a task and its information as a card. | Current Wiki | |
| team | Team | Display avatars of the members of a team. | Current Wiki | |
| template | Template | Development | Insert a template. | Global |
| time | time | Current Wiki | ||
| toc | Table of contents | Navigation | Generates a table of contents. | Global |
| tocplusinfobox | TOC Plus Infobox | Template with right-aligned infobox and TOC at the top | Current Wiki | |
| todolist | todolist | TodoList with Javascript UI | Current Wiki | |
| tooltip | Tooltip | Current Wiki | ||
| translation | Translation | Content | Display a translation message. | Global |
| tree | Tree | Navigation | Displays a tree hierarchy defined by the macro content or the source parameter. | Current Wiki |
| uiextension | UI Extension | Development | Insert a UI extension. | Global |
| uiextensions | UI Extensions | Development | Insert UI extensions. | Global |
| useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | Global |
| value | value | Current Wiki | ||
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| video | Video | Content | Display in your wiki page any video from Youtube, Dailymotion, Google Video or Vimeo. Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported. The video macro can also plays a DASH video (Dynamic Adaptive Streaming over HTTP). | Current Wiki |
| view-file | View file | Content | Show a file using PDF Viewer Macro or Office Viewer. | Current Wiki |
| warning | Warning Message | Formatting | Displays a warning message note. | Global |
| wikimacrocontent | WikiMacro Content | Development | Display editable content of a wikimacro. | Global |
| wikimacroparameter | WikiMacro Parameter | Development | Display editable parameter of a wikimacro. | Global |
| wikis | Wikis | Navigation | List all wikis | Current Wiki |
| workspaces | Workspaces (Legacy) | Deprecated | Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead. | Current Wiki |
| zone | Zone macro | code | Macro to display content from a document passed as parameter | Current Wiki |