Aller au contenu

Guide de syntaxe XWiki

Modifié par Administrateur local le 2026/02/12 12:34

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

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!");
Information

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. 

Information

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

Macros dans ce wiki

IdNomCatégoriesDescriptionVisibilité
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
asyncmacro asyncContenuExécution asynchrone et/ou mise en cache du contenu de la macro.Globale
attachmentGalleryPickerSélecteur de pièces jointesDéveloppementGrille de sélection des pièces jointes.Globale
attachmentsAttachmentsDisplays the list of attachments for a given document using a live table.Wiki 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
boxBoîteFormatAffiche une boîte autour du contenu entré.Globale
cacheCacheDéveloppementContenu des caches.Globale
chartGraphiqueContenuAffiche un graphique généré à partir d'une source de donnéesGlobale
childrenEnfantsNavigationAffiche un arbre des pages enfants de la page couranteWiki courant
codeCodeFormatPermet d'afficher des lignes de code dans un langage informatique donnéGlobale
commentCommentaireDéveloppementPermet d'ajouter des commentaires dans le contenu source. Cette macro ne produit rien.Globale
containerConteneurMise en pageMacro permettant de réunir plusieurs groupes et d'ajouter des décorations comme la mise en page.Globale
contentContenuContenuAutorise tous les types de langages wiki dans le contenuGlobale
contextContexteDéveloppementExecute le contenu dans le contexte du document passé en paramètreGlobale
dashboardTableau de bordMise en pageMacro permettant de définir un tableau de bord à remplir avec des gadgets.Globale
diagramDiagramContenuDisplays a diagram.Wiki courant
displayAffichageContenuAffiche d'autres pages dans la page courante.Globale
displayIconIconContenuDisplay an icon.Globale
documentsDocumentsContenuAffiche la liste des documents dans un tableau dynamiqueWiki courant
documentTreeArborescenceNavigationAffiche l'arborescence des pages XWiki.Wiki courant
embedEmbed contentContenuShow in your wiki page many external content. Currently this support theses external services: * Youtube, * Dailymotion, * Vimeo, * x.com, * Google doc, sheets and slides, * Google calendar, * Google maps, * Facebook, * Linkedin, * Figma, * Spotify, * Prezi, * Flickr, * Viddler, * Aha! roadmaps, * Also play a video attached to your wiki page using Video.js library. mp4, webm and ogv formats are supported.Wiki courant
errorMessage d'erreurFormatPermet d'afficher un message d'erreur.Globale
exampleExempleFormatAfficher un exemple et le code source correspondant.Wiki courant
footnoteNote de bas de pageContenuGénère une note qui sera affichée en bas de page.Globale
galleryGalerieMise en pageAffiche les images trouvées dans le contenu fourni en mode présentation / galerie.Globale
groovyGroovyDéveloppementExécute un script Groovy.Globale
hardis-blockquoteHardis - Block quoteFormatDisplays a quote with specific formatting.Globale
hardis-buttonHardis - Clickable buttonFormatCreate an HTML button tag.Globale
hardis-center-tableHardis - Center tableAllows you to center a table on the page.Globale
hardis-clickHardis - Clickable contentNavigationTo make the content clickableGlobale
hardis-content-zoneHardis - Content ZoneFormatInserts a graphic element with rounded edges, ideal for creating content areas, buttons, etc..Globale
hardis-contentbylabelHardis - Content by LabelContenuDisplay list of pages having specified labels.Globale
hardis-current-dateHardis - Current DateMacro for displaying current date.Globale
hardis-custom-tableHardis - Customizable tableMacro to apply styles transformation to tables which are inside the macro content.Globale
hardis-display-extractHardis - Display extractContenuInclude the excerpt from one page within another page.Globale
hardis-expandHardis - ExpandIntegrate an expandable text area into your page.Globale
hardis-extractHardis - ExtractMacro to define content as an excerpt (to include this content in another page, use the macro 'Hardis - Display an excerpt').Globale
hardis-formatdateHardis - Formatted dateFormatDisplay and format selected date.Globale
hardis-helpcallHardis - Help callMacro allowing you to link a page to an Adelia or Reflex program.Globale
hardis-infoHardis - InformationHighlights content as an informational note with a blue background.Globale
hardis-jiraHardis - JiraNavigationCommunicate the status of a project, task or milestone with visual indicators.Globale
hardis-layout-cellHardis - Layout cellDefine the content of a layout section cell.Globale
hardis-layout-sectionHardis - Layout sectionAllows you to structure a layout section using vertical columns with different configurations.Globale
hardis-listlabelsHardis - Labels listContenuRenders the list of all labels or labels for a specific space sorted alphabetical.Globale
hardis-page-navigationHardis - Page NavigationAllows to navigate to next or previous page.Globale
hardis-panelHardis - PanelDisplays a block of text in a customizable panel.Globale
hardis-reactive-buttonHardis - Responsive ButtonFormatMacro to display a clickable and responsive button on a XWiki page.Globale
hardis-restrictedHardis - Restricted contentContenuConditional display of a block of text.Globale
hardis-statusHardis - StatusContenuCommunicate the status of a project, task or milestone with visual indicators.Globale
hardis-tabHardis - TabTab element for the tab group macro. This is expected to be put as the tab group macro content.Globale
hardis-tabs-childrenHardis - Children TabsMacro for automatically displaying tabs with child page content.Globale
hardis-tabs-groupHardis - Tab groupThe main macro which contains tab macro elements.Globale
hardis-tabs-navigationHardis - Tabbed NavigationAdd navigation tabs based a page's children, or labels.Globale
hardis-tocHardis - TOC - Table of Content & SummaryNavigationCreates a Table of Contents for the current page based on headings in the page.Globale
hardis-toczoneHardis - Toc zoneCreates a Table of Contents for headings within the body of the macro.Globale
hardis-topofpageHardis - Top Of PageNavigationLink to go to the top of the current page.Globale
hardis-translationHardis - TranslationDisplays a block of text only if the selected target language is the user's default language.Globale
hardis-userprofileHardis - User profileContenuDisplays the details of a user's profile.Globale
hardis-view-fileView fileShow a file using PDF Viewer Macro or Office Viewer.Globale
hardis-wms-product-nameHardis - WMS product nameContenuAllows you to change the product name displayed in the documentation without having to modify or republish it.Globale
htmlHTMLDéveloppementPermet d'insérer du code HTML ou XHTML dans la page.Globale
iconPickerSélecteur d'icônesDéveloppementSélectionnez une icône dans le set d'icônes XWiki.Wiki courant
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
infoMessage d'informationFormatPermet d'afficher un message d'information.Globale
liveDataLive DataContenuAffiche des listes dynamiques de données.Globale
locationSearchRecherche par emplacementRecherche à l'emplacement donné.Wiki courant
mentionMention UtilisateurNotificationsInsert une mention utilisateur.Wiki courant
menuMenuNavigationAffiche un menu créé en utilisant une syntaxe wiki simple (listes imbriquées et liens).Globale
notificationsNotificationsNotificationsAffiche des notifications liées à l'activité du wiki.Wiki courant
notificationsApplicationsPreferencesPréférences de notificationNotificationsAffiche les préférences de notification de l'utilisateur courant.Wiki courant
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
notificationsCustomFiltersPreferencesNotifications Custom Filters PreferencesNotificationsDisplay the preferences of the given user about custom notification filters.Wiki courant
notificationsEmailPreferencesNotifications Email PreferencesNotificationsDisplay the preferences of the current user about notification emails.Wiki 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
notificationsSystemFiltersPreferencesNotifications System Filters PreferencesNotificationsDisplay the preferences of the given user about system notification filters.Wiki courant
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
pdftocPDF Table of ContentsInterneGenerates the table of contents for the PDF export.Globale
pdfviewerPDF ViewerContenuPDF Viewer basé sur Mozilla pdf.jsWiki courant
putFootnotesAfficher les notes de bas de pageContenuPermet d'afficher toutes les notes de bas de page. Si manquant, les notes de bas de page sont affichées par défaut à la fin de la page.Globale
pythonPythonDéveloppementExécute un script Python.Globale
scriptScriptDéveloppementExécute un script dans le langage indiqué.Globale
successMessage en cas de succèsFormatAffiche un message en cas de succès.Globale
tagcloudNuage de tagContenuAffiche le nuage de tags du wiki courant ou de l'espace spécifié.Wiki courant
templateTemplateDéveloppementInsérer un template.Globale
tocTable des matièresNavigationGénère une table de matières.Globale
translationTraductionContenuAffiche un message de traduction.Globale
treeArbreNavigationAffiche une hiérarchie de l'arborescence définie par le contenu de la macro ou le paramètre source.Wiki courant
uiextensionExtension UIDéveloppementInsérez une extension UI.Globale
uiextensionsExtensions UIDéveloppementInsérer les extensions UI.Globale
useravatarAfficher la photo de profilContenuPermet d'afficher l'avatar d'un utilisateur donné.Globale
velocityVelocityDéveloppementExécute un script Velocity.Globale
warningMessage d'avertissementFormatPermet d'afficher un message d'avertissement.Globale
wikimacrocontentWikiMacro ContentDéveloppementDisplay editable content of a wikimacro.Globale
wikimacroparameterWikiMacro ParameterDéveloppementDisplay editable parameter of a wikimacro.Globale
wikisWikisNavigationListe de tous les wikisWiki 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

HTML

2.0 HTML

Information

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
Information

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

Information

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