XWiki Syntax Guide
Last modified by OIT Integration Services on 2025/05/21 17:48
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 | |
| alldescendants | All Descendants | Displays all children of the current page, and their children as well | 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 |
| 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 |
| contentbylabel | Children By Tag | Displays a list of child pages that are tagged with a given label | 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 |
| details | Details | Deprecated, Confluence | Blank placeholder macro with no content | Global |
| detailssummary | Details Summary | Deprecated, Confluence | Blank placeholder macro with no content | Global |
| discussion | Discussion | Displays a discussion | 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 | 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 * 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. The video macro can also plays a DASH video (Dynamic Adaptive Streaming over HTTP). | Global | |
| 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 |
| 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 |
| index | Index | Child pages grouped alphabetically | Global | |
| info | Info Message | Formatting | Displays an info message note. | Global |
| job | Job | Execute the macro content asynchronously and display progress. | Global | |
| jobprogress | Job Progress | Internal | Provide a UI to follow asynchronous job progression | Current Wiki |
| layout | Layout Macro | Deprecate, Confluence | Blank placeholder macro with no content. Layout macro is part of the Pro Package, which we are not using for Resources.SMU. Using a blank macro to see if this will fix the migration issue with the layout macro from the Pro Package. | Global |
| layout-cell | layout-cell | Global | ||
| layout-section | layout-section | placeholder | Global | |
| listDiscussions | List Discussions | Provides a table to display filtered list of discussions. | Current Wiki | |
| listlabels | List Labels | Lists labels beneath a specified root page in a table sorted alphabetically | Global | |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| livesearch | Live Search | Displays a search box that allows for searching just the descendent pages of the root | Global | |
| 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 Macro | Embed a Microsoft Stream video in a page by simply passing the URL and any customization parameters. | 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 |
| oitlogo | OIT Logo | Content, SMU | Inserts the SMU OIT Logo | Global |
| pagetreesearch | Child Search | Displays a search box that allows for searching just the descendent pages of the root | Global | |
| panel | Panel Macro | Panel macro to display XWiki content inside a panel. | Global | |
| pdfpagebreak | PDF Page Break | Inserts a PDF page break at the location of the macro. PDF exports will start a new page at that point. This macro is invisible when viewing the page online. | 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 |
| redirect | Redirect | Redirects to specified URL. To edit a page after the redirect macro has been added, browse to the following: https://wiki.smu.edu/bin/edit/<path to page>/?editor=wiki | 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. | 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 |
| tagList | Tag list | Show a list of all the macros in your instance. | Global | |
| tagsearch | Tag Search | Displays a search field that allows a user to enter a tag and bring up the tags viewer page at bin/view/Main/Tags?do=viewTag&tag=<tag> | Global | |
| team | Team | Display avatars of the members of a team. | Global | |
| template | Template | Development | Insert a template. | Global |
| tip | Tip | Confluence, Deprecated | 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 |