XWiki Syntax Guide
Last modified by Simon Urli on 2020/11/02 14:57
XWiki Syntax 2.1 ยป Programming
XWiki Syntax 2.1: Programming
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 |
| 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 |
| 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 | |
| cache | Cache | Development | Caches content. | Global |
| chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global |
| chartjs | ChartJS | Content | Simple HTML5 charts using the canvas element. | Current Wiki |
| 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 |
| 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 |
| 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 | |
| diagram | Diagram | Content | Displays a diagram. | 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 |
| 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 |
| iconthememapping | Icon Theme Mapping | This macro displays a table containing the mapping from an icon theme onto 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 |
| image | Image | content | Displays an image in a box | Global |
| include | Include | Content | Include other pages into the current page. | Global |
| info | Info Message | Formatting | Displays an info message note. | Global |
| jira | JIRA | Content | Fetches information from a JIRA server and displays them as a table, list or enumeration. | Global |
| language | Language | List the flag and name for a given list of languages | Global | |
| latestBlogPosts | Latest Blog Posts | Shows the latest blog posts articles | Global | |
| liveData | Live Data | Content | Display dynamic lists of data. | 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 |
| messageSender | Message Sender | Social | A control that allows users to enter messages that are handled by the MessageStream module. | Current Wiki |
| missingLicenseMessage | Missing License Message | Display an error message when the extension does not have a valid license. | 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 |
| OwlCarousel2 | Owl Carousel 2 | Current Wiki | ||
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | Global |
| plantuml | PlantUML | Content | Convert various text input formats into diagram images using PlantUML. | Global |
| poweredBy | Powered By | Displays a random reference summary | Global | |
| productVersions | Product Versions | content | Display product versions for testing | 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 |
| remotecode | Remote Code | Displays the code (using the ##code## macro) of a remote file | Global | |
| scm | scm | Documentation | Produce scm link | Global |
| script | Script | Development | Execute script in provided script language. | Global |
| showhide | showhide | content | Show Hide Macro | Global |
| success | Success Message | Formatting | Displays a success message note. | Global |
| tableToChartJS | Table to ChartJS | Content | Draws a chart using ChartJS and the data read from a table. | Current Wiki |
| tagcloud | Tag Cloud | Content | Displays the cloud of tags in this wiki or in the specified space, if any. | Current Wiki |
| template | Template | Development | Insert a template. | Global |
| toc | Table of contents | Navigation | Generates a table of contents. | Global |
| todo | Todo | content | Todo macro | Global |
| tooltip | Tooltip | Current Wiki | ||
| 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 |
| version | Version | Content | Specifies since which versions of XWiki the content of the macro corresponds to. | Global |
| videoCard | Video Card | Displays a card with an embedded video | 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 |
HTML
2.0 HTML
| XWiki Syntax 2.1 | Result |
|---|---|
| {{html}}<abbr title="HyperText Markup Language">HTML</abbr>{{/html}} | HTML |
Scripts
2.0 Scripts
| Feature | XWiki Syntax 2.1 |
|---|---|
| Velocity script |
{{velocity}}
#set ($var = "whatever")
{{/velocity}}
|
| Groovy script |
{{groovy}}
def var = "whatever"
{{/groovy}}
|
