XWiki Syntax Guide
Last modified by Justin Morgan on 2019/09/29 18:05
XWiki Syntax 2.1 » » ${crtSection.name}
XWiki Syntax 2.1: $sectionName
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 | Category | 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 |
| 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
| blogPostLayoutFull | Blog Post Layout Full | This macro is used to display a full blog post | Current Wiki | |
| wikimacrocontent | WikiMacro Content | Development | Display editable content of a wikimacro. | Global |
| example | Example | Shows an example and its source code. | Current Wiki | |
| watchlist | Watchlist | Content | Show the content of your current watchlist. | 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 | Content | Asynchronous and cached execution of wiki content. | Global |
| spaceindex | Space Index | Deprecated | Lists documents in a space. | Current Wiki |
| figureCaption | Figure Caption | Development | Provide a figure caption when used inside the Figure macro. | Global |
| filetagcloud | FileManager tag cloud | Content | Displays the cloud of file tags in this wiki or in the specified space, if any. | Current Wiki |
| box | Box | Formatting | Draw a box around provided content. | Global |
| icon | Font Awesome icon | Icons | Inserts a Font Awesome icon | Current Wiki |
| spaces | Spaces | Deprecated | Displays all the spaces in this wiki. | Current Wiki |
| error | Error Message | Formatting | Displays an error message note. | Global |
| attachmentGalleryPicker | Attachment Picker | Development | Grid based attachment picker. | Global |
| sortable_tables | Sorteable Tables | Makes all tables in the content of the current page sorteable. | 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. | Current Wiki |
| children | Children | Navigation | Displays a tree of children pages of the current page | Current Wiki |
| workspaces | Workspaces | Deprecated | Deprecated macro that should not be used, here for compatibility reason. Please use the "wikis" macro instead. | 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 | |
| context | Context | Development | Executes content in the context of the passed document | Global |
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | Global |
| jira | JIRA | Content | Fetches information from a JIRA server and displays them as a table, list or enumeration. | Global |
| info | Info Message | Formatting | Displays an info message note. | Global |
| moccacalendar | Mocca Calendar | Content | Displays a Calendar | Current Wiki |
| tree | Tree | Navigation | Displays a tree hierarchy defined by the macro content or the source parameter. | Current Wiki |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| blogs | Blogs Livetable | The blogs macro is used to list on a livetable all the blog available on the wiki | Current Wiki | |
| success | Success Message | Formatting | Displays a success message note. | Global |
| documentTree | Document Tree | Navigation | Displays the tree of XWiki documents. | Current Wiki |
| nextmeetings | Next Meetings | Displays a defined number of upcoming meetings | Current Wiki | |
| template | Template | Development | Insert a template. | Global |
| chart | Chart | Content | Displays a graphical chart generated from miscellaneous data sources | Global |
| fileManager.recentFiles | Recent Files | Content | Lists the files that have been recently uploaded through the File Manager. | Current Wiki |
| container | Container | Layout | A macro to enclose multiple groups and add decoration, such as layout. | Global |
| notificationsEmailPreferences | Notifications Email Preferences | Notifications | Display the preferences of the current user about notification emails. | Current Wiki |
| activity | Activity | Content | The Activity Macro provides information about recent activities done by the users inside the XWiki instance. It lists the create, edit and delete events for pages, as well as comments, attachments and annotations. | Current Wiki |
| blogPostLayoutLink | Blog Post Layout Link | This macro is used to display a blog post as a simple link | Current Wiki | |
| 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 |
| blogPostLayoutCards | Cards Blog Post Layout | This macro is used to display a blog post using the 'Cards' layout | Current Wiki | |
| 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 |
| displayIcon | Icon | Content | Display an icon. | 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 Extensions | Development | Insert a UI extension. | Global |
| dashboard | Dashboard | Layout | A macro to define a dashboard. | Global |
| uiextensions | UI Extensions | Development | Insert UI extensions. | Global |
| figure | Figure | Development | Tag content as an illustration and with an optional caption. | 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 |
| wikis | Wikis | Navigation | List all wikis | Current Wiki |
| attachmentSelector | Attachment Selector | Development | A control to be used for object properties of the current document that are supposed to contain the name of an attachment from the current (or target) document. Allows uploading new attachments, and deleting attachments from the target document. If no target document is specified, the current document will be used. Object properties are only saved to the current document. | 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 | Current Wiki | |
| ideasrecent | Recent Ideas | Displays the N most recent ideas. | 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 | |
| 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 | |
| figureTypeRecognizer | Figure Type Recognizer | Internal | Internal macro used to recognize the type of a figure. | Global |
| filemanagerdoc | File Manager Document | Content | Inserts a file manager document in a page, with or without preview | Current Wiki |
| documents | Documents | Content | Displays a list of documents in a Livetable | Current Wiki |
| notificationsFiltersPreferences | Notifications Filters Preferences | Notifications | Display the preferences of the current user about notification filters. | Current Wiki |
| notifications | Notifications | Notifications | Current Wiki | |
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| pdfviewer | pdfviewer | Content | PDF Viewer based on Mozilla pdf.js | Current Wiki |
| faq | FAQ | Lists FAQ entries | Current Wiki | |
| 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 | |
| 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 |
| 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 |