Syntaxe XWiki 2.1

Général

Introduction

2.1 Introduction

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.

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

2.0 General Remarks

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

D'autres syntaxes

1.0 Other Syntaxes

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

• JSPWiki
• MediaWiki
• Confluence
• TWiki
• Creole 1.0
• XHTML 1.0

Mise en forme

Paragraphes

2.0 Paragraphs

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

Titres

2.0 Headings

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

Formatage du texte

2.0 Text Formatting

La ligne horizontale

2.0 Horizontal Line

(% style="color:blue" %)
----

Listes

2.0 Lists

* élément 1
** élément 2
*** élément 3
* é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
1. élément 4

(% style="list-style-type: square" %)
* élément 1
* élément 2

(% style="list-style-type: disc" %)
* élément 1
* élément 2

(% style="list-style-type: lower-alpha" %)
* élément 1
* élément 2

(% style="list-style-type: upper-alpha" %)
* élément 1
* élément 2

(% style="list-style-type: lower-roman" %)
* élément 1
* élément 2

(% style="list-style-type: upper-roman" %)
* élément 1
* élément 2

(% style="list-style-type: lower-greek" %)
* élément 1
* élément 2

(% style="list-style-type: upper-greek" %)
* élément 1
* élément 2

(% style="list-style-type: hiragana" %)
* élément 1
* élément 2

(% style="list-style-type: hiragana-iroha" %)
* élément 1
* élément 2

(% style="list-style-type: katakana" %)
* élément 1
* élément 2

(% style="list-style-type: katakana-iroha" %)
* élément 1
* élément 2

(% style="list-style-type: armenian" %)
* élément 1
* élément 2

(% style="list-style-type: hebrew" %)
* élément 1
* élément 2

(% style="list-style-type: georgian" %)
* élément 1
* élément 2

(% style="list-style-type: cjk-ideographic" %)
* élément 1
* élément 2

Listes de définitions

2.0 Definition Lists

; terme
: définition

; terme1
: définition1
:; terme2
:: définition2

(% style="color:blue" %)
; terme
: définition

Nouvelle ligne/Sauts de ligne

2.0 New Line Line Breaks

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.

Liens

2.1 Links

Fonctionnalité	Syntaxe XWiki 2.1	Résultat
Lien vers une page de l'espace courant	[[WebHome]]	XWiki
Lien avec étiquette	[[étiquette>>WebHome]]	étiquette
Lien vers une page avec l'espace spécifié	[[Main.WebHome]]	Main
Lien vers un sous-wiki	[[sous-wiki:Main.WebHome]]	Main
Lien qui s'ouvre dans une nouvelle page	[[étiquette>>WebHome||rel="__blank"]]	étiquette
Lien vers un URL placé directement dans le texte	Ceci est un URL: http://xwiki.org	Ceci est un URL: http://xwiki.org
Lien vers un URL	[[http://xwiki.org]]	http://xwiki.org
Lien vers un URL avec étiquette	[[XWiki>>http://xwiki.org]]	XWiki
Lien vers une adresse email	[[john@smith.net>>mailto:john@smith.net]]	john@smith.net
Lien image	[[image:Espace2.Page2@img.png>>Espace1.Page1]] La syntaxe Wiki est supportée dans les étiquettes des liens.
Lien image avec paramètres image	[[[[image:Space2.Page2@img.png||width="26" height="26"]]>>Space1.Page1]]
Lien vers une pièce jointe à la page courante	[[texte>>attach:img.png]]	texte
Lien vers une pièce jointe à une autre page	[[texte>>attach:Space.Page@img.png]]	texte
Lien vers une ancre dans une page	[[label>>Space.Page||ancre=ancre]]	label
Lien vers un titre dans une page	[[label>>XWiki.XWikiSyntax||anchor=HMontitre]]	label

Spécifications des liens pour la syntaxe XWiki 2.1

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 email et vers une pièce jointe.
• parameters: Une liste optionnelle de paramètres transmis au lien.
  • queryString: An optional query string for specifying parameters that will be appended to the link target address and used in the rendered URL. Example: url:http://domain.com/path||queryString="mydata1=5&mydata2=Hello" produces target address http://domain.com/path?mydata1=5&mydata2=Hello
  • anchor: An optional anchor name pointing to an anchor defined in the referenced link. Note that in XWiki anchors are automatically created for headings. Example: url:http://domain.com/path||anchor="HTableOfContents" produces target address http://domain.com/path#HTableOfContents
  • rel: An optional parameter that allows to open link target in new window. Example: rel="__blank"

Tableaux

2.0 Tables

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

|=Titre 1|=Titre 2
|Mot 1|Mot 2

!=Titre 1!=Titre 2
!!Mot 1!!Mot 2

{{velocity}}
$xwiki.ssfx.use

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

("js/xwiki/table/tablefilterNsort.js", true)
{{/velocity}}

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

Images

2.1 Images

Fonctionnalité	Syntaxe XWiki 2.1	Résultat
Image d'une pièce jointe à la page courante	image:img.png
Image d'une pièce jointe à un autre document	image:Space.Page @img.png
Image avec des paramètres	[[image:img.png|| width="25" height="25"]]
Images localisées dans un URL	image:http://some/url/img.png
Icônes	image:icon:accept

Avancé

Verbatim

2.0 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.

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

Du contenu 
**verbatim**
sur plusieurs lignes

Citations

2.0 Quotations

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

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

Groupes

2.0 Groups

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.

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

Protéger les caractères

2.0 Escapes

Paramètres

2.0 Parameters

En syntaxe XWiki 2.1, 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 styles. 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. 

(% class="myClass" style="myStyle" id="myId" %)
= titre =

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

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

{{code language="java"}}
System.out.println("Hello World!");
{{/code}}

Macros dans ce wiki

HTML

2.0 HTML

Scripts

2.0 Scripts

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

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