XWiki Syntax Guide
Laatst gewijzigd door admin op 15-06-2021
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 |
|---|---|---|---|---|
| toc | Inhoudsopgave | Navigatie | Inhoudsopgave genereren. | Global |
| iconPicker | Icon Picker | Ontwikkeling | Select an icon within the XWiki icon set. | Current Wiki |
| wikimacrocontent | WikiMacro Content | Ontwikkeling | Display editable content of a wikimacro. | Global |
| mention | User Mention | Notifications | Insert a user mention. | Current Wiki |
| example | Example | Vormgeving | Shows an example and its source code. | Current Wiki |
| async | Async macro | Inhoud | Execute asynchronously and/or cache the macro content. | Global |
| spaceindex | Paginaruimte Overzicht | Deprecated | Toont de documenten van een paginaruimte. | Current Wiki |
| box | Rechthoek | Vormgeving | Teken een rechthoek om de betreffende inhoud. | Global |
| spaces | Paginaruimten | Deprecated | Toont alle paginaruimten in deze wiki. | Current Wiki |
| error | Foutmelding | Vormgeving | Toont een foutmelding. | Global |
| attachmentGalleryPicker | Attachment Picker | Ontwikkeling | Grid based attachment picker. | Global |
| warning | Waarschuwingsmelding | Vormgeving | Toont een waarschuwingsmelding. | Global |
| messageSender | Berichten Versturen | Social | Een besturingselement waarmee gebruikers berichten kunnen verzenden die worden afgehandeld door de Berichtenstroom module. | Current Wiki |
| children | Children | Navigatie | Displays a tree of children pages of the current page | Current Wiki |
| workspaces | Werkruimten (Legacy) | Deprecated | Deprecated macro that should not be used here for compatibility reasons. Please use the "wikis" macro instead. | Current Wiki |
| display | Tonen | Inhoud | Andere pagina in de huidige pagina tonen. | Global |
| translation | Translation | Inhoud | Display a translation message. | Global |
| context | Context | Ontwikkeling | Voert inhoud uit in de context van het doorgegeven document | Global |
| pdftoc | PDF Table of Contents | Internal | Generates the table of contents for the PDF export. | Global |
| info | Informatiemelding | Vormgeving | Toont een informatiemelding. | Global |
| tree | Tree | Navigatie | Displays a tree hierarchy defined by the macro content or the source parameter. | Current Wiki |
| liveData | Live Data | Inhoud | Display dynamic lists of data. | Global |
| rss | RSS | Inhoud | Recente RSS-items tonen uit een RSS feed. | Global |
| success | Succesmelding | Vormgeving | Toont een succesmelding. | Global |
| documentTree | Page Tree | Navigatie | Displays the tree of XWiki pages. | Current Wiki |
| template | Template | Ontwikkeling | Insert a template. | Global |
| notificationsAutoWatchPreferences | Notifications Auto Watch Preferences | Notifications | Display the preferences of the current user about auto watched pages. | Current Wiki |
| chart | Grafiek | Inhoud | Toont een uit grafiek die uit verschillende bronnen kan worden gegenereerd | Global |
| container | Container | Layout | Een macro waarmee meerdere groepen kunnen worden ingesloten en opgemaakt, zoals layout. | Global |
| notificationsEmailPreferences | Notifications Email Preferences | Notifications | Display the preferences of the current user about notification emails. | Current Wiki |
| tagcloud | Tagwolk | Inhoud | Toont de wolk van Tags in deze wiki of in de opgegeven paginaruimte. | Current Wiki |
| activity | Activiteiten | Notifications | De Activiteiten-macro geeft informatie over recente activiteiten van gebruikers binnen de XWiki-instantie. De macro toont de maak-, wijzig- en verwijder-gebeurtenissen van pagina's, opmerkingen, bijlagen en annotaties. | Current Wiki |
| python | Python | Ontwikkeling | Python-script uitvoeren. | Global |
| comment | Commentaar | Ontwikkeling | Plaatst commentaar in de bron-inhoud. Deze macro geeft geen output. | Global |
| html | HTML | Ontwikkeling | Voegt HTML of XHTML code in in de pagina. | Global |
| content | Content | Inhoud | Allows writing content in any wiki markup | Global |
| script | Script | Ontwikkeling | Script uitvoeren in de geleverde script-taal. | Global |
| useravatar | Avatar Gebruiker | Inhoud | Toont de avatar van een specifieke gebruiker. | Global |
| office | Office Document Viewer | Inhoud | Bekijk office-bijlagen (doc, ppt, xls, odt, odp, ods etc.) binnen een wiki-pagina zonder deze te downloaden of importeren. | Global |
| gallery | Galerie | Layout | Toont de afbeeldingen uit de opgegeven inhoud in een slideshow. | Global |
| uiextension | UI Extension | Ontwikkeling | Insert a UI extension. | Global |
| notificationsSystemFiltersPreferences | Notifications System Filters Preferences | Notifications | Display the preferences of the given user about system notification filters. | Current Wiki |
| uiextensions | UI Extensions | Ontwikkeling | Insert UI extensions. | Global |
| dashboard | Dashboard | Layout | Een macro voor het maken van een Dashboard, samengesteld uit gadgets. | Global |
| putFootnotes | Voetnoten opnemen | Inhoud | Toont de geplaatste voetnoten. Als deze ontbreekt, worden alle voetnoten standaard getoond aan het einde van de pagina. | Global |
| wikis | Wiki's | Navigatie | Toon alle wiki's | Current Wiki |
| attachmentSelector | Bijlagekiezer | Ontwikkeling | Een besturingselement dat wordt gebruikt voor object properties van het huidige document die de naam bevatten van een bijlage bij het huidige (of doel-) document. Maakt het mogelijk bijlagen te uploaden naar en verwijderen van het doel-document. Als geen doel-document is opgegeven, wordt het huidige document gebruikt. Object properties worden alleen opgeslagen in het huidige document. | Current Wiki |
| notificationsApplicationsPreferences | Notifications Applications Preferences | Notifications | Display the preferences of the current user about notification applications. | Current Wiki |
| cache | Cache | Ontwikkeling | Caches inhoud. | Global |
| menu | Menu | Navigatie | Displays a menu created using simple wiki syntax (nested lists and links). | Global |
| notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Current Wiki |
| documents | Documenten | Inhoud | Toont een lijst met documenten in een Livetable | 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 |
| notifications | Notifications | Notifications | Display notifications about events happened on the wiki. | Current Wiki |
| velocity | Velocity | Ontwikkeling | Velocity-script uitvoeren. | Global |
| wikimacroparameter | WikiMacro Parameter | Ontwikkeling | Display editable parameter of a wikimacro. | Global |
| groovy | Groovy | Ontwikkeling | Groovy-script uitvoeren. | Global |
| footnote | Voetnoot | Inhoud | Maakt een voetnoot die aan het eind van de pagina wordt getoond. | Global |
| code | Code | Vormgeving | Markeer code-fragmenten van verschillende programmeertalen | Global |
| id | Id | Navigatie | Maakt het mogelijk een referentie/locatie in een pagina te maken. In HTML wordt dit bijvoorbeeld een Anker genoemd. Het maakt het mogelijk te verwijzen naar die lokatie, bijvoorbeeld in links. | Global |
| include | Opnemen | Inhoud | Neem andere pagina's op in de huidige pagina. | 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}}
|