XWiki Syntaxes

Modifié par Administrator le 2013/06/04 01:06
Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:XWiki.XWikiSyntax]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.
Contents

À partir de XWiki Enterprise 1.7, nous avons introduit une nouvelle syntaxe wiki. Alors, nous dénommons la syntaxe précédente la Syntaxe XWiki v1.0, tandis que la nouvelle syntaxe est logiquement appelée la Syntaxe XWiki v2.0. Les raisons principales pour l'introduction de la nouvelle syntaxe ont été les suivantes:

  • Corriger les limitations et les ambiguïtés de la syntaxe XWiki 1.0.
    • Les symboles sous-optimales. Par exemple, le symbole pour le texte gras était représenté par des astérisques simples. Cela causait des problèmes lorsque les utilisateurs renseignaient du texte contenant des astérisques, parce que celui-ci était considéré comme gras lorsqu'il ne l'était pas. C'est pourquoi nous avons rationalisé la syntaxe en utilisant partout des caractères doubles. 
    • Ambiguïtés. Par exemple il y avait une ambiguïté entre un élément de gras placé au début d'une ligne et une liste à puces. La résolution du problème des ambiguïtés était nécessaire pour réécrire l'éditeur WYSIWYG afin qu'il puisse être déterministe.
  • Être plus près de la syntaxe Creole 1.0 qui devient une norme pour la syntaxe wiki. En outre, la communauté Creole a pris son temps d'analyser toutes les syntaxes wiki existantes avant de décider sur les symboles. 

Depuis l'introduction de la syntaxe XWiki 2.0, quelques lacunes de cette syntaxe ont été trouvées. Pour y remédier, la syntaxe XWiki 2.1, actuellement expérimentale, a été ajoutée dans XWiki Enterprise version 3.0. Cette nouvelle syntaxe a été notamment développée pour les raisons suivantes:

  • Homogénéiser la syntaxe des liens et des images pour plus de cohérence et de clarté, ainsi que la possibilité de l'étendre ultérieurement.
  • Ajouter la possibilité d'afficher des icônes, d'utiliser la notation UNC pour ajouter des liens, et de créer des liens vers des adresses relatives.

 La syntaxe XWiki 2.1 étant basée sur la syntaxe XWiki 2.0, toute la syntaxe XWiki 2.0 reste valable sauf si les caractéristiques de la syntaxe XWiki 2.1 précisent un changement. 

En plus de ces 2 syntaxes XWiki, nous avons aussi changé notre moteur de rendu sous-jacent (précédemment c'était Radeox) en faveur de notre propre moteur, qui est un sur-ensemble emballé autour de Wikimodel et Doxia (et éventuellement d'autres dans le futur). Cela nous a permis de fournir d'autres syntaxes dans le wiki: MediaWiki, Confluence, JSPWiki, Creole, TWiki et plus.

Remarques générales

La syntaxe XWiki v2.0 corrige quelques erreurs et le problème de la syntaxe ambiguë comme indiqué dans les exemples du tableau ci-dessous:

DescriptionExemple de syntaxe invalide ou ambiguëCorrigé dans la syntaxe XWiki 2.0
Des styles de texte non fermés**gras**gras**
Deux éléments autonomes non séparés par 2 nouvelles lignes| cellule de tableau
* élément de liste		| cellule de tableau

* élément de liste
Deux éléments autonomes non séparés par 2 nouvelles lignesparagraphe
----
paragraphe		paragraphe

----

paragraphe
Nouvelle ligne ignorée au début du document<nouvelle ligne au début du document>
paragraphe		paragraphe
La syntaxe avec des titres non fermés=== titre=== titre ===

Paragraphes

Les paragraphes sont des éléments de texte séparés par 2 ou plusieurs nouvelles lignes.

