XWiki Syntax Guide
Last modified by Hawke Robinson on 2023/03/22 13:41
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 |
| attachmentGallery | Attachment Gallery | Content | Displays all images found in the current page's attachments as an image gallery | Current Wiki |
| 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 |
| awmkanban | Kanban board for AppWithinMinutes | Display XWiki Documents from an AWM as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Global | |
| 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. | Current Wiki | |
| blogPostLayoutCards | Cards Blog Post Layout | This macro is used to display a blog post using the 'Cards' layout | Current Wiki | |
| blogPostLayoutCompact | Blog Post Layout Compact | This macro is used to display a full blog post in a compact mode | Current Wiki | |
| blogPostLayoutFull | Blog Post Layout Full | This macro is used to display a full blog post | Current Wiki | |
| blogPostLayoutImage | Blog Post Layout Image | This macro is used to display a full blog post with a thumbnail image | Current Wiki | |
| blogPostLayoutLink | Blog Post Layout Link | This macro is used to display a blog post as a simple link | Current Wiki | |
| 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. | Current Wiki | |
| blogs | All Blogs Livetable | The blogs macro is used to list on a livetable all the blog available on the wiki. | Current Wiki | |
| box | Box | Formatting | Draw a box around provided content. | Global |
| cache | Cache | Development | Caches content. | Global |
| calendar | Calendar | Content | Displays a Calendar | Current Wiki |
| capacity | Roadmap Capacity | Content | Display the capacity of each employee for the current roadmap. | Wiki |
| 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 |
| citation | Citation | Citation Macro | Global | |
| 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 |
| 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 |
| DisplayQuiz | Display Quiz | content | This macro is used to display a quiz on a wiki page | Current Wiki |
| 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 |
| error | Error Message | Formatting | Displays an error message note. | Global |
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| faq | FAQ | Lists FAQ entries | Current Wiki | |
| figure | Figure | Development | Tag content as an illustration and with an optional caption. | Global |
| figureCaption | Figure Caption | Development | Provide a figure caption when used inside the Figure macro. | Global |
| figureTypeRecognizer | Figure Type Recognizer | Internal | Internal macro used to recognize the type of a figure. | Global |
| fileManager.recentFiles | Recent Files | Content | Lists the files that have been recently uploaded through the File Manager. | Current Wiki |
| filemanagerdoc | File Manager Document | Content | Inserts a file manager document in a page, with or without preview | Current Wiki |
| filetagcloud | FileManager tag cloud | Content | Displays the cloud of file tags in this wiki or in the specified space, if any. | Current Wiki |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | 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 |
| gallery | Gallery | Layout | Displays the images found in the provided content using a slide-show view. | Global |
| gdprSettings | Gdpr settings | Get what kind of cookies the current user has consented to. (preferences, statistics or marketing) | Current Wiki | |
| glossary | glossary | Navigation | Lists all the Glossary Entries located under the current page, in a table | Current Wiki |
| glossaryEntries | glossaryEntries | Navigation | Lists all glossary entries from a glossary, as a list | Global |
| glossaryReference | GlossaryReference | Navigation | References a glossary entry | Global |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| hierarchy | Hierarchy | code | Displays the pages in the wiki / space in the parent/child tree, editable. Note that you can only use one editable hierarchy macro per page. | Current Wiki |
| highlight | Highlight | Content | highlight.JS integration | Current Wiki |
| 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 |
| ideasrecent | Recent Ideas | Displays the N most recent ideas. | Current Wiki | |
| include | Include | Content | Include other pages into the current page. | Global |
| includelyrics | 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 |
| kanban | Kanban | Kanban macro allowing to display and edit a kanban | Current Wiki | |
| kanbanboard | Kanban board | Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Current Wiki | |
| listDiscussions | List Discussions | Provides a table to display filtered list of discussions. | Current Wiki | |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| lyrics | Lyrics | Content | Generates lyrics of a song. | Global |
| lyricsindex | LyricsIndex | Content | Generates index of lyrics | Global |
| map | Map | Display an interactive geographical map | 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 |
| messageSender | Message Sender | Social | A control that allows users to enter messages that are handled by the MessageStream module. | Current Wiki |
| nextmeetings | Next Meetings | Displays a defined number of upcoming meetings | Current Wiki | |
| 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 |
| pdfviewer | PDF Viewer | Content | PDF Viewer based on Mozilla pdf.js | Current Wiki |
| poll | Poll | Displays the results of a poll. | Current Wiki | |
| pollsrecent | Recent Polls | Displays the N most recent polls. | Current Wiki | |
| projectdocuments | Project Documents | Content | Displays a list of documents in a Livetable | Current Wiki |
| publicationworkflow | Publication Workflow | Displays publication process (publish / moderate ...) for workflow resources | Current Wiki | |
| 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 |
| quote | Quote | Formatting | Displays inline text with special quote formatting. | Global |
| reference | Reference | Navigation | Create a link to a section id, displaying the section number as the link label. | Global |
| roadmapitem | Roadmap Item Macro | Content | A roadmap item that will hold information about tasks. | Wiki |
| script | Script | Development | Execute script in provided script language. | Global |
| showhide | showhide | content | Show Hide Macro | Current Wiki |
| slideshow | slideshow | Current Wiki | ||
| sortable_tables | Sorteable Tables | Makes all tables in the content of the current page sortable. | Current Wiki | |
| spaceindex | Space Index | Deprecated | Lists the pages in a space. | Current Wiki |
| success | Success Message | Formatting | Displays a success message note. | Global |
| svg | SVG | content | Display an editable SVG image | Current Wiki |
| tagcloud | Tag Cloud | Content | Displays the cloud of tags in this wiki or in the specified space, if any. | Current Wiki |
| taskcard | Task card | Display a task and its information as a card. | 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 |
| UserResults | User Results | content | Display the quiz result for user | Global |
| velocity | Velocity | Development | Executes a Velocity script. | 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 |
| videoupload | Video upload | Display an input html element that allow you to upload videos and transcode them in order to play videos using DASH. For each uploaded video an entry will be added in the XWikiTube application home page. | Current Wiki | |
| 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 |