XWiki Syntax Guide
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 |
| 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 |
| 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 |
| 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 | Current Wiki |
| 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 |
| dequote | dequote | Erzeugt deutsche Anführungszeichen (96) um den Text. | Global | |
| designer | Designer | Content | Der Text für Designer, damit der Produktname einheitlich wird. | 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 |
| enquote | enquote | Erzeugt englische Anführungszeichen (69 oben) um den Text. | Global | |
| error | Error Message | Formatting | Displays an error message note. | Global |
| example | Example | Formatting | Shows an example and its source code. | Global |
| externalConsentDialog | External Content Privacy Settings Accept Dialog Styling | Content | Displays a dialog that asks the user to accept the conditions of the external content about to to be displayed | Current Wiki |
| externalURL | External URL Redirect | Content | Current Wiki | |
| externalURLcheckbox | External URL Redirect Accept Conditions | Content | Displays a Checkbox that has to be checked by the user in order to show the real link to the external page | Current Wiki |
| externalVimeoVideo | External Vimeo Video | Content | TBD | Current Wiki |
| fa6icon | fa6icon | Content | Fügt ein Icon aus Font Awesome 5 / 6 / Brands ein. | Global |
| fcserver | Formcycle-Server | Content | Der Text für Formcycle, damit der Produktname einheitlich wird. | Current Wiki |
| feerequired | feerequired | Content | Anzeige eines Hinweises, dass etwas kostenpflichtig ist. | Global |
| ficon | ficon | Content | Fügt ein Icon aus dem FORMCYCLE-Font ein. | Global |
| figure | Figure | Content | Eine Abbildung mit Bildunterschrift. | Current Wiki |
| footnote | Footnote | Content | Generates a footnote to display at the end of the page. | Global |
| formcloud | Formcloud | Content | Der Text für FORMCLOUD. | Current Wiki |
| formcycle | Formcycle | Content | Der Text für Formcycle, damit der Produktname einheitlich wird. | Current Wiki |
| fserver | Frontendserver | Content | Der Text für den Frontendserver, damit der Name einheitlich wird. | 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 | |
| groovy | Groovy | Development | Execute a groovy script. | Global |
| html | HTML | Development | Inserts HTML or XHTML code into the page. | Global |
| i18nNoun | Internationalized Noun | Content | Fügt ein Wort oder eine Wortgruppe für eine bestimmte Sprache ein. Dies wird insbesonders für Produktnamen genutzt, damit diese einheitliche geschrieben sind. | Current Wiki |
| icon | Font Awesome icon | Icons | Inserts a Font Awesome icon | Current Wiki |
| 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 |
| internBaseOptionsElement | internBaseOptionsElement | Content | Internes Makro, welches nur im Bereich "Elemente" im Designer genutzt wird. | Current Wiki |
| italic | Italics | Content | Setzt Text kursiv. | Current Wiki |
| javadoc | javadoc | Inserts a link to the JavaDoc, currently available at https://docs.formcycle.eu/ When the URL to the docs change, it only needs to be changed in this macro. | Global | |
| job | Job | Execute the macro content asynchronously and display progress. | Global | |
| jobprogress | Job Progress | Internal | Provide a UI to follow asynchronous job progression | Current Wiki |
| jpath | jpath | Content | Name zu einer Javaklasse, Package etc. | Current Wiki |
| js | JavaScript-Code | content | Fügt JavaScript-Beispielscode in verschiedenen Varianten ein. Hier sollte modernes JavaScript verwendet werden. Es muss zudem JavaScript für IE angelegt werden, hierzu ist Makro jsIE zu benutzen. | Global |
| jsdoc | jsdoc | Inserts a link to the JavaScript documentation, currently available at https://jsdocs.formcycle.eu/jsdocs/en and https://jsdocs.formcycle.eu/jsdocs/de When the URL to the docs change, it only needs to be changed in this macro. | Global | |
| jsIE | JavaScript-Code (Legacy / IE) | content | JavaScript-Beispielscode für alte Browser (Internet Explorer). Muss zusammen mit dem Makro "js" verwendet werden. | 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 |
| lightbox | Lightbox Image | Content | Add a click-enlargeable image. | Current Wiki |
| litem | List Item | Content | Zeile einer Liste. Optional mit Titel, der entsprechend dargestellt wird. | Current Wiki |
| liveData | Live Data | Content | Display dynamic lists of data. | Global |
| localize | Localize | Content | Makro, dessen Inhalt nur angezeigt wird, wenn die Wiki in der angegebenen Sprache aufgerufen wird. Sinnvoll für Seiten wie den Blog, die sich nicht lokalisieren lassen. Dann können einfach alle Sprachversion auf eine Seite gesetzt werden. | Current Wiki |
| MainMenuTile | MainMenuTile | MainMenuTile | MainMenuTile | Global |
| MainMenuTiles | MainMenuTiles | Content | Erzeugen der Kacheln für die Startseite. | 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 |
| mserver | Masterserver | content | Der Text für den Frontendserver, damit der Name einheitlich wird. | Current Wiki |
| nofooter | Show no footer (Comments, Attachments, ...) | Content | 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 |
| panel | Panel | Content | Panel. | Current Wiki |
| 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 |
| 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 |
| rarrow | Right Arrow | Content | Current Wiki | |
| release | Release | Content | The content of this macro is displayed differently depending on the current release. If the version is not released yet, the contents are hidden. Otherwise, the content is shown, possibly with a note indicating its required version. | |
| Current Wiki | ||||
| script | Script | Development | Execute script in provided script language. | Global |
| smallcaps | Small Caps | Content | Echte Kapitälchen. | Current Wiki |
| spaceindex | Space Index | Deprecated | Lists the pages in a space. | Current Wiki |
| spaces | Spaces | Deprecated | Displays all the spaces in this wiki. | Current Wiki |
| subpages | Sub Pages | Content | Global | |
| subpagesalpha | Sub Pages Alphabetical | Content | Current Wiki | |
| success | Success Message | Formatting | Displays a success message note. | Global |
| table | Table | Content | Wrapper für Tabellen, um zusätzliche Optionen für Tabellen festzulegen. Die Tabelle wird wie üblich mit XWiki-Syntax geschrieben. | Current Wiki |
| tabs | Tabbed view renderer | Content | Creates tabbed view for content areas wrapped into <div /> with unique id (see macro home for details) | 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 |
| ttip | Tooltip | Content | Zum Anzeigen von Tooltips für Zusatzinformationen. | Current Wiki |
| uiextension | UI Extension | Development | Insert a UI extension. | Global |
| uiextensions | UI Extensions | Development | Insert UI extensions. | Global |
| urlbox | URL-Box | Content | Current Wiki | |
| useravatar | User Avatar | Content | Allows displaying the avatar for a specific user. | Global |
| velocity | Velocity | Development | Executes a Velocity script. | Global |
| version | version | Content | Anzeige von Inhalt in Abhängigkeit der aktuellen Version bzw. Anzeige von Versionsinfos. Einstellung der aktuellen Version auf der Seite https://help6.formcycle.de/xwiki/bin/view/Customization/FCVersion | Current Wiki |
| 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 |
| 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 |
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}}
|