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 |
| ajax | ajax | Delays the content of this macro as an Ajax Request call | Current Wiki | |
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| mention | User Mention | Notifications | Insert a user mention. | Current Wiki |
| blogPostLayoutImage | Blog Post Layout Image | This macro is used to display a full blog post with a thumbnail image | 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 |
| spaces | Spaces | Deprecated | Displays all the spaces in this wiki. | Current Wiki |
| error | Error Message | Formatting | Displays an error message note. | Global |
| backwardCompatiblityReport | API Backward Compatiblity Report | content | Current Wiki | |
| attachmentGalleryPicker | Attachment Picker | Development | Grid based attachment picker. | Global |
| warning | Warning Message | Formatting | Displays a warning message note. | Global |
| workspaces | Workspaces (Legacy) | Deprecated | Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead. | Current Wiki |
| contributors | Top Contributors | Current Wiki | ||
| 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 |
| 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 |
| template | Template | Development | Insert a template. | Global |
| chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global |
| notificationsAutoWatchPreferences | Notifications Auto Watch Preferences | Notifications | Display the preferences of the current user about auto watched pages. | Current Wiki |
| container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global |
| python | Python | Development | Executes a python script. | Global |
| blogPostLayoutCards | Cards Blog Post Layout | This macro is used to display a blog post using the 'Cards' layout | Current Wiki | |
| script | Script | Development | Execute script in provided script language. | Global |
| useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | Global |
| displayIcon | Icon | Content | Display an icon. | Global |
| language | Language | List the flag and name for a given list of languages | Global | |
| dashboard | Dashboard | Layout | A macro to define a dashboard to fill with gadgets. | Global |
| uiextensions | UI Extensions | Development | Insert UI extensions. | Global |
| diagram | Diagram | Content | Displays a diagram. | Current Wiki |
| wikis | Wikis | Navigation | List all wikis | Current Wiki |
| html5video | HTML5 Video | Content | Play videos using the native HTML5 player. | Current Wiki |
| cache | Cache | Development | Caches content. | Global |
| blogPostLayoutCompact | Blog Post Layout Compact | This macro is used to display a full blog post in a compact mode | Current Wiki | |
| notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Current Wiki |
| browser | Browser | Displays a browser entry containing the browser's icon, name and version. Meant to be used in Release Notes or Support browsers sections. | Global | |
| todo | Todo | content | Todo macro | Global |
| getChanges | Get Changes | development | Collect Release Changes into an XWiki Context variable | Current Wiki |
| imagePres | imagePres | Current Wiki | ||
| productVersions | Product Versions | content | Display product versions for testing | Global |
| 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 |
| database | Database | Displays a database entry containing the database's icon, name and version. Meant to be used in Release Notes or Support databases sections. | 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 | Content | PDF Viewer based on Mozilla pdf.js | Current Wiki |
| version | Version | Content | Specifies since which versions of XWiki the content of the macro corresponds to. | Global |
| faq | FAQ | Lists FAQ entries | Current Wiki | |
| wikimacroparameter | WikiMacro Parameter | Development | Display editable parameter of a wikimacro. | Global |
| latestBlogPosts | Latest Blog Posts | Shows the latest blog posts articles | Global | |
| 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 |
| scm | scm | Documentation | Produce scm link | 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 |
| blogPostLayoutFull | Blog Post Layout Full | This macro is used to display a full blog post | Current Wiki | |
| plantuml | PlantUML | Content | Convert various text input formats into diagram images using PlantUML. | Global |
| poweredBy | Powered By | Displays a random reference summary | Global | |
| box | Box | Formatting | Draw a box around provided content. | Global |
| remotecode | Remote Code | Displays the code (using the code macro) of a remote file | Global | |
| backwardCompatiblityReportXml | API Backward Compatiblity Report | content | Uses Revapi ignores defined in XML format. | Current Wiki |
| 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 |
| displayChanges | Display Changes | content | Display Release Changes | Current Wiki |
| releasenotechanges | Release Note Changes | content | Current Wiki | |
| display | Display | Content | Display other pages into the current page. | Global |
| translation | Translation | Content | Display a translation message. | Global |
| pollsrecent | Recent Polls | Displays the N most recent polls. | Current Wiki | |
| jira | JIRA | Content | Fetches information from a JIRA server and displays them as a table, list or enumeration. | Global |
| codePres | codePres | Current Wiki | ||
| 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 |
| blogs | All Blogs Livetable | The blogs macro is used to list on a livetable all the blog available on the wiki. | Current Wiki | |
| documentTree | Page Tree | Navigation | Displays the tree of XWiki pages. | Current Wiki |
| check | Check Macro | Displaying a check or cross icon | 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 | Current Wiki | |
| 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 |
| office | Office Document Viewer | Content | View office attachments (doc, ppt, xls, odt, odp, ods etc.) inside wiki pages without downloading or importing them. | 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 |
| 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 |
| 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 |
| image | Image | content | Displays an image in a box | Global |
| menu | Menu | Navigation | Displays a menu created using simple wiki syntax (nested lists and links). | 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 | |
| backwardCompatibilityReport134 | API Backward Compatiblity Report | content | Uses Revapi ignores defined in XML format. | 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 | |
| documents | Pages | Content | Displays a list of pages in a Livetable | Current Wiki |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| showhide | showhide | content | Show Hide Macro | Global |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| videoCard | Video Card | Displays a card with an embedded video | Current Wiki |
