XWiki Syntax Guide
Last modified by admin on 2021/04/30 23:07
XWiki Syntax 2.0 » Programming » Macros
XWiki Syntax 2.0: Macros
2.0 Macros
There is only one kind of macro in XWiki Syntax 2.0, 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.0 | 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 |
| anchor | Legacy Confluence bridge for Anchor | Deprecated | Legacy Confluence bridge for Anchor | Global |
| 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 |
| 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! | Global | |
| cache | Cache | Development | Caches content. | Global |
| 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 |
| column | Confluence bridge for Column | Deprecated | Confluence bridge for the Column macro. | Global |
| comment | Comment | Development | Allows putting comments in the source content. This macro doesn't output anything. | Global |
| confluence_attachments | Confluence bridge for Attachments | Confluence | Confluence bridge for the Attachment macro | Current Wiki |
| confluence_children | Confluence bridge for Children | Confluence | Confluence bridge for the Children macro using the XWiki document tree macro. | Global |
| confluence_column | Confluence bridge for Column | Confluence | Confluence bridge for the Column macro. | Current Wiki |
| confluence_contentbylabel | Confluence bridge for Content by label | Confluence Bridge for the Content by label macro | ||
| confluence_details | Confluence bridge for Details | Confluence Bridge for the Details (Page Properties) macro. It allows defining property key-value pairs in a table contained in the macro. | Global | |
| confluence_detailssummary | Confluence bridge for Details Summary | Confluence bridge for the Details Summary (Page Properties Report) macro to display properties attached to a page using the Details macro. | Global | |
| confluence_drawio | Confluence bridge for Drawio | Confluence | Confluence Bridge for the Drawio macro. By default it displays the PNG file used by the Drawio macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Global |
| confluence_gallery | Confluence bridge for Gallery | Confluence | Confluence Bridge for the Gallery macro. | Global |
| confluence_gliffy | Confluence bridge for Gliffy | Confluence | Confluence Bridge for the Gliffy macro. By default it displays the PNG file used by the Gliffy macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Global |
| confluence_layout | Confluence bridge for Layout | Confluence | Confluence bridge macro for the Layout macro to define a layout, containing layout sections (using the confluence_layout-section macro). | Global |
| confluence_layout-cell | Confluence bridge for Layout Cell | Confluence | Confluence bridge for the Layout Cell macro. It is used for defining a part a layout section, used inside the confluence_layout-section macro. | Global |
| confluence_layout-section | Confluence bridge for Layout Section | Confluence | Confluence bridge for the Layout Section macro. It is used to define a section of a layout, used inside the layout macro and containing layout cells. | Current Wiki |
| confluence_mathblock | Confluence bridge for Mathblock | Confluence | Confluence bridge for the Mathblock macro (LaTeX math block expressions). | Global |
| confluence_mathblock-ref | Confluence bridge for Mathblock Reference | Confluence | Confluence bridge macro for the Mathblock Reference macro | Global |
| confluence_mathinline | Confluence bridge for Mathinline | Confluence | Confluence bridge macro for the Mathinline macro (LaTeX math inline expressions). | Global |
| confluence_mockup | Confluence bridge for Mockup | Confluence | Confluence Bridge for the Balsamiq Mockup macro. It only displays the image preview of the mockup. | Global |
| confluence_multimedia | Confluence bridge for Multimedia | Confluence | Confluence Bridge for the Multimedia macro. | Global |
| confluence_note | Confluence bridge for Note | Confluence | Confluence bridge for the Note macro to the XWiki Success macro | Global |
| confluence_outgoing-links | Confluence Outgoing Links | Content | Confluence bridge macro for outgoing-links. | Global |
| confluence_pagetree | Confluence bridge for Page Tree | Confluence | Confluence Bridge for the Confluence Page Tree macro to the XWiki documentTree macro. | Global |
| confluence_paste-code-macro | Confluence bridge for Paste Code Macro | Confluence | Confluence bridge for the Confluence Paste Code macro to the XWiki Code macro | Global |
| confluence_section | Confluence bridge for Section | Confluence | Confluence bridge for the Section macro | |
| confluence_time | Confluence bridge for Time | Confluence | Confluence bridge for the Time macro | Global |
| confluence_tip | Confluence bridge for Tip | Confluence | Confluence bridge for the Tip macro to the XWiki Success macro | Global |
| confluence_wireframe | Confluence bridge for Balsamiq Wireframe | Confluence | Confluence Bridge for the Balsamiq Wireframe macro. It only displays the image preview of the wireframe. | 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 | Provides a content report in table format, based on labels. | Global | |
| context | Context | Development | Executes content in the context of the passed page | Global |
| contributors | Contributors | Contributors Confluence Bridge macro to show the contributors of a given document. | Global | |
| dashboard | Dashboard | Layout | A macro to define a dashboard to fill with gadgets. | Global |
| date | Date | Customize the way you want to display a date. | Global | |
| diagram | Diagram | Content | Displays a diagram. | 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 |
| drawio | Legacy unprefixed Confluence bridge for Drawio | Deprecated | Legacy Unprefixed Confluence Bridge for the Drawio macro. By default it displays the PNG file used by the Drawio macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Global |
| error | Error Message | Formatting | Displays an error message note. | Global |
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| excerpt | Excerpt | Bridge for the Confluence Excerpt macro. It marks part of the page's content for use by other macros. | Global | |
| excerpt-include | Excerpt include | Content | Includes excerpts from other documents into the current page. The included pages need to contain the simple `excerpt` macro. | 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. | Current Wiki | |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| gallery | Gallery | Layout | Displays the images found in the provided content using a slide-show view. | Global |
| gliffy | Legacy unprefixed Confluence bridge for Gliffy | Deprecated | Legacy Unprefixed Confluence Bridge for the Gliffy macro. By default it displays the PNG file used by the Gliffy macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Global |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| html | HTML | Development | Inserts HTML or XHTML code into the page. | Global |
| icon | Font Awesome icon | Icons | Inserts a Font Awesome icon | Current Wiki |
| 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 |
| job | Job | Development | Execute the macro content asynchronously and display progress. | Global |
| jobprogress | Job Progress | Internal | Provide a UI to follow asynchronous job progression | Current Wiki |
| 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 |
| layout | Legacy unprefixed Confluence bridge for Layout | Deprecated | Legacy Unprefixed Confluence bridge macro for the Layout macro to define a layout, containing layout sections (using the confluence_layout-section macro). | Global |
| layout-cell | Legacy unprefixed Confluence bridge for Layout Cell | Deprecated | Legacy Unprefixed Confluence bridge for the Layout Cell macro. It is used for defining a part a layout section, used inside the confluence_layout-section macro. | Global |
| layout-section | Legacy unprefixed Confluence bridge for Layout Section | Deprecated | Legacy Unprefixed Confluence bridge for the Layout Section macro. It is used to define a section of a layout, used inside the layout macro and containing layout cells. | Global |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| locationSearch | Location search | Search in the given location. | Current Wiki | |
| mathblock | Legacy unprefixed Confluence bridge for Mathblock | Deprecated | Legacy Unprefixed Confluence bridge for the Mathblock macro (LaTeX math block expressions). | Global |
| mathblock-ref | Legacy unprefixed Confluence bridge for Mathblock Reference | Deprecated | Legacy Unprefixed Confluence bridge macro for the Mathblock Reference macro | Global |
| mathinline | Legacy unprefixed Confluence bridge for Mathinline | Deprecated | Legacy Unprefixed Confluence bridge macro for the Mathinline macro (LaTeX math inline expressions). | Global |
| mathjax | MathJax | content | 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 |
| missingLicenseMessage | Missing License Message | Display an error message when the extension does not have a valid license. | Global | |
| mockup | Legacy unprefixed Confluence bridge for Mockup | Deprecated | Legacy Unprefixed Confluence Bridge for the Balsamiq Mockup macro. It only displays the image preview of the mockup. | Global |
| msStream | Microsoft Stream | Embed a Microsoft Stream video in a page by simply passing the URL and any customization parameters. | Global | |
| multimedia | Legacy unprefixed Confluence bridge for Multimedia | Deprecated | Legacy Unprefixed Confluence Bridge for the Multimedia macro. | Global |
| net-presago-stream-macro | Legacy Confluence bridge for Microsoft Stream | Deprecated | Legacy Confluence bridge for Microsoft Stream. | Global |
| note | Legacy unprefixed Confluence bridge for Note | Deprecated | Legacy Unprefixed Confluence bridge for the Note macro to the XWiki Success macro | Global |
| 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 |
| pagetree | Legacy unprefixed Confluence bridge for Page Tree | Deprecated | Legacy Unprefixed Confluence Bridge for the Confluence Page Tree macro to the XWiki documentTree macro. | Global |
| panel | Panel Macro | Panel macro to display XWiki content inside a panel. | Current Wiki | |
| paste-code-macro | Legacy unprefixed Confluence bridge for Paste Code Macro | Deprecated | Legacy Unprefixed Confluence bridge for the Confluence Paste Code macro to the XWiki Code macro | 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 | Global |
| profile-picture | Profile Picture | Confluence Profile Picture macro | Global | |
| 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 | 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 | |
| script | Script | Development | Execute script in provided script language. | Global |
| section | Confluence bridge for Section | Deprecated | Confluence bridge for the Section macro. | Global |
| showhide | showhide | content | Show Hide Macro | Current Wiki |
| 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. | Global | |
| team | Team | Display avatars of the members of a team. | Current Wiki | |
| template | Template | Development | Insert a template. | Global |
| time | Legacy Confluence bridge for Time | Deprecated | Legacy Confluence bridge for Time | Global |
| tip | Legacy unprefixed Confluence bridge for Tip | Deprecated | Legacy Unprefixed Confluence bridge for the Tip macro to the XWiki Success macro | Global |
| toc | Table of contents | Navigation | Generates a table of contents. | Global |
| 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 |
| userList | User List | Content | Displays a list of users with a customizable set of their properties | Global |
| userlister | Legacy Confluence bridge for User Lister | Legacy Confluence bridge for User Lister. | Global | |
| userProfile | User Profile | Content | Displays a user profile with custom properties | Global |
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| view-file | View Files | Show files using PDF Viewer Macro or Office Viewer | Current Wiki | |
| viewdoc | Legacy Confluence bridge for View Office Word | Deprecated | Legacy Confluence bridge for View Office Word. | Global |
| viewpdf | Legacy Confluence bridge for View PDF | Deprecated | Legacy Confluence bridge for View PDF. | Global |
| viewppt | Legacy Confluence bridge for View Office PowerPoint | Deprecated | Legacy Confluence bridge for View Office PowerPoint. | Global |
| viewxls | Legacy Confluence bridge for View Office Excel | Deprecated | Legacy Confluence bridge for View Office Excel. | Global |
| 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 |
| wireframe | Legacy unprefixed Confluence bridge for Balsamiq Wireframe | Deprecated | Legacy Unprefixed Confluence Bridge for the Balsamiq Wireframe macro. It only displays the image preview of the wireframe. | Global |
| workspaces | Workspaces (Legacy) | Deprecated | Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead. | Current Wiki |