XWiki Syntax Guide
Last modified by Abdurachman Putra on 2025/01/07 09:29
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 |
| analyticsFilter | Analytics filter | Analytics | Add filtering options for the analytics macros of the current page. The filtering criteria will be saved in the current URL, to have a reproducible state, and will also override eventual filter set at macro level. | Global |
| 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 |
| 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 |
| browserEngines | Browser engines | Analytics | This report shows your visitors' browsers broken down into browser engines. | Global |
| browsers | Browsers | Analytics | This report contains information about what kind of browser your visitors were using. | 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 |
| configurations | Configurations | Analytics | This report shows the most common overall configurations that your visitors had. A configuration is the combination of an operating system, a browser type and a screen resolution. | 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 |
| country | Country | Analytics | Shows which country your visitors connected from when accessing your website. | Global |
| dashboard | Dashboard | Layout | A macro to define a dashboard to fill with gadgets. | Global |
| deviceBrand | Device brand | Analytics | This report shows the brands / manufacturers of the devices your visitors were using. In most cases this information is only available for non-desktop devices. | Global |
| deviceModel | Device model | Analytics | This report shows the devices your visitors are using. Each model is displayed combined with the device brand as some model names are used by multiple brands. | Global |
| deviceType | Device type | Analytics | This report shows the types of devices your visitors were using. This report will always show all device types Matomo is able to detect, even if there were no visits with a specific type. | Global |
| 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 |
| entryPages | Entry pages | Analytics | This report contains information about the entry pages that were used during the specified period. An entry page is the first page that a user views during their visit. | Global |
| error | Error Message | Formatting | Displays an error message note. | Global |
| example | Example | Formatting | Shows an example and its source code. | Current Wiki |
| exitPages | Exit pages | Analytics | This report contains information about the exit pages that occurred during the specified period. An exit page is the last page that a user views during their visit. The exit URLs are displayed as a folder structure. Use the plus and minus icons on the left to navigate. | Global |
| faq | FAQ | Lists FAQ entries | 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 |
| 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 |
| 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 |
| info | Info Message | Formatting | Displays an info message note. | Global |
| 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 |
| 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 |
| missingLicenseMessage | Missing License Message | Display an error message when the extension does not have a valid license. | Global | |
| mostViewedPages | Most viewed pages | Analytics | When visitors search on your website, they are looking for a particular page, content, product, or service. This report lists the pages that were clicked the most after an internal search. | 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 |
| operatingSystemVersions | Operating system versions | Analytics | This report shows you the operating systems your visitors are using. Each version and distribution is shown separately. | Global |
| pagebreak | pagebreak | content | Page Break | Global |
| PagesFollowingASiteSearch | Pages following a site search | Analytics | Displays pages users clicked on after a search. | Global |
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | Global |
| poll | Poll | Displays the results of a poll. | 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 |
| reportfield | Report Field | Insert a field in a report part for the reporting application | Current Wiki | |
| reportsection | Report Section | reporting | Marker of a report section in a generation of a report | Current Wiki |
| returningVisitsOverTime | Returning visits over time | Analytics | This is an overview of the returning visits. It is broken down into various reports, which are displayed at the bottom of the macro | Global |
| screenResolution | Screen Resolution | Analytics | This report shows the screen resolutions your visitors used when viewing your website. | Global |
| script | Script | Development | Execute script in provided script language. | Global |
| searchCategories | Search categories | Analytics | This report lists the Categories that visitors selected when they made a Search on your website. | Global |
| siteSearchKeywords | Site search keywords | Analytics | This report lists the Search Keywords that visitors searched for on your internal Search Engine. | 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 |
| 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 |
| 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 |
| visitsOverview | Visits overview | Analytics | This is an overview of the visit evolution. | Global |
| warning | Warning Message | Formatting | Displays a warning message note. | Global |
| webBrowserLanguage | Web browser language | Analytics | Shows which language the visitor's browsers are using. (e.g. "French") | 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 |
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}}
|