XWiki Syntax Guide
Last modified by Administrateur local on 2026/02/12 12:34
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 |
| async | Async macro | Content | Execute asynchronously and/or cache the macro content. | Global |
| attachmentGalleryPicker | Attachment Picker | Development | Grid based attachment picker. | Global |
| attachments | Attachments | Displays the list of attachments for a given document using a live table. | Current Wiki | |
| 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 |
| 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 |
| 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 |
| context | Context | Development | Executes content in the context of the passed page | Global |
| dashboard | Dashboard | Layout | A macro to define a dashboard to fill with gadgets. | Global |
| diagram | Diagram | Content | Displays a diagram. | Current Wiki |
| 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. | 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 |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| hardis-blockquote | Hardis - Block quote | Formatting | Displays a quote with specific formatting. | Global |
| hardis-button | Hardis - Clickable button | Formatting | Create an HTML button tag. | Global |
| hardis-center-table | Hardis - Center table | Allows you to center a table on the page. | Global | |
| hardis-click | Hardis - Clickable content | Navigation | To make the content clickable | Global |
| hardis-content-zone | Hardis - Content Zone | Formatting | Inserts a graphic element with rounded edges, ideal for creating content areas, buttons, etc.. | Global |
| hardis-current-date | Hardis - Current Date | Macro for displaying current date. | Global | |
| hardis-custom-table | Hardis - Customizable table | Macro to apply styles transformation to tables which are inside the macro content. | Global | |
| hardis-display-extract | Hardis - Display extract | Content | Include the excerpt from one page within another page. | Global |
| hardis-expand | Hardis - Expand | Integrate an expandable text area into your page. | Global | |
| hardis-extract | Hardis - Extract | Macro to define content as an excerpt (to include this content in another page, use the macro 'Hardis - Display an excerpt'). | Global | |
| hardis-formatdate | Hardis - Formatted date | Formatting | Display and format selected date. | Global |
| hardis-helpcall | Hardis - Help call | Macro allowing you to link a page to an Adelia or Reflex program. | Global | |
| hardis-info | Hardis - Information | Highlights content as an informational note with a blue background. | Global | |
| hardis-jira | Hardis - Jira | Navigation | Communicate the status of a project, task or milestone with visual indicators. | Global |
| hardis-layout-cell | Hardis - Layout cell | Define the content of a layout section cell. | Global | |
| hardis-layout-section | Hardis - Layout section | Allows you to structure a layout section using vertical columns with different configurations. | Global | |
| hardis-listlabels | Hardis - Labels list | Content | Renders the list of all labels or labels for a specific space sorted alphabetical. | Global |
| hardis-page-navigation | Hardis - Page Navigation | Allows to navigate to next or previous page. | Global | |
| hardis-panel | Hardis - Panel | Displays a block of text in a customizable panel. | Global | |
| hardis-reactive-button | Hardis - Responsive Button | Formatting | Macro to display a clickable and responsive button on a XWiki page. | Global |
| hardis-restricted | Hardis - Restricted content | Content | Conditional display of a block of text. | Global |
| hardis-status | Hardis - Status | Content | Communicate the status of a project, task or milestone with visual indicators. | Global |
| hardis-tab | Hardis - Tab | Tab element for the tab group macro. This is expected to be put as the tab group macro content. | Global | |
| hardis-tabs-children | Hardis - Children Tabs | Macro for automatically displaying tabs with child page content. | Global | |
| hardis-tabs-group | Hardis - Tab group | The main macro which contains tab macro elements. | Global | |
| hardis-tabs-navigation | Hardis - Tabbed Navigation | Add navigation tabs based a page's children, or labels. | Global | |
| hardis-toc | Hardis - Table of Content & Summary | Content | Creates a Table of Contents for the current page based on headings in the page. | Global |
| hardis-toczone | Hardis - Toc zone | Creates a Table of Contents for headings within the body of the macro. | Global | |
| hardis-topofpage | Hardis - Top Of Page | Navigation | Link to go to the top of the current page. | Global |
| hardis-translation | Hardis - Translation | Displays a block of text only if the selected target language is the user's default language. | Global | |
| hardis-userprofile | Hardis - User profile | Content | Displays the details of a user's profile. | Global |
| hardis-view-file | View file | Show a file using PDF Viewer Macro or Office Viewer. | Global | |
| hardis-wms-product-name | Hardis - WMS product name | Content | Allows you to change the product name displayed in the documentation without having to modify or republish it. | 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 |
| 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 |
| 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 |
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | 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 |
| script | Script | Development | Execute script in provided script language. | Global |
| 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 |
| template | Template | Development | Insert a template. | 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 |
| velocity | Velocity | Development | Executes a Velocity script. | 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 |
| workspaces | Workspaces (Legacy) | Deprecated | Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead. | Current Wiki |