Exemples de syntaxe XWiki avancée

05 déc. 2019 5 min read
Écrit par Oana Elena Florea, Responsable du support client

Article mis à jour le 16 janvier 2020

La syntaxe XWiki est le langage de balisage par défaut utilisé par la plate-forme XWiki pour formater une page.

Cette syntaxe est habituellement cachée à l'utilisateur novice en raison de son caractère technique. Quelques fonctionnalités de formatage reposent encore sur son utilisation directe (commentaires, macros, éditeur wiki ou onglet « Source » de l'éditeur WYSIWYG, etc). Les exemples ci-dessous peuvent aider l'utilisateur à se familiariser avec cette syntaxe et à améliorer ses connaissances dans ce domaine. La plate-forme XWiki inclut dans ses versions les plus récentes plusieurs améliorations destinées à aider l'utilisateur à tirer partie des possibilités offertes par la syntaxe XWiki avancée : possibilité d'éditer le contenu des macros directement dans l'éditeur visuel ou de copier / coller la référence de page présente dans l'onglet « Information »).

Les exemples ci-dessous peuvent aider l'utilisateur à se familiariser avec cette syntaxe et à améliorer ses connaissances dans ce domaine.

Écrire un commentaire avec une mise en forme

La possibilité de commenter des articles est une fonctionnalité essentielle de tout outil de collaboration. Lorsque vous ajoutez des commentaires dans XWiki, vous pouvez utiliser la syntaxe XWiki pour enrichir votre contenu en appliquant une mise en forme aux listes, lignes, tableaux, macros, citations, etc. ou en insérant des émoticones. Par exemple un texte comme « Très bel article emoticon_smile ! Pourriez-vous m'envoyer un lien vers la **documentation syntaxique XWiki** » sera transformé automatiquement de sorte que l'émoticône emoticon_smile apparaîtra, et « documentation syntaxique XWiki » deviendra gras.

CommentaireRendu.jpg

Astuce bonus : A l'aide du bouton « Prévisualiser », vous pouvez facilement vérifier que le contenu correspond à votre intention avant de publier le commentaire. La documentation complète de la syntaxe XWiki est disponible sur xwiki.org.

Utiliser la syntaxe XWiki dans les macros

La plate-forme XWiki inclut des macros pour le contenu wiki, le formatage, la navigation, les notifications, la mise en page, etc. Lorsque vous incluez des macros comme la macro « box » dans des gadgets, vous pouvez aussi utiliser la syntaxe XWiki pour enrichir son contenu. L'exemple ci-dessous présente un tableau représentant nos conditions de prestations de service de support.

Support_SLA_exemple.jpg

Astuce Bonus : Vous pouvez consulter la documentation syntaxique complète de XWiki pour les tableaux ici.

Créer des liens avancés en utilisant la syntaxe XWiki

Les liens sont utiles pour connecter des informations connexes à l'intérieur de votre wiki ou pour créer du contenu riche. Il est facile de créer un lien simple avec la syntaxe XWiki en utilisant la définition suivante : [[nom du lien>>URL du lien]]. Les choses peuvent se compliquer si votre besoin est plus spécifique : ajouter des paramètres à l'URL, lier une ancre ou un titre dans une page, une requête spécifique ou une référence de page. Par exemple, un lien vers la section des préférences du profil pourrait ressembler à ceci : [[Mes préférences de profil>>XWiki.OanaFlorea||queryString="category=preferences"]]

Astuce bonus : Vous pouvez consulter la documentation syntaxique complète de XWiki pour les liens disponibles sur xwiki.org.

Éditer une page en mode « wiki »

Le mode « wiki » est un éditeur simple qui vous permet d'éditer directement la syntaxe XWiki de votre page. Par défaut, l'édition d'une page se fait avec l'éditeur WYSIWYG. Cependant si vous voulez un contrôle strict sur le formatage de votre page ou si vous voulez « jouer » avec la syntaxe XWiki, vous pouvez utiliser l'éditeur « wiki » (cliquez simplement sur Modifier > Wiki dans le menu d'édition). Cet éditeur n'est disponible que pour les utilisateurs « avancés », vous devez donc mettre à jour la préférence « Type d'utilisateur » sur votre profil wiki.

Bac-à-sable.png

Astuce bonus : Une fois familiarisé avec le mode « wiki », si vous souhaitez utiliser ce mode par défaut, vous pouvez mettre à jour la préférence « Éditeur par défaut » et sélectionner « Texte ».

Utilisez l'onglet Information pour obtenir la référence d'une page

La référence de page XWiki est un identifiant permettant de représenter une page de façon univoque. La représentation textuelle d'une référence de page peut parfois être trop technique pour un utilisateur novice. Par exemple, un simple lien URL tel que http://<server>/xwiki/bin/view/Sandbox/TestPage1 peut être représenté par la référence « Sandbox.TestPage1 » (référence dite relative) ou par « xwiki:Sandbox.TestPage1 » (référence dite absolue).Pour faciliter l'utilisation des références de page lors de la création de liens vers une page dans l'éditeur de syntaxe wiki, lors de l'utilisation d'une page comme paramètre d'une macro wiki, etc., la plate-forme XWiki (à partir de la version 11.1) inclut une nouvelle fonctionnalité dans l'onglet « Information » : la possibilité de copier et coller la référence de la page courante.

https://xwiki.com/en/download/Blog/Advanced-XWiki-syntax-examples/WebHome/page_reference.gif

FAQ Générale

Quelle est la syntaxe wiki ?

Quelle est la syntaxe wiki ? La syntaxe wiki est le langage de balisage par défaut utilisé par les moteurs wiki pour formater une page.

Quelle est la syntaxe utilisée par XWiki ?

Le langage de balisage par défaut utilisé par la plate-forme XWiki pour formater une page est la syntaxe XWiki. La dernière version est la Syntaxe XWiki 2.1.

XWiki peut-il supporter d'autres syntaxes ?

Le moteur de rendu XWiki supporte plusieurs syntaxes, la liste complète est disponible sur la page de documentation.

Quelle est la syntaxe générale d'une référence de document ?

La représentation générale de la chaîne de caractères pour un document est wiki:space.document. D'autres exemples utilisant des références relatives sont inclus sur la page de documentation.

Voulez-vous en savoir plus sur les utilisations de la syntaxe XWiki ? Contactez-nous !

Articles similaires :