En syntaxe XWiki 2.0, on tient compte des lignes nouvelles, ce qui n'est pas le cas des syntaxes XWiki 1.0 et Creole.

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat de la syntaxe XWiki 1.0Résultat de la syntaxe XWiki 2.0
Paragraphe simpleCeci est un paragraphe simpleCeci est un paragrapheCeci est un paragrapheCeci est un paragraphe
Paragraphe sur plusieurs lignes Paragraphe sur\\
plusieurs lignes		Paragraphe sur
plusieurs lignes		Paragraphe sur
plusieurs lignes		Paragraphe sur
plusieurs lignes
Deux paragraphesLe premier paragraphe

Le deuxième paragraphe		Le premier paragraphe

Le deuxième paragraphe		Le premier paragraphe

Le deuxième paragraphe		Le premier paragraphe

Le deuxième paragraphe
Paragraphe paramétré<p style="text-align:center;
color:blue">
Paragraphe centré et bleu</p>		(% style="text-align:center; color:blue" %)
Paragraphe centré et bleu
Paragraphe centré et bleu
Paragraphe centré et bleu

Titres

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Titres standard

1 niveau 1
1.1 niveau 2
1.1.1 niveau 3
1.1.1.1 niveau 4
1.1.1.1.1 niveau 5
1.1.1.1.1.1 niveau 6

= niveau 1 = 
== niveau 2 ==
=== niveau 3 ===
==== niveau 4 ====
===== niveau 5 =====
====== niveau 6 ======

niveau 1

 

niveau 2

niveau 3

niveau 4

niveau 5
niveau 6
Titres paramétrés<h1><span style="color:blue">
titre</span></h1>		(% style="color:blue" %)
= titre =

titre

Titres en syntaxe wiki1.1.1 Titre en *gras*=== Titre en **gras** ===

Titre en gras

Formatage du texte

Nouveau en syntaxe XWiki 2.0 sur la syntaxe XWiki 1.0:

  • Les espaces sont autorisés, juste après les symboles de syntaxe.
  • L'utilisation des symboles doubles au cas où il y avait seulement un symbole en syntaxe XWiki 1.0, de sorte qu'il soit moins probable que l'utilisateur s'en serve dans le texte de manière erronée.
  • La possibilité d'avoir plusieurs lignes.
FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Gras*gras***gras**gras
Souligné__souligné_____souligné__souligné
Italique~~italique~~//italique//italique
Barré--barré----barré--barré
Espacement fixe<tt>espacement fixe</tt>##espacement fixe##espacement fixe
Puissanceutilisation de la <sup>puissance</sup>utilisation de la ^^puissance^^utilisation de la puissance
Indiceutilisation de l'<sub>indice</sub>utilisation de l',,indice,,utilisation de l'indice

La ligne horizontale

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Ligne horizontale simple--------
Ligne horizontale paramétrée<hr style="color:blue"/>
(% style="color:blue" %)
----

Listes

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Liste à puces
* élément 1
** élément 2
*** élément 3
* élément 4
* élément 1
** élément 2
*** élément 3
* élément 4
  • élément 1
    • élément 2
      • élément 3
  • élément 4
Liste numérotée
1. élément 1
11. élément 2
111. élément 3
1. élément 4
1. élément 1
11. élément 2
111. élément 3
1. élément 4
  1. élément 1
    1. élément 2
      1. élément 3
  2. élément 4
Liste mixte
1. élément 1
1*. élément 2
1*. élément 3
1. élément 4
1. élément 1
1*. élément 2
1*. élément 3
1. élément 4
  1. élément 1
    • élément 2
    • élément 3
  2. élément 4
Liste aux carrés
- élément 1
- élément 2
(% style="list-style-type:

square" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste aux disques

<ul style="list-style-type:

disc">
  <li>élément 1</li>
  <li>élément 2</li>
</ul>

(% style="list-style-type:

disc" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste alphabétique en minuscules
a. élément 1
a. élément 2
(% style="list-style-type:

lower-alpha" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste alphabétique en majuscules
A. élément 1
A. élément 2
(% style="list-style-type:

upper-alpha" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Romaine en minuscules
i. élément 1
i. élément 2
(% style="list-style-type:

lower-roman" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Romaine en majuscules
I. élément 1
I. élément 2
(% style="list-style-type:

upper-roman" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Grecque en minuscules
g. élément 1
g. élément 2
(% style="list-style-type:

lower-greek" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Grecque en majuscules
G. élément 1
G. élément 2
(% style="list-style-type:

upper-greek" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Hiragana
h. élément 1
h. élément 2
(% style="list-style-type:

hiragana" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Hiragana Iroha
H. élément 1
H. élément 2
(% style="list-style-type:

hiragana-iroha" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Katakana
k. élément 1
k. élément 2
(% style="list-style-type:

katakana" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Katakana Iroha
K. élément 1
K. élément 2
(% style="list-style-type:

katakana-iroha" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Arménienne
<ul style="list-style-type:

armenian">
 <li>élément 1</li>
 <li>élément 2</li>
</ul>

(% style="list-style-type:

armenian" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Hébraïque
j. élément 1
j. élément 2
(% style="list-style-type:

hebrew" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste Géorgienne
<ul style="list-style-type:

georgian">
 <li>élément 1</li>
 <li>élément 2</li>
</ul>

(% style="list-style-type:

georgian" %)
* élément 1
* élément 2

  • élément 1
  • élément 2
Liste CJK idéographique
<ul style="list-style-type:

cjk-ideographic">
 <li>élément 1</li>
 <li>élément 2</li>
</ul>

(% style="list-style-type:

cjk-ideographic" %)
* élément 1
* élément 2

  • élément 1
  • élément 2

Listes de définitions

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Définition standard
<dl>
  <dt>terme</dt>
  <dd>définition</dd>
</dl>
; terme
: définition
terme
définition
Définitions imbriquées
<dl>
  <dt>terme1</dt>
  <dd>définition1
    <dl>
      <dt>terme2</dt>
      <dd>définition2</dd>
    </dl>
  </dd>
</dl>
; terme1
: définition1
:; terme2
:: définition2
terme1
définition1
terme2
définition2
Définition paramétrée
<dl style="color:blue">
  <dt>terme</dt>
  <dd>définition</dd>
</dl>
(% style="color:blue" %)
; terme
: définition
terme
définition

Nouvelle ligne/Sauts de ligne

Une nouvelle ligne est un retour chariot. Un saut de ligne est une nouvelle ligne forcée qui peut apparaître n'importe où dans le texte.

En syntaxe XWiki 2.0, les nouvelles lignes sont ignorées, ce qui n'est pas le cas de la syntaxe XWiki 1.0 et Creole.

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat de la syntaxe XWiki 1.0Résultat de la syntaxe XWiki 2.0
Saut de ligneLigne\\Nouvelle ligneLigne\\Nouvelle ligneLigne
Nouvelle ligne		Ligne
Nouvelle ligne
Nouvelle ligneLigne
Nouvelle ligne		Ligne
Nouvelle ligne		Ligne Nouvelle ligneLigne
Nouvelle ligne

Liens

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat de la syntaxe XWiki 1.0/2.0
Lien vers une page de l'espace courant[WebHome][[WebHome]]XWiki
Lien avec étiquette[étiquette>WebHome][[étiquette>>WebHome]]étiquette
Lien vers une page avec l'espace spécifié[Main.WebHome][[Main.WebHome]]Main
Lien vers un sous-wiki[sous-wiki:Main.WebHome][[sous-wiki:Main. WebHome]]Main
Lien qui s'ouvre dans une nouvelle page[étiquette>WebHome> _blank][[étiquette>>WebHome ||rel="__blank"]]étiquette
Lien vers un URL placé directement dans le texteCeci est un URL: http://xwiki.orgCeci est un URL: http://xwiki.orgCeci est un URL: http://xwiki.org
Lien vers un URL[http://xwiki.org][[http://xwiki.org]]http://xwiki.org
Lien vers un URL avec étiquette[XWiki>http://xwiki.org][[XWiki>>http://xwiki.org]]XWiki
Lien vers une adresse émail[john@smith.net> mailto:john@smith.net][[john@smith.net>> mailto:john@smith.net]]john@smith.net
Lien image<a href="$xwiki.getURL ("Espace1.Page1")"> {image:img.png| document=Espace2.Page2} </a>
[[image:Espace2.Page2@

img.png>>Espace1.Page1]]
La syntaxe Wiki est supportée dans les étiquettes des liens.

img.png
Lien vers une pièce jointe à la page courante

Allez à Attacher une Macro pour savoir plus.
{attach:text|file=img.png}

[[texte>>attach:img.png]]texte
Lien vers une pièce jointe à une autre page

allez à Attacher une Macro pour savoir plus.
{attach:text|

document=Space.Page

|file=img.png}

[[text>>attach:Space.Page @img.png]]text

Spécifications des liens pour la syntaxe XWiki 1.0

La syntaxe complète d'un lien est (alias[|&gt;])+(link)(@interWikiAlias)+([|&gt;]target)+

  • alias: Un String optionnel qui sera affiché à l'utilisateur comme le nom du lien au moment du rendu. Exemple: "Ma page".
  • link: La référence complète du lien en utilisant la syntaxe suivante: (virtualWikiAlias:)+(space.)+(reference)(?queryString)+(#anchor)+
  • Notez qu'il faut préciser soit le link , soit  l'alias.
    • virtualWikiAlias: Un String optionnel contenant le nom d'un wiki virtuel. Le lien est vers une page de ce wiki virtuel. Exemple: "mywiki".
    • space: Le nom d'un espace Wiki optionnel. Si aucun espace n'est spécifié, alors l'espace courant sera utilisé. Exemple: "Main".
    • reference: La référence du lien. Elle peut contenir soit un URI protocol:path (example: "http://xwiki.org", "mailto:john@smith.com") ou le nom d'une page wiki (exemple: "WebHome").
    • queryString: Un String optionnel de requêtes pour spécifier les paramètres qui seront utilisés dans l'URL rendu.  Exemple: "mydata1=5&amp;mydata2=Bonjour".
    • anchor: Le nom d'un ancre optionnel vers un ancre défini dans le lien référencé. Notez qu'en XWiki les ancres sont créés automatiquement pour les titres. Exemple: "AncreDeLaTableDesMatières".
  • interWikiAlias: Un alias optionnel Inter Wiki défini comme dans "InterWiki Map" (pour plus d'informations, allez au guide de l'administrateur). Exemple: "wikipedia".
  • target: Un String optionnel qui correspond à l'attribut HTML target d'un élément HTML de liaison A. Cet élément est utilisé lors du rendu du lien. Par défaut, le lien est ouvert dans la page courante. Exemples: "_self", "_blank"

Spécifications des liens pour la syntaxe XWiki 2.0

La syntaxe complète\ d'un lien est (label>>)?(link)(||parameters)*

  • label: L'étiquette du lien qui peut contenir de la syntaxe wiki 
  • link: La cible du lien, c'est-à-dire, où aller après cliquer sur un lien.  La syntaxe ressemble à la syntaxe XWiki 1.0 et peut contenir 2 types de URI: mailto: etattach:pour des liens vers une adresse émail et vers une pièce jointe.
  • parameters: Une liste optionnelle de paramètres transmis au lien.

Tableaux

En syntaxe XWiki 2.0, il est également possible d'avoir des paramètres pour le tableau, la ligne ou la cellule.

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Tableau standard((( {table} Titre 1 | Titre 2 Mot 1 | Mot 2 {table} )))
|=Titre 1|=Titre 2
|Mot 1|Mot 2
ou
!=Titre 1!=Titre 2
!!Mot 1!!Mot 2
Titre 1Titre 2
Mot 1Mot 2
Tableau paramétré

<table style="background-color:

red;align:center">
  <tbody>
    <tr>
      <td>Titre 1</td>
      <td style="background-color:

yellow">Titre 2</td>
    </tr>
    <tr>
      <td>Mot 1</td>
      <td>Mot 2</td>
    </tr>
  </tbody>
</table>

(% style="background-color:

red;align=center" %)
|=Titre 1|=(% style="background-color:

yellow" %)Titre 2
|Mot 1|Mot 2

Titre 1Titre 2
Mot 1Mot 2
Tableau filtrable et pouvant
être trié
$xwiki.ssfx.use

("js/xwiki/table/table.css")
$xwiki.jsfx.use

("js/xwiki/table/tablefilterNsort.js", true)
<table id="tableid"

class="grid sortable filterable doOddEven">
 <tr class="sortHeader">
 <th>Titre1</th>
 <th>Titre2</th>
 </tr>
 <tr>
 <td>Cellule11</td>
 <td>Cellule12</td>
 </tr>
 <tr>
 <td>Cellule21</td>
 <td>Cellule22</td>
 </tr>
</table>

{{velocity}}
$xwiki.ssfx.use
("js/xwiki/table/table.css")
$xwiki.jsfx.use
("js/xwiki/table/tablefilterNsort.js", true)
{{/velocity}}

{{html}}
<table id="tableid"

class="grid sortable filterable doOddEven"> <tr class="sortHeader"> <th>Titre1</th> <th>Titre2</th> </tr> <tr> <td>Cellule11</td> <td>Cellule12</td> </tr> <tr> <td>Cellule21</td> <td>Cellule22</td> </tr> </table> {{/html}}

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:XWiki.XWikiSyntax]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.
Titre1 Titre2
Cellule11 Cellule12
Cellule21 Cellule22

Images

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Image d'une pièce jointe à la page courante

Allez à Image Macro pour savoir plus.
{image:img.png}

image:img.pngimg.png
Image d'une pièce jointe à un autre document{image:img.png| document=Space.Page}image:Space.Page @img.pngimg.png
Image avec des paramètres{image:img.png |width=25|height=25}[[image:img.png|| width="25" height="25"]]img.png
Images localisées dans un URLhttp://some/url/img.pngimage:http://some/url/img.pngimg.png

Verbatim

Vous permet d'avoir un contenu qui ne sera pas formaté . En d'autres termes, la syntaxe wiki ne sera pas prise en compte.

En syntaxe XWiki 1.0 la macro Pre préserve seulement la syntaxe wiki et les macros Radeox. Cependant, les fragments HTML et les scripts Groovy/Velocity sont toujours exécutés. 

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat de la syntaxe XWiki 1.0Résultat de la syntaxe XWiki 2.0
Verbatim en-ligneDu contenu verbatim {pre}*[non rendu]*{/pre}Du contenu verbatim {{{**[[non rendu]]**}}}Du contenu verbatim *[non rendu]*Du contenu verbatim **[[non rendu]]**
Le bloc Verbatim

{pre} Du contenu *verbatim* sur plusieurs lignes {/pre}
Il est aussi possible d'utiliser la macro Code mais celle-ci affiche son contenu dans une boîte par défaut..

{{{
Du contenu
**verbatim**
sur plusieurs lignes
}}}
Du contenu
*verbatim*
sur plusieurs lignes
Du contenu 
**verbatim**
sur plusieurs lignes

Citations

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Citation simple

<blockquote><p>

John a dit cela.

</p></blockquote>
J'ai dit ok.

> John a dit cela.
J'ai dit ok.

 John a dit cela.

J'ai dit ok.

Citations imbriquées

<blockquote><p>

John a dit cela.</p>
  <blockquote><p>

Marie a répondu cela.

</p></blockquote>
</blockquote>
J'ai dit ok.

> John a dit cela.
>> Marie a répondu cela.
J'ai dit ok.

 John a dit cela.

 Marie a répondu cela.

J'ai dit ok.

Groupes

Les groupes peuvent être utilisés pour insérer un autre document  directement dans le document courant. Cela permet par exemple d'insérer des éléments complexes à l'intérieur d'un élément d'une liste ou dans une cellule de tableau. Les groupes sont délimités par les éléments syntaxiques suivants:(((...))). Un groupe peut contenir un autre groupe et il n'y a pas de limite d'imbrication.

Syntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat
Cette fonctionnalité n'existe pas en syntaxe XWiki 1.0. Il faudrait utiliser du HTML pur pour atteindre le résultat.
|=Titre 1|=Titre 2|=Titre 3
|Cellule 1|(((
= Document ancré

Un paragraphe ancré.

* élément de liste 1
* élément de liste 2
  ** sous-élément 1
  ** sous-élément 2
))) | Cellule 3

Le paragraphe suivant dans le document de haut niveau
Titre 1Titre 2Titre 3
Cellule 1

Document ancré

Un paragraphe ancré.

  • élément de liste 1
  • élément de liste 2
    • sous-élément 1
    • sous-élément 2
 Cellule 3

Le paragraphe suivant dans le document de haut niveau

Protéger les caractères

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0Résultat de la syntaxe XWiki 1.0Résultat de la syntaxe XWiki 2.0
Pour un caractèreCeci n'est pas un \[lien\]

Ceci n'est pas un ~[~[lien~]~]
Pour renseigner le caractère ~ utilisez l'Escape double: ~~

Ceci n'est pas un [lien]Ceci n'est pas un [[lien]]

Macros

En syntaxe XWiki 1.0, il y a deux types de macros:

  • Les macros Velocity appelées en utilisant la syntaxe #macroname(param1 ... paramN)
  • Les macros Radeox appelées en utilisant la syntaxe {macroname:param1=value1|...|paramN=valueN}

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

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 à la page de référence des macros.

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0
Macro Velocity
#info("Un fragment de texte")

{{velocity}}{{html}} #info("Un fragment de texte") {{/html}}{{/velocity}}
Dans cet exemple, nous utilisons la macro HTML étant donné que la macro #Message d'Information renvoie du contenu HTML.

Macros Radeox/XWiki

{code:java} Du contenu Java {code}

{{code language="java"}} Du contenu Java {{/code}}

HTML

En syntaxe XWiki 2.0, le code HTML ou XHTML doit être écrit en utilisant la macro {{html}} alors qu'en syntaxe XWiki 1.0 il est possible d'utiliser du code HTML directement dans le texte.

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

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

Scripts Velocity/Groovy

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.0, les scripts Velocity doivent être inclus en utilisant la macro velocity. En va de même pour l'inclusion des scripts Groovy.

FonctionnalitéSyntaxe XWiki 1.0Syntaxe XWiki 2.0
Script Velocity
#set ($var = "quelquechose")

{{velocity}} #set ($var = "quelquechose") {{/velocity}}

Script Groovy
<%
def var = "quelquechose"
%>

{{groovy}} def var = "quelquechose" {{/groovy}}

Paramètres

En syntaxe XWiki 2.0, il est possible de passer des paramètres aux divers éléments de syntaxe et aussi aux blocs de texte. Vous pouvez utiliser ces paramètres par exemple pour créer des styl. Il est possible de choisir n'importe quelle paire clé/valeur. Le moteur de rendu XHTML va passer ces paramètres en tant que XHTML attributs à la représentation XHTML sous-jacente des éléments de syntaxe. En syntaxe XWiki 1.0, il n'y avait pas de possibilité de passer des paramètres et la seule façon de le faire était d'écrire du XHTML directement dans le contenu comme vous le voyez dans le tableau ci-dessous.

Syntaxe XWiki 1.0Syntaxe XWiki 2.0XHTML généré
<h1 class="myClass"

style="myStyle" id="myId">

heading</h1>

(% class="myClass"

style="myStyle" id="myId" %)
= titre =

<h1 class="myClass"

style="myStyle" id="myId">titre</h1>

La syntaxe 2.1

La syntaxe XWiki 2.1 est maintenant définitive ce qui signifie qu'on n'y apportera aucune autre modification. En outre, lorsque vous créerez une page, la syntaxe par défaut sera 2.1. Vous pouvez encore en choisir une autre, comme expliqué ici.

Les liens en syntaxe XWiki 2.1

Le format complet d'un lien est [label>>] (ressource) [||paramètres]

  • label: Un string optionnel qui sera affiché comme le nom du lien. L’étiquette peut contenir également de la syntaxe Wiki et si aucune n'est spécifiée, une étiquette par défaut sera générée.
  • ressource: Un string obligatoire contenant la référence au lien qui peut être:
    • URL: Un URL ayant la forme [url:] (protocole://chemin d'accès). Exemples: http://xwiki.org, url:https://svn.xwiki.org/
      • url: Un string optionnel qui identifie la ressource comme étant un URL
    • Référence à une page Wiki ayant la forme [doc:] [[nomDuWiki:] espace.] (page). Exemples: WebHome, Main.WebHome, mywiki:Main.WebHome
      • doc: Un string optionnel qui identifie la ressource comme étant un document XWiki. 
      • nomDuWiki: Un string optionnel contenant le nom d'un wiki virtuel. Le lien sera vers une page de ce wiki virtuel. Exemple: mywiki
      • espace: Un string optionnel contenant le nom d'un espace wiki. Au cas où vous n'en spécifierez aucun, l'espace courant sera utilisé. Exemple: Main.
      • page: Un string obligatoire contenant le nom de la page wiki vers laquelle vous souhaitez créer le lien. Exemple: WebHome
    • Référence à une page InterWiki ayant la forme interwiki: (interWikiAlias:)(page). Exemple: interwiki:wikipedia:XWiki
      • interwiki: Un string obligatoire qui identifie la ressource comme étant un lien InterWiki.
      • interWikiAlias: Un alias Inter Wiki optionnel définit dans le Guide de l'Administrateur. Exemple: wikipedia
      • page: Un string obligatoire contenant le nom de la page vers laquelle vous souhaitez créer le lien. Exemple: XWiki
    • Référence à une Pièce jointe ayant la forme attach: [nomPageWiki@] (nomPièceJointe). Exemples: attach:img.png, attach:mywiki:Main.WebHome@img.png
      • attach:: Un string obligatoire qui identifie la ressource comme étant une pièce jointe.
      • nomPageWiki: Un string optionnel qui référence le document contenant le pièce jointe.
      • nomPièceJointe: Le nom de la pièce jointe, tel qu'il est stocké dans le wiki.
    • Adresse de mail ayant la forme mailto: (adresseEmail) (#anchor n'est pas valide). Exemple: mailto:john@smith.com
      • mailto:: Un string obligatoire qui identifie la ressource comme étant un e-mail.
      • adresseEmail: L'adresse e-mail cible. Exemple: john@smith.com
    • Référence à un chemin relatif sur le serveur ayant la forme path: (cheminRelatif). Exemple: path:$doc.getURL('reset') va donner l'adresse cible http://server.domain.com/xwiki/bin/reset/Space/Page où /xwiki/bin/reset/Space/Page est généré par $doc.getURL('reset').
      • path: Un string obligatoire qui identifie la ressource comme étant un chemin relatif.
      • cheminRelatif: Un string obligatoire contenant le chemin relatif de la ressource vers laquelle vous souhaitez créer le lien.
    • Référence UNC (Windows Explorer) ayant la forme unc: (chemin). Le lien est rendu tout comme un lien file://. Exemples: unc:C:\Windows\, unc:\\myserver\chemin\img.png, unc:home/user/somefile
      • unc: Un string obligatoire qui identifie la ressource comme étant un chemin UNC (Windows Explorer).
      • chemin: Un string contenant le chemin local d'une ressource accessible à l'utilisateur. Exemples: C:\Windows\, \\myserver\path\img.png, home/user/monfichier
  • paramètres: Une liste optionnelle de paramètres séparés par des espaces qui seront transmis au lien. Exemple: queryString="mydata1=5&amp;mydata2=Hello" anchor="HTableOfContents" rel="__blank"
    • queryString: Un string d'interrogation optionnel pour spécifier les paramètres qui seront ajoutés à l'adresse cible du lien et utilisés par le URL rendu. Exemple: url:http://domain.com/path||queryString="mydata1=5&amp;mydata2=Hello" génère l'adresse cible http://domain.com/path?mydata1=5&amp;mydata2=Hello
    • anchor: Le nom optionnel d'une ancre qui dirige vers l'ancre définit dans le lien référencé. Notez que dans XWiki les ancres sont générées automatiquement pour les titres. Exemple: url:http://domain.com/path||anchor="HTableOfContents" génère l'adresse cible http://domain.com/path#HTableOfContents
    • rel: Un paramètre optionnel qui vous permet d'ouvrir le lien cible dans une nouvelle fenêtre. Exemple: rel="__blank"

Les images en syntaxe 2.1

Le format complet d'une image est soit image: (référence) ou [[image: (référence) {||paramètres}]].

  • image: Un string obligatoire qui identifie la ressource comme étant une image.
  • référence: La référence à l'image qui devrait être affichée dans l'une des formes suivantes:
    • URL: Tout lien vers une image ayant la forme protocole://chemin/nomImage. Exemple: http://domain.org/path/img.png
    • Une référence à une Pièce jointe ayant la forme {{{nomwiki:} espace.} page@} (nomImage)
      • nomWiki: Un string optionnel contenant le nom du wiki virtuel. La rérérence va diriger vers l'image attachée à la page de ce wiki virtuel. Exemple: mywiki.
      • espace: Le nom de l'espace (optionnel). Au cas où aucun espace ne serait spécifié, l'espace courant va être utilisé. Exemple: Main
      • page: Un string optionnel contenant le nom de la page wiki qui contient l'image référencée. Exemple: WebHome
      • nomImage: Un string obligatoire contenant le nom d'une image attachée à une page tel qu'il est stocké dans le wiki. 
    • Référence à uneIcône ayant la forme(icon:)(nomIcone). Exemple: icon:accept
      • icon: Un string obligatoire qui identifie la référence à l'image comme étant une icône de XWiki.
      • nomIcone: Un string obligatoire qui identifie l'icône référencée. Exemple: accept
  • parameters: Une liste optionnelle de paramètres séparés par des espaces qui sont transmis à l'image. Exemple: width="800" height="600" alt="img.png" title="My nice image"
    • Des attributs HTML: Tous les attributs définis par le standard HTML seront ajoutés au tag <img> rendu.
      • style: le code CSS qui devrait être appliqué. Exemples: style="float:right;height:50", style="style="display:block;margin-left:auto;margin-right:auto;width:80%", style="vertical-align:bottom" 
      • height: Un paramètre qui définit la hauteur de l'image affichée. La valeur devrait être soit en pixels (exemple: height="80") ou en pixels relativement au bloc qui contient l'image (exemple: height="40%").
      • width: Un paramètre qui définit la largeur de l'image affichée. La valeur devrait être soit en pixels (exemple: width="80") soit en pixels relativement à la largeur du bloc contenant l'image (exemple: width="40%").
      • title: Un paramètre qui définit le titre de l'image affichée qui serait visible lorsque vous survolez l'image. Exemple: title="My nice image".
      • alt: Un paramètre qui définit le texte à afficher au cas où le navigateur ne pourrait pas afficher l'image. Etant donné que ceci est un attribut HTML obligatoire, XWiki utilisera le nom du fichier au cas où le paramètre alt ne serait pas définit. Exemple: alt="img.png".
      • Pour en savoir plus: Des explications plus détaillées sur le tag <img> et sur d'autres attributs sont disponibles sur on w3.org.
    • queryString: Permet la transmission des interrogations au serveur lors de la création du lien de téléchargement pour l'image référencée. Exemple: queryString="width=100&amp;height=800&amp;keepAspectRatio=true" (keepAspectRatio=true ne va pas fonctionner si les paramètres width et height sont spécifiés à part de queryString!)

D'autres syntaxes

Les syntaxes suivantes sont mises en œuvre dans XWiki Enterprise 1.6 et dans les version ultérieures:

Tags :
   
This wiki is licensed under a Creative Commons 2.0 license
XWiki 13.10 - Documentation - Conditions