Guide de syntaxe XWiki

Modifié par Admin Admin le 2021/08/19 13:56

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"}}

Pour accéder à la liste de toutes les macros disponibles, allez à la page de référence des macros.

Fonctionnalité	Syntaxe XWiki 2.1	Résultat
Macro	{{code language="java"}} System.out.println("Hello World!"); {{/code}}	System.out.println("Hello World!");

Les macros Radeox ne peuvent pas être utilisées en syntaxe XWiki 2.0. C'est la raison pour laquelle elles ont été ré-écrites comme des macros XWiki.

Pour accéder à la liste de toutes les macros disponibles, allez sur Extensions wiki.

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
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
box	Boîte	Format	Affiche une boîte autour du contenu entré.	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
comment	Commentaire	Développement	Permet d'ajouter des commentaires dans le contenu source. Cette macro ne produit rien.	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
context	Contexte	Développement	Execute le contenu dans le contexte du document passé en paramètre	Globale
dashboard	Tableau de bord	Mise en page	Macro permettant de définir un tableau de bord à remplir avec des gadgets.	Globale
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
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
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
groovy	Groovy	Développement	Exécute un script Groovy.	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
liveData	Live Data	Contenu	Affiche des listes dynamiques de données.	Globale
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
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
pdftoc	PDF Table of Contents	Interne	Generates the table of contents for the PDF export.	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
script	Script	Développement	Exécute un script dans le langage indiqué.	Globale
spaceindex	Index des espaces	Obsolète	Liste les documents d'un espace.	Wiki courant
spaces	Espaces	Obsolète	Affiche tous les espaces du wiki courant.	Wiki courant
success	Message en cas de succès	Format	Affiche un message en cas de succès.	Globale
tagcloud	Nuage de tag	Contenu	Affiche le nuage de tags du wiki courant ou de l'espace spécifié.	Wiki courant
template	Template	Développement	Insérer un template.	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
velocity	Velocity	Développement	Exécute un script Velocity.	Globale
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
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

En syntaxe XWiki 2.1, le code HTML ou XHTML doit être écrit en utilisant la macro {{html}}.

Syntaxe XWiki 2.1	Résultat
{{html}}<b>gras</b>{{/html}}	gras

En syntaxe XWiki 2.1, par défaut, la macro {{html}} ne peut pas analyser la syntaxe wiki. Pour l'activer, utilisez {{html wiki="true"}}.

Scripts

2.0 Scripts

En syntaxe XWiki 1.0, il était possible d'inclure des scripts Velocity directement dans la page. Cela a créé quelques problèmes, par exemple, les cas où l'utilisateur avait inclus involontairement du contenu Velocity. Cela affectait aussi la performance des pages qui ne nécessitaient pas de contenu Velocity. Il y avait eu d'autres limitations techniques. Ainsi, en syntaxe XWiki 2.1, les scripts Velocity doivent être inclus en utilisant la macro velocity. En va de même pour l'inclusion des scripts Groovy.

Feature	Syntaxe XWiki 2.1
Script Velocity	{{velocity}} #set ($var = "quelquechose") {{/velocity}}
Script Groovy	{{groovy}} def var = "quelquechose" {{/groovy}}