Guide de syntaxe XWiki
Modifié par Admin le 24/03/2023 - 15:51
Syntaxe XWiki 2.1 » Programmer
Syntaxe XWiki 2.1: Programmer
Macros
2.0 Macros
En syntaxe XWiki 2.0, il y a aussi deux types de macros:
- Les macros Velocity appelées en utilisant la syntaxe #macroname(param1 ... paramN) dans la Macro Velocity
- Les macros XWiki appelées en utilisant la syntaxe{{macroname param1="value1" ... paramN="valueN"}}
Fonctionnalité | Syntaxe XWiki 2.1 | Résultat |
---|---|---|
Macro | {{code language="java"}} System.out.println("Hello World!"); {{/code}} | System.out.println("Hello World!"); |
Macros dans ce wiki
Id | Nom | Catégories | Description | Visiblité |
---|---|---|---|---|
activity | Activité | Notifications | La macro Activity affiche l'activité récente des utilisateurs dans le wiki, elle fournit des information concernant les pages (création, édition, suppression) ainsi que sur les annotations, les commentaires et les pièces jointes. | Wiki courant |
anchor | Legacy Confluence bridge for Anchor | Obsolète | Legacy Confluence bridge for Anchor | Wiki courant |
async | macro async | Contenu | Exécution asynchrone et/ou mise en cache du contenu de la macro. | Globale |
attachmentGalleryPicker | Sélecteur de pièces jointes | Développement | Grille de sélection des pièces jointes. | Globale |
attachmentSelector | Sélecteur de pièce jointe | Développement | Un contrôle à utiliser pour les propriétés de l'objet du document actuel qui sont censées contenir le nom d'une pièce jointe à partir du document courant (ou cible). Autorise le chargement de nouvelles pièces jointes, et la suppression des pièces jointes à partir du document cible. Si aucun document cible n'est spécifié, le document actuel sera utilisé. Les propriétés de l'objet ne sont enregistrées que dans le document actuel. | Wiki courant |
awmkanban | Kanban board for AppWithinMinutes | Display XWiki Documents from an AWM as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Globale | |
box | Boîte | Format | Affiche une boîte autour du contenu entré. | Globale |
button | Button Macro | Insert a noticeable, clickable button on your XWiki page to highlight links and create call to actions! | Globale | |
cache | Cache | Développement | Contenu des caches. | Globale |
chart | Graphique | Contenu | Affiche un graphique généré à partir d'une source de données | Globale |
children | Children | Navigation | Displays a tree of children pages of the current page | Wiki courant |
code | Code | Format | Permet d'afficher des lignes de code dans un langage informatique donné | Globale |
column | Confluence bridge for Column | Obsolète | Confluence bridge for the Column macro. | Globale |
comment | Commentaire | Développement | Permet d'ajouter des commentaires dans le contenu source. Cette macro ne produit rien. | Globale |
confluence_attachments | Confluence bridge for Attachments | Confluence | Confluence bridge for the Attachment macro | Wiki courant |
confluence_children | Confluence bridge for Children | Confluence | Confluence bridge for the Children macro using the XWiki document tree macro. | Globale |
confluence_column | Confluence bridge for Column | Confluence | Confluence bridge for the Column macro. | Wiki courant |
confluence_contentbylabel | Confluence bridge for Content by label | Confluence Bridge for the Content by label macro | ||
confluence_details | Confluence bridge for Details | Confluence Bridge for the Details (Page Properties) macro. It allows defining property key-value pairs in a table contained in the macro. | Globale | |
confluence_detailssummary | Confluence bridge for Details Summary | Confluence bridge for the Details Summary (Page Properties Report) macro to display properties attached to a page using the Details macro. | Globale | |
confluence_drawio | Confluence bridge for Drawio | Confluence | Confluence Bridge for the Drawio macro. By default it displays the PNG file used by the Drawio macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Globale |
confluence_float | Float macro | Confluence bridge for the Float macro using the XWiki box macro | Globale | |
confluence_gallery | Confluence bridge for Gallery | Confluence | Confluence Bridge for the Gallery macro. | Globale |
confluence_gliffy | Confluence bridge for Gliffy | Confluence | Confluence Bridge for the Gliffy macro. By default it displays the PNG file used by the Gliffy macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Globale |
confluence_htmlcomment | Confluence Bridge for HTML Comment | Confluence Bridge for HTML Comment macro. | Globale | |
confluence_layout | Confluence bridge for Layout | Confluence | Confluence bridge macro for the Layout macro to define a layout, containing layout sections (using the confluence_layout-section macro). | Globale |
confluence_layout-cell | Confluence bridge for Layout Cell | Confluence | Confluence bridge for the Layout Cell macro. It is used for defining a part a layout section, used inside the confluence_layout-section macro. | Globale |
confluence_layout-section | Confluence bridge for Layout Section | Confluence | Confluence bridge for the Layout Section macro. It is used to define a section of a layout, used inside the layout macro and containing layout cells. | Wiki courant |
confluence_mathblock | Confluence bridge for Mathblock | Confluence | Confluence bridge for the Mathblock macro (LaTeX math block expressions). | Globale |
confluence_mathblock-ref | Confluence bridge for Mathblock Reference | Confluence | Confluence bridge macro for the Mathblock Reference macro | Globale |
confluence_mathinline | Confluence bridge for Mathinline | Confluence | Confluence bridge macro for the Mathinline macro (LaTeX math inline expressions). | Globale |
confluence_mockup | Confluence bridge for Mockup | Confluence | Confluence Bridge for the Balsamiq Mockup macro. It only displays the image preview of the mockup. | Globale |
confluence_multimedia | Confluence bridge for Multimedia | Confluence | Confluence Bridge for the Multimedia macro. | Globale |
confluence_note | Confluence bridge for Note | Confluence | Confluence bridge for the Note macro to the XWiki Success macro | Globale |
confluence_outgoing-links | Confluence Outgoing Links | Contenu | Confluence bridge macro for outgoing-links. | Globale |
confluence_pagetree | Confluence bridge for Page Tree | Confluence | Confluence Bridge for the Confluence Page Tree macro to the XWiki documentTree macro. | Globale |
confluence_paste-code-macro | Confluence bridge for Paste Code Macro | Confluence | Confluence bridge for the Confluence Paste Code macro to the XWiki Code macro | Globale |
confluence_section | Confluence bridge for Section | Confluence | Confluence bridge for the Section macro | |
confluence_time | Confluence bridge for Time | Confluence | Confluence bridge for the Time macro | Globale |
confluence_tip | Confluence bridge for Tip | Confluence | Confluence bridge for the Tip macro to the XWiki Success macro | Globale |
confluence_toc-zone | Confluence Toc Zone | Contenu | Confluence bridge macro for toc-zone. | Globale |
confluence_wireframe | Confluence bridge for Balsamiq Wireframe | Confluence | Confluence Bridge for the Balsamiq Wireframe macro. It only displays the image preview of the wireframe. | Globale |
container | Conteneur | Mise en page | Macro permettant de réunir plusieurs groupes et d'ajouter des décorations comme la mise en page. | Globale |
content | Contenu | Contenu | Autorise tous les types de langages wiki dans le contenu | Globale |
content-report-table | Content Report Table Macro | Provides a content report in table format, based on labels. | Globale | |
context | Contexte | Développement | Execute le contenu dans le contexte du document passé en paramètre | Globale |
contributors | Contributors | Contributors Confluence Bridge macro to show the contributors of a given document. | Globale | |
dashboard | Tableau de bord | Mise en page | Macro permettant de définir un tableau de bord à remplir avec des gadgets. | Globale |
date | Date | Contenu | Use the date macro to set and format due dates within task macros and more! | Globale |
diagram | Diagramme | Affiche un diagramme. | Wiki courant | |
display | Affichage | Contenu | Affiche d'autres pages dans la page courante. | Globale |
displayIcon | Icon | Contenu | Display an icon. | Globale |
documents | Documents | Contenu | Affiche la liste des documents dans un tableau dynamique | Wiki courant |
documentTree | Arborescence | Navigation | Affiche l'arborescence des pages XWiki. | Wiki courant |
drawio | Legacy unprefixed Confluence bridge for Drawio | Obsolète | Legacy Unprefixed Confluence Bridge for the Drawio macro. By default it displays the PNG file used by the Drawio macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Globale |
error | Message d'erreur | Format | Permet d'afficher un message d'erreur. | Globale |
example | Example | Format | Shows an example and its source code. | Wiki courant |
excerpt | Excerpt | Excerpt macro. It marks part of the page's content for use by other macros. It is compatible with the Confluence Excerpt macro. | Globale | |
excerpt-include | Excerpt include | Contenu | Includes excerpts from other documents into the current page. The included pages need to contain the simple `excerpt` macro. | Globale |
expand | Expand | Add the Expand macro to your page to provide content in an expandable / collapsible section. This is one of Confluence's most popular macros. It's great for: visually reducing the amount of information on a page, breaking process information down into clickable steps, hiding background or obsolete information, while still keeping it on the page for future reference. The macro is collapsed by default, people need to click each one to expand it. There's no way to expand all macros on a page at once, however all Expand macros are automatically expanded when you print or export the page to PDF. | Wiki courant | |
footnote | Note de bas de page | Contenu | Génère une note qui sera affichée en bas de page. | Globale |
gallery | Galerie | Mise en page | Affiche les images trouvées dans le contenu fourni en mode présentation / galerie. | Globale |
gliffy | Legacy unprefixed Confluence bridge for Gliffy | Obsolète | Legacy Unprefixed Confluence Bridge for the Gliffy macro. By default it displays the PNG file used by the Gliffy macro to preview the diagram. The user has the option to convert the diagram into an XWiki Diagram for being able to modify it. | Globale |
groovy | Groovy | Développement | Exécute un script Groovy. | Globale |
hide-if | Hide if | Contenu | Hide the content of this macro if the condition set through the parameters is met. | Globale |
html | HTML | Développement | Permet d'insérer du code HTML ou XHTML dans la page. | Globale |
iconPicker | Sélecteur d'icônes | Développement | Sélectionnez une icône dans le set d'icônes XWiki. | Wiki courant |
id | Ancre | Navigation | Permet d'insérer une ancre au sein d'une page. Elle permettra de créer un lien vers cet endroit précis de la page. | Globale |
include | Inclure | Contenu | Permet d'inclure une autre page dans la page courante. | Globale |
info | Message d'information | Format | Permet d'afficher un message d'information. | Globale |
job | Job | Développement | Execute the macro content asynchronously and display progress. | Globale |
jobprogress | Job Progress | Interne | Provide a UI to follow asynchronous job progression | Wiki courant |
jwplayer | JW Player | Contenu | JW Player est un lecteur multimédia open source intégrable dans les sites web, supportant un grand nombre de formats audio et vidéo. Le lecteur est facile à configurer, personnaliser et est extensible. | Wiki courant |
kanban | Kanban | Kanban macro allowing to display and edit a kanban | Wiki courant | |
kanbanboard | Kanban board - Task Manager | Contenu | Display the tasks as a Kanban board (see https://en.wikipedia.org/wiki/Kanban_board). | Wiki courant |
layout | Legacy unprefixed Confluence bridge for Layout | Obsolète | Legacy Unprefixed Confluence bridge macro for the Layout macro to define a layout, containing layout sections (using the confluence_layout-section macro). | Globale |
layout-cell | Legacy unprefixed Confluence bridge for Layout Cell | Obsolète | Legacy Unprefixed Confluence bridge for the Layout Cell macro. It is used for defining a part a layout section, used inside the confluence_layout-section macro. | Globale |
layout-section | Legacy unprefixed Confluence bridge for Layout Section | Obsolète | Legacy Unprefixed Confluence bridge for the Layout Section macro. It is used to define a section of a layout, used inside the layout macro and containing layout cells. | Globale |
liveData | Live Data | Contenu | Affiche des listes dynamiques de données. | Globale |
locationSearch | Recherche par emplacement | Recherche à l'emplacement donné. | Wiki courant | |
mathblock | Legacy unprefixed Confluence bridge for Mathblock | Obsolète | Legacy Unprefixed Confluence bridge for the Mathblock macro (LaTeX math block expressions). | Globale |
mathblock-ref | Legacy unprefixed Confluence bridge for Mathblock Reference | Obsolète | Legacy Unprefixed Confluence bridge macro for the Mathblock Reference macro | Globale |
mathinline | Legacy unprefixed Confluence bridge for Mathinline | Obsolète | Legacy Unprefixed Confluence bridge macro for the Mathinline macro (LaTeX math inline expressions). | Globale |
mathjax | MathJax | Contenu | Enter content supported by the MathJax javascript engine. | Wiki courant |
mention | Mention Utilisateur | Notifications | Insert une mention utilisateur. | Wiki courant |
menu | Menu | Navigation | Affiche un menu créé en utilisant une syntaxe wiki simple (listes imbriquées et liens). | Globale |
messageSender | Emetteur du message | Social | Un contrôle qui permet aux utilisateurs d'entrer des messages qui sont gérés par le module de MessageStream. | Wiki courant |
missingLicenseMessage | Missing License Message | Display an error message when the extension does not have a valid license. | Globale | |
mockup | Legacy unprefixed Confluence bridge for Mockup | Obsolète | Legacy Unprefixed Confluence Bridge for the Balsamiq Mockup macro. It only displays the image preview of the mockup. | Globale |
msStream | Microsoft Stream | Embed a Microsoft Stream video in a page by simply passing the URL and any customization parameters. | Globale | |
multimedia | Legacy unprefixed Confluence bridge for Multimedia | Obsolète | Legacy Unprefixed Confluence Bridge for the Multimedia macro. | Globale |
net-presago-stream-macro | Legacy Confluence bridge for Microsoft Stream | Obsolète | Legacy Confluence bridge for Microsoft Stream. | |
note | Legacy unprefixed Confluence bridge for Note | Obsolète | Legacy Unprefixed Confluence bridge for the Note macro to the XWiki Success macro | Globale |
notifications | Notifications | Notifications | Affiche des notifications liées à l'activité du wiki. | Wiki courant |
notificationsApplicationsPreferences | Préférences de notification | Notifications | Affiche les préférences de notification de l'utilisateur courant. | Wiki courant |
notificationsAutoWatchPreferences | Préférences pour les notifications d'abonnement automatique | Notifications | Affiche les préférences de l'utilisateur pour les notifications d'abonnement automatique aux pages. | Wiki courant |
notificationsCustomFiltersPreferences | Notifications Custom Filters Preferences | Notifications | Display the preferences of the given user about custom notification filters. | Wiki courant |
notificationsEmailPreferences | Notifications Email Preferences | Notifications | Display the preferences of the current user about notification emails. | Wiki courant |
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. | Wiki courant |
notificationsSystemFiltersPreferences | Notifications System Filters Preferences | Notifications | Display the preferences of the given user about system notification filters. | Wiki courant |
office | Liseuse de Document Office | Contenu | Voir les pièces jointes office (doc, ppt, xls, odt, odp, ods etc.) au sein des pages wiki sans besoin de les télécharger ou de les importer. | Globale |
pagetree | Legacy unprefixed Confluence bridge for Page Tree | Obsolète | Legacy Unprefixed Confluence Bridge for the Confluence Page Tree macro to the XWiki documentTree macro. | Globale |
panel | Panel Macro | Panel macro to display XWiki content inside a panel. | Wiki courant | |
paste-code-macro | Legacy unprefixed Confluence bridge for Paste Code Macro | Obsolète | Legacy Unprefixed Confluence bridge for the Confluence Paste Code macro to the XWiki Code macro | Globale |
pdftoc | PDF Table of Contents | Interne | Generates the table of contents for the PDF export. | Globale |
pdfviewer | PDF Viewer | Contenu | PDF Viewer basé sur Mozilla pdf.js | Globale |
profile-picture | Profile Picture | Confluence Profile Picture macro | Globale | |
putFootnotes | Afficher les notes de bas de page | Contenu | Permet d'afficher les notes de bas de page présentes jusqu'à ce point dans le document. Le cas échéant, les notes de bas de page seront affichées en bas de la page. | Globale |
python | Python | Développement | Exécute un script Python. | Globale |
recently-updated | Recently Updated | Add the Recently Updated macro to a page to show a list of pages, blogs, files, and comments that have been created or edited recently. This is great for project landing, information pages, or team space home pages. It's very flexible, you can limit the list to specific people, spaces, types of content, and more. | Wiki courant | |
script | Script | Développement | Exécute un script dans le langage indiqué. | Globale |
section | Confluence bridge for Section | Obsolète | Confluence bridge for the Section macro. | Globale |
show-if | Show if | Contenu | Show the content of this macro if the condition set through the parameters is met. | Globale |
spaceindex | Index des espaces | Obsolète | Liste les documents d'un espace. | Wiki courant |
status | Status | Insert a colored label in the text to highlight the status of an item. | Wiki courant | |
success | Message en cas de succès | Format | Affiche un message en cas de succès. | Globale |
tab | Tab | Contenu | Tab element for the tab group macro. This is expected to be put as the tab-group macro content. | Globale |
tab-group | Tab group | Contenu | The main macro which group tab macro elements. | Globale |
tagcloud | Nuage de tag | Contenu | Affiche le nuage de tags du wiki courant ou de l'espace spécifié. | Wiki courant |
tagList | Tag list | Show a list of all the macros in your instance. | Globale | |
task | Task | Contenu | Create a task that you can assign an user to using the mention macro and use the date macro to set a deadline. | Globale |
task-report | Task report macro | Contenu | Create a custom report of the tasks within the wiki. | Wiki courant |
taskcard | Task card | Contenu | Display a task and its information as a card. | Wiki courant |
taskgantt | Gantt Diagram | Contenu | Display tasks from Task Manager Application in a Gantt diagram. | Wiki courant |
tasks | Tasks | Contenu | Display one or more tasks identified by their IDs. | Globale |
tasks-report-macro | Legacy Confluence bridge for Tasks Report | Contenu | Legacy Confluence bridge for Tasks Report. | Wiki courant |
team | Team | Display avatars of the members of a team. | Wiki courant | |
template | Template | Développement | Insérer un template. | Globale |
time | Time | Format | Wiki courant | |
tip | Legacy unprefixed Confluence bridge for Tip | Obsolète | Legacy Unprefixed Confluence bridge for the Tip macro to the XWiki Success macro | Globale |
toc | Table des matières | Navigation | Génère une table de matières. | Globale |
translation | Traduction | Contenu | Affiche un message de traduction. | Globale |
tree | Arbre | Navigation | Affiche une hiérarchie de l'arborescence définie par le contenu de la macro ou le paramètre source. | Wiki courant |
uiextension | Extension UI | Développement | Insérez une extension UI. | Globale |
uiextensions | Extensions UI | Développement | Insérer les extensions UI. | Globale |
useravatar | Afficher la photo de profil | Contenu | Permet d'afficher l'avatar d'un utilisateur donné. | Globale |
userList | User List | Contenu | Displays a list of users with a customizable set of their properties | Globale |
userlister | Legacy Confluence bridge for User Lister | Legacy Confluence bridge for User Lister. | Wiki courant | |
userProfile | User Profile | Contenu | Displays a user profile with custom properties | Globale |
velocity | Velocity | Développement | Exécute un script Velocity. | Globale |
video | Video | Contenu | 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). | Wiki courant |
view-file | View Files | Show files using PDF Viewer Macro or Office Viewer | Wiki courant | |
viewdoc | Legacy Confluence bridge for View Office Word | Obsolète | Legacy Confluence bridge for View Office Word. | Wiki courant |
viewpdf | Legacy Confluence bridge for View PDF | Obsolète | Legacy Confluence bridge for View PDF. | Wiki courant |
viewppt | Legacy Confluence bridge for View Office PowerPoint | Obsolète | Legacy Confluence bridge for View Office PowerPoint. | Wiki courant |
viewxls | Legacy Confluence bridge for View Office Excel | Obsolète | Legacy Confluence bridge for View Office Excel. | Wiki courant |
warning | Message d'avertissement | Format | Permet d'afficher un message d'avertissement. | Globale |
wikimacrocontent | WikiMacro Content | Développement | Display editable content of a wikimacro. | Globale |
wikimacroparameter | WikiMacro Parameter | Développement | Display editable parameter of a wikimacro. | Globale |
wikis | Wikis | Navigation | Liste de tous les wikis | Wiki courant |
wireframe | Legacy unprefixed Confluence bridge for Balsamiq Wireframe | Obsolète | Legacy Unprefixed Confluence Bridge for the Balsamiq Wireframe macro. It only displays the image preview of the wireframe. | Globale |
workspaces | Espaces de travail (obsolète) | Obsolète | Cette macro est dépréciée et ne doit plus être utilisée pour des raisons de compatibilité. Merci de la remplacer par un macro "wikis". | Wiki courant |
HTML
2.0 HTML
Syntaxe XWiki 2.1 | Résultat |
---|---|
{{html}}<b>gras</b>{{/html}} | gras |
Scripts
2.0 Scripts
Feature | Syntaxe XWiki 2.1 |
---|---|
Script Velocity | {{velocity}} #set ($var = "quelquechose") {{/velocity}} |
Script Groovy | {{groovy}} def var = "quelquechose" {{/groovy}} |