Guide de syntaxe XWiki

Modifié par superadmin le 2022/06/05 23:31

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

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

FonctionnalitéSyntaxe XWiki 2.1Ré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

IdNomCatégoriesDescriptionVisiblité
tocTable des matièresNavigationGénère une table de matières.Globale
iconPickerSélecteur d'icônesDéveloppementSélectionnez une icône dans le set d'icônes XWiki.Wiki courant
wikimacrocontentWikiMacro ContentDéveloppementDisplay editable content of a wikimacro.Globale
mentionMention UtilisateurNotificationsInsert une mention utilisateur.Wiki courant
exampleExampleFormatShows an example and its source code.Wiki courant
asyncmacro asyncContenuExécution asynchrone et/ou mise en cache du contenu de la macro.Globale
spaceindexIndex des espacesObsolèteListe les documents d'un espace.Wiki courant
boxBoîteFormatAffiche une boîte autour du contenu entré.Globale
spacesEspacesObsolèteAffiche tous les espaces du wiki courant.Wiki courant
errorMessage d'erreurFormatPermet d'afficher un message d'erreur.Globale
attachmentGalleryPickerSélecteur de pièces jointesDéveloppementGrille de sélection des pièces jointes.Globale
warningMessage d'avertissementFormatPermet d'afficher un message d'avertissement.Globale
messageSenderEmetteur du messageSocialUn contrôle qui permet aux utilisateurs d'entrer des messages qui sont gérés par le module de MessageStream.Wiki courant
childrenChildrenNavigationDisplays a tree of children pages of the current pageWiki courant
workspacesEspaces de travail (obsolète)ObsolèteCette 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
displayAffichageContenuAffiche d'autres pages dans la page courante.Globale
translationTraductionContenuAffiche un message de traduction.Globale
contextContexteDéveloppementExecute le contenu dans le contexte du document passé en paramètreGlobale
pdftocPDF Table of ContentsInterneGenerates the table of contents for the PDF export.Globale
infoMessage d'informationFormatPermet d'afficher un message d'information.Globale
treeArbreNavigationAffiche une hiérarchie de l'arborescence définie par le contenu de la macro ou le paramètre source.Wiki courant
liveDataLive DataContenuAffiche des listes dynamiques de données.Globale
rssRSSContenuListe les derniers éléments d'un flux RSS.Globale
successMessage en cas de succèsFormatAffiche un message en cas de succès.Globale
documentTreeArborescenceNavigationAffiche l'arborescence des pages XWiki.Wiki courant
templateTemplateDéveloppementInsérer un template.Globale
notificationsAutoWatchPreferencesPréférences pour les notifications d'abonnement automatiqueNotificationsAffiche les préférences de l'utilisateur pour les notifications d'abonnement automatique aux pages.Wiki courant
chartGraphiqueContenuAffiche un graphique généré à partir d'une source de donnéesGlobale
containerConteneurMise en pageMacro permettant de réunir plusieurs groupes et d'ajouter des décorations comme la mise en page.Globale
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Wiki courant
tagcloudNuage de tagContenuAffiche le nuage de tags du wiki courant ou de l'espace spécifié.Wiki courant
activityActivitéNotificationsLa 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
pythonPythonDéveloppementExécute un script Python.Globale
commentCommentaireDéveloppementPermet d'ajouter des commentaires dans le contenu source. Cette macro ne produit rien.Globale
htmlHTMLDéveloppementPermet d'insérer du code HTML ou XHTML dans la page.Globale
contentContenuContenuAutorise tous les types de langages wiki dans le contenuGlobale
scriptScriptDéveloppementExécute un script dans le langage indiqué.Globale
useravatarAfficher la photo de profilContenuPermet d'afficher l'avatar d'un utilisateur donné.Globale
displayIconIconContenuDisplay an icon.Globale
officeLiseuse de Document OfficeContenuVoir 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
galleryGalerieMise en pageAffiche les images trouvées dans le contenu fourni en mode présentation / galerie.Globale
uiextensionExtension UIDéveloppementInsérez une extension UI.Globale
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Wiki courant
uiextensionsExtensions UIDéveloppementInsérer les extensions UI.Globale
dashboardTableau de bordMise en pageMacro permettant de définir un tableau de bord à remplir avec des gadgets.Globale
putFootnotesAfficher les notes de bas de pageContenuPermet 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
wikisWikisNavigationListe de tous les wikisWiki courant
attachmentSelectorSélecteur de pièce jointeDéveloppementUn 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
notificationsApplicationsPreferencesPréférences de notificationNotificationsAffiche les préférences de notification de l'utilisateur courant.Wiki courant
cacheCacheDéveloppementContenu des caches.Globale
menuMenuNavigationAffiche un menu créé en utilisant une syntaxe wiki simple (listes imbriquées et liens).Globale
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Wiki courant
documentsDocumentsContenuAffiche la liste des documents dans un tableau dynamiqueWiki courant
notificationsFiltersPreferencesNotifications Filters Preferences (deprecated)NotificationsDisplay 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
notificationsNotificationsNotificationsAffiche des notifications liées à l'activité du wiki.Wiki courant
velocityVelocityDéveloppementExécute un script Velocity.Globale
wikimacroparameterWikiMacro ParameterDéveloppementDisplay editable parameter of a wikimacro.Globale
groovyGroovyDéveloppementExécute un script Groovy.Globale
footnoteNote de bas de pageContenuGénère une note qui sera affichée en bas de page.Globale
codeCodeFormatPermet d'afficher des lignes de code dans un langage informatique donnéGlobale
idAncreNavigationPermet 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
includeInclureContenuPermet d'inclure une autre page dans la page courante.Globale

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.1Ré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.

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