XWiki Syntax Guide
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 |
| formula | Formula | Content | Displays a mathematical formula. | Global |
| wikimacrocontent | WikiMacro Content | Development | Display editable content of a wikimacro. | Global |
| blogPostLayoutFull | Blog Post Layout Full | This macro is used to display a full blog post | Global | |
| forum.recentForumDiscussions | Recent Forum Discussions | Content | Lists the top N most recent discussions from all the forums A discussion is considered recent if: |
- new topic is created on a forum
- new topic is edited of a forum
- new answer is created on a topic
- new answer is edited (this will include comment added and comment edited)|Current Wiki
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| mention | User Mention | Notifications | Insert a user mention. | Current Wiki |
| plantuml | PlantUML | Content | Convert various text input formats into diagram images using PlantUML. | Global |
| blogPostLayoutImage | Blog Post Layout Image | This macro is used to display a full blog post with a thumbnail image | Global | |
| async | Async macro | Content | Execute asynchronously and/or cache the macro content. | Global |
| spaceindex | Space Index | Deprecated | Lists the pages in a space. | Global |
| chartjs | ChartJS | Content | Simple HTML5 charts using the canvas element. | Current Wiki |
| box | Box | Formatting | Draw a box around provided content. | Global |
| spaces | Spaces | Deprecated | Displays all the spaces in this wiki. | Global |
| error | Error Message | Formatting | Displays an error message note. | Global |
| attachmentGalleryPicker | Attachment Picker | Grid based attachment picker. | Global | |
| video | Video | Content | Display in your wiki page any video from Youtube, Dailymotion, Google Video or Vimeo. |
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).|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. | Global |
| children | Children | Navigation | Displays a tree of children pages of the current page | 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 |
| bubmacro | BuB-Demo-Macro | Content | BuB-Demo-Macro | Global |
| display | Display | Content | Display other pages into the current page. | Global |
| translation | Translation | Content | Display a translation message. | Global |
| context | Context | Development | Executes content in the context of the passed page | Global |
| sequence | Sequence Diagram | content | Draws a sequence diagram using https://www.websequencediagrams.com/ | 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 |
| moccacalendar | Mocca Calendar | Content | Displays a Calendar | Global |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| rss | RSS | Content | Output latest feed entries from a RSS feed. | Global |
| blogs | All Blogs Livetable | The blogs macro is used to list on a livetable all the blog available on the wiki. | 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 | |
| container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global |
| DisplayQuiz | Display Quiz | content | This macro is used to display a quiz on a wiki page | Current Wiki |
| DisplayObjectInfos | DisplayObjectInfos | code | Display a selected list of properties of an object | Current Wiki |
| 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 |
| blogPostLayoutLink | Blog Post Layout Link | This macro is used to display a blog post as a simple link | 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 |
| CreateTicket | Create Ticket | Content | 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 |
| useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | 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 |
| map | Map | Display an interactive geographical map | Current Wiki | |
| 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 |
| UserResults | User Results | content | Display the quiz result for user | 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 |
| wikis | Wikis | Navigation | List all wikis | 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 |
| tableToChartJS | Table to ChartJS | Content | Draws a chart using ChartJS and the data read from a table. | 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. | Global | |
| cache | Cache | Development | Caches content. | Global |
| menu | Menu | Navigation | Displays a menu created using simple wiki syntax (nested lists and links). | Global |
| blogPostLayoutCompact | Blog Post Layout Compact | This macro is used to display a full blog post in a compact mode | Global | |
| notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Current Wiki |
| blogpostcreate | Blog Post Create | The Blog Post Create macro is used to insert a post creation form. The macro takes a blog descriptor document as parameter. The new blog posts will belongs to the blog specified in the parameter. | Global | |
| blogpostlist | Blog post list | The BlogPostMacro is used to search and display blog posts based on some parameters, the results can be displayed using customizable templates. | Global | |
| wettermacro | Wetter | Content | aktuelles Wetter ausgeben | Global |
| 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 |
| notifications | Notifications | Notifications | Display notifications about events happened on the wiki. | Current Wiki |
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| iframe | IFrame | Content | Draws Content in a HTML Iframe | Current Wiki |
| pdfviewer | PDF Viewer | Content | PDF Viewer based on Mozilla pdf.js | Current Wiki |
| freemind | Freemind mindmap visualization macro | This macro shows a Freemind mindmap. | Global | |
| wikimacroparameter | WikiMacro Parameter | Development | Display editable parameter of a wikimacro. | Global |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| kanbanboard | Kanban board | Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Global | |
| code | Code | Formatting | Highlights code snippets of various programming languages | Global |
| calendar | Calendar | Content | Displays a Calendar | 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 |
