XWiki Syntax Guide
Last modified by Kerwin Olfers on 2021/03/22 10:40
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 |
|---|---|---|---|---|
| toc | Table of contents | Navigation | Generates a table of contents. | Global |
| iconPicker | Icon Picker | Development | Select an icon within the XWiki icon set. | Current Wiki |
| wikimacrocontent | WikiMacro Content | Development | Display editable content of a wikimacro. | Global |
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| mention | User Mention | Notifications | Insert a user mention. | Current Wiki |
| async | Async macro | Content | Execute asynchronously and/or cache the macro content. | Global |
| spaceindex | Space Index | Deprecated | Lists the pages in a space. | Current Wiki |
| figureCaption | Figure Caption | Development | Provide a figure caption when used inside the Figure macro. | Global |
| filetagcloud | FileManager tag cloud | Content | Displays the cloud of file tags in this wiki or in the specified space, if any. | Current Wiki |
| box | Box | Formatting | Draw a box around provided content. | 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 |
| sortable_tables | Sorteable Tables | Makes all tables in the content of the current page sorteable. | Current Wiki | |
| warning | Warning Message | Formatting | Displays a warning message note. | Global |
| messageSender | Message Sender | Social | A control that allows users to enter messages that are handled by the MessageStream module. | Current Wiki |
| children | Children | Navigation | Displays a tree of children pages of the current page | Current Wiki |
| tasks-report-macro | Confluence Tasks Report Macro | Current Wiki | ||
| display | Display | Content | Display other pages into the current page. | Global |
| translation | Translation | Content | Display a translation message. | Global |
| task | Task | Create a task that you can assign an user to using the mention macro and use the date macro to set a deadline. | Global | |
| task-report | Task report macro | Create a custom report of the tasks within the wiki. | Current Wiki | |
| reference | Id | Navigation | Create a link to a section id, displaying the section number as the link label. | Global |
| context | Context | Development | Executes content in the context of the passed page | Global |
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | Global |
| ConditionalTableColors | Conditional Table Colors | Content | Add colors to table cells based on their values. Y = green, R = red, * = yellow | 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 |
| 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 |
| documentTree | Page Tree | Navigation | Displays the tree of XWiki pages. | Current Wiki |
| template | Template | Development | Insert a template. | Global |
| notificationsAutoWatchPreferences | Notifications Auto Watch Preferences | Notifications | Display the preferences of the current user about auto watched pages. | Current Wiki |
| chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global |
| kanban | Kanban | Kanban macro allowing to display and edit a kanban | 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 | |
| LightboxWrapper | LightboxWrapper | Content | Wraps all unstyled image in Lightboxes, adds title based on alt text and linkable anchor (all text preceding first ":") | Global |
| fileManager.recentFiles | Recent Files | Content | Lists the files that have been recently uploaded through the File Manager. | Current Wiki |
| container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global |
| NavigationColumns | NavigationColums | Content | An macro for creating a navigation block, with two columns, for pages in the current section and links to related topics | 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 |
| date | Date | Insert a date that will be displayed nicely. | Global | |
| python | Python | Development | Executes a python script. | Global |
| 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 |
| script | Script | Development | Execute script in provided script language. | Global |
| TopicPages | TopicPages | Displays a list of pages related to each tag for the current page | Global | |
| useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | Global |
| displayIcon | Icon | Content | Display an icon. | 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 |
| office365 | Office365 Viewer | content | Displays an Office 365 office or pdf document | Current Wiki |
| accordion | accordion | content | Accordion Macro | Global |
| gallery | Gallery | Layout | Displays the images found in the provided content using a slide-show view. | Global |
| uiextension | UI Extension | 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 |
| uiextensions | UI Extensions | Development | Insert UI extensions. | Global |
| dashboard | Dashboard | Layout | A macro to define a dashboard to fill with gadgets. | Global |
| figure | Figure | Development | Tag content as an illustration and with an optional caption. | 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 |
| diagram | Diagram | Content | Displays a diagram. | 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 |
| notificationsApplicationsPreferences | Notifications Applications Preferences | Notifications | Display the preferences of the current user about notification applications. | Current Wiki |
| taskcard | Task card | Display a task and its information as a card. | Current Wiki | |
| cache | Cache | Development | Caches content. | Global |
| menu | Menu | Navigation | Displays a menu created using simple wiki syntax (nested lists and links). | Global |
| notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Current Wiki |
| filemanagerdoc | File Manager Document | Content | Inserts a file manager document in a page, with or without preview | Current Wiki |
| documents | Pages | Content | Displays a list of pages in a Livetable | 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 |
| tasks | Tasks | Display one or more tasks identified by their IDs. | Global | |
| notifications | Notifications | Notifications | Display notifications about events happened on the wiki. | Current Wiki |
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| pdfviewer | PDF Viewer | PDF Viewer based on Mozilla pdf.js | Global | |
| drive | Google Drive Macro | content | Google Drive Macro | Global |
| faq | FAQ | Lists FAQ entries | Current Wiki | |
| lightbox | Lightbox Image | Content | Add a click-enlargeable image. | Global |
| wikimacroparameter | WikiMacro Parameter | Development | Display editable parameter of a wikimacro. | Global |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| showhide | showhide | content | Show Hide Macro | Current Wiki |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| FigureAnchors | FigureAnchors | Content | test test | Global |
| kanbanboard | Kanban board | Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | 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 |
| code | Code | Formatting | Highlights code snippets of various programming languages | 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 |