XWiki Syntax Guide
Last modified by Sascha Hoppe on 2023/07/06 10:42
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 | Category | Description | Visibility |
|---|---|---|---|---|
| toc | Table Of Contents | Navigation | Generates a Table Of Contents. | Global |
| viewppt | View Ppt | content | View Office Powepoint documents. | Global |
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| mention | User Mention | Notifications | Inserts a user mention. | Current Wiki |
| anchor | Anchor Macro | Confluence Anchor macro bridge to the XWiki Id macro | Global | |
| userList | User list | Displays a custom list of users with their avatar | Global | |
| async | Async | Content | Asynchronous and cached execution of wiki content. | Global |
| spaceindex | Space Index | Deprecated | Lists documents in a space. | Current Wiki |
| excerpt | Excerpt | content | Bridge for the Confluence Excerpt macro. It marks part of the page's content for use by other macros. | Global |
| spaces | Spaces | Deprecated | Displays all the spaces in this wiki. | Current Wiki |
| error | Error Message | Formatting | Displays an error message note. | Global |
| attachmentGalleryPicker | Attachment Picker | Development | Grid based attachment picker. | Global |
| warning | Warning Message | Formatting | Displays a warning message note. | Global |
| workspaces | Workspaces | Deprecated | Deprecated macro that should not be used, here for compatibility reason. Please use the "wikis" macro instead. | Current Wiki |
| context | Context | Development | Executes content in the context of the passed document | Global |
| drawio | Drawio | Bridge between the Confluence Drawio macro and the XWiki Diagram macro. By default it displays the PNG file used by Drawio to preview the diagram. The user has the option to convert the Drawio diagram into an XWiki Diagram for being able to modify it. | Global | |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| rss | RSS | Content | Output latest feed entries from a RSS feed. | Global |
| success | Success Message | Formatting | Displays a success message note. | Global |
| template | Template | Development | Insert a template. | Global |
| chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global |
| notificationsAutoWatchPreferences | Notifications Auto Watch Preferences | Notifications | Current Wiki | |
| panel | Panel Macro | content | Display a panel with styles | Global |
| container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global |
| layout-section | Layout Section Macro | content | Global | |
| content-report-table | Content Report Table Macro | content | Provides a content report in table format, based on labels. | Global |
| python | Python | Development | Executes a python script. | Global |
| layout | Layout Macro | content | Global | |
| script | Script | Development | Execute script in provided script language. | Global |
| useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | Global |
| dashboard | Dashboard | Layout | A macro to define a dashboard. | Global |
| uiextensions | UI Extensions | Development | Insert UI extensions. | Global |
| wikis | Wikis | Navigation | List all wikis | Current Wiki |
| cache | Cache | Development | Caches content. | Global |
| notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Current Wiki |
| job | Job | Development | Execute the macro content asynchronously and display progress. | Global |
| paste-code-macro | Paste Code Macro | Bridge between the Confluence Paste Code macro and the XWiki Code macro. | Global | |
| 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 |
| button | Button | Insert a button! | Global | |
| notifications | Notifications | Notifications | Current Wiki | |
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| pdfviewer | PDF Viewer | View PDF attachments inside wiki pages without downloading or importing them. | Global | |
| status | Status | Insert a colored label in the text to highlight the status of an item. | Global | |
| wikimacroparameter | WikiMacro Parameter | Development | Display editable parameter of a wikimacro. | Global |
| code | Code | Formatting | Highlights code snippets of various programming languages | Global |
| view-file | View Files | content | Show files using PDF Viewer Macro or Office Viewer | Global |
| 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 |
| 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.|Global
| iconPicker | Icon Picker | Development | Select an icon within the XWiki icon set. | Current Wiki |
| formula | Formula | Content | Displays a mathematical formula. | Global |
| wikimacrocontent | WikiMacro Content | Development | Display editable content of a wikimacro. | Global |
| confluence_attachments | Attachments | Confluence attachment macro support for XWiki | Global | |
| box | Box | Formatting | Draw a box around provided content. | Global |
| viewpdf | View Pdf | content | View Pdf documents. | Global |
| section | Section | content | Global | |
| messageSender | Message Sender | Social | A control that allows users to enter messages that are handled by the MessageStream module. | Current Wiki |
| column | Column | Global | ||
| children | Children | Navigation | Displays a tree of children pages of the current page | Current Wiki |
| note | Note | Write a note. | Global | |
| display | Display | Content | Display other pages into the current page. | Global |
| translation | Translation | Content | Display a translation message. | Global |
| multimedia | Multimedia Macro | content | Bridge for the Confluence Multimedia macro. | Global |
| info | Info Message | Formatting | Displays an info message note. | Global |
| tree | Tree | Navigation | Displays a tree hierarchy defined by the macro content or the source parameter. | Current Wiki |
| documentTree | Document Tree | Navigation | Displays the tree of XWiki documents. | Current Wiki |
| net-presago-stream-macro | Microsoft Stream Confluence Bridge | Content | Bridge for the Confluence Microsoft Stream Macro. | Global |
| notificationsEmailPreferences | Notifications Email Preferences | Notifications | Display the preferences of the current user about notification emails. | Current Wiki |
| tagcloud | Tag Cloud | Content | Displays the cloud of tags in this wiki or in the specified space, if any. | Current Wiki |
| activity | Activity (legacy) | Notifications | Provide a macro implemented with the Notifications Application to keep a backward compatibility with Activity Stream. | Current Wiki |
| comment | Comment | Development | Allows putting comments in the source content. This macro doesn't output anything. | Global |
| html | HTML | Development | Inserts HTML or XHTML code into the page. | Global |
| content | Content | Content | Allows writing content in any wiki markup | Global |
| viewdoc | View Doc | content | View Office Word documents. | Global |
| office | Office Document Viewer | Content | View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them. | Global |
| gallery | Gallery | Layout | Displays the images found in the provided content using a slide-show view. | Global |
| layout-cell | Layout Cell Macro | content | Global | |
| uiextension | UI Extensions | Development | Insert a UI extension. | Global |
| notificationsSystemFiltersPreferences | Notifications System Filters Preferences | Notifications | Display the preferences of the given user about system notification filters. | Current Wiki |
| recently-updated | Recently Updated | confluence | 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. | Global |
| putFootnotes | Put Footnote | Content | Displays the footnotes defined so far. If missing, all footnotes are displayed by default at the end of the page. | Global |
| attachmentSelector | Attachment Selector | Development | A 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 |
| notificationsApplicationsPreferences | Notifications Applications Preferences | Notifications | Display the preferences of the current user about notification applications. | Current Wiki |
| menu | Menu | Navigation | Displays a menu created using simple wiki syntax (nested lists and links). | Global |
| jobprogress | Job Progress | Internal | Provide a UI to follow asynchronous job progression | Current Wiki |
| wireframe | Balsamiq Wireframe | Bridge for the Confluence Balsamiq macro. It only displays the image preview of the wireframe. | Global | |
| gliffy | Gliffy | Bridge between the Confluence Gliffy macro and the XWiki Diagram macro. By default it displays the PNG file used by Gliffy to preview the diagram. The user has the option to convert the Gliffy diagram into an XWiki Diagram for being able to modify it. | Global | |
| viewxls | View Xls | content | View Office Excel documents. | Global |
| documents | Documents | Content | Displays a list of documents in a Livetable | Current Wiki |
| team | Team | content | This macro displays the team members which have a specific tag | Global |
| msStream | Microsoft Stream | Content | Embed a Microsoft Stream video in a page by simply passing the URL and any customization parameters. | Global |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| userlister | User Lister | This macro displays the members of the given group(s). | Global | |
| 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 |
| userProfile | User profile | Displays a user profile with custom set of properties | Global | |
| confluence_gallery | Confluence Gallery | content | Bridge for the Confluence gallery macro. | Global |
| tip | Tip | Global | ||
| mockup | Mockup | Bridge for the Confluence Balsamiq macro. It only displays the image preview of the mockup. | Global |