Table des matières

Syntaxe de mise en page

DokuWiki utilise un langage de balisage simple, qui essaie de rendre les fichiers de données aussi lisibles que possible. Cette page contient toutes les syntaxes possibles que vous pouvez utiliser en éditant les pages. Regardez simplement le code source de cette page en cliquant sur le bouton Modifier cette page. Si vous souhaitez essayer quelque chose, rendez-vous dans la page du bac à sable. Les balises les plus simples sont également facilement accessibles depuis la barre d'outils.

Mise en forme de texte basique

DokuWiki accepte les textes en gras, italique, souligné et à chasse fixe. Bien sûr, vous pouvez tous les combiner. 

DokuWiki accepte les textes en **gras**, //italique//, __souligné__ et ''à chasse fixe''. Bien sûr, vous pouvez tous les **__//''combiner''//__**.

Vous pouvez aussi utiliser des indices et exposants. 

Vous pouvez aussi utiliser des <sub>indices</sub> et <sup>exposants</sup>.

De plus, vous pouvez marquer un passage comme supprimé. 

De plus, vous pouvez marquer un passage comme <del>supprimé</del>.

Les paragraphes sont créés à partir des lignes vides. Si vous souhaitez forcer un saut de ligne sans paragraphe, vous pouvez utiliser deux contre-obliques suivies par un espace ou une fin de ligne.

Voici du texte avec des sauts de ligne
remarquez que les deux contre-obliques sont reconnues uniquement en fin de ligne
ou suivies par
un espace ; \\ceci se produit sinon. 

Voici du texte avec des sauts de ligne\\ remarquez que les
deux contre-obliques sont reconnues uniquement en fin de ligne\\
ou suivies par\\ un espace ; \\ceci se produit sinon.

Vous ne devriez forcer des sauts de ligne que si c'est vraiment nécessaire.

Liens

DokuWiki propose plusieurs moyens pour créer des liens.

Externes

Les liens externes sont reconnus automagiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : Ce lien pointe vers Google. Les adresses de courriel comme celle-ci : andi@splitbrain.org sont également reconnues. 

Les liens externes sont reconnus automagiquement : http://www.google.fr 
ou simplement www.google.fr - Vous pouvez aussi donner des noms aux 
liens : [[http://www.google.fr|Ce lien pointe vers Google]]. Les adresses 
de courriel comme celle-ci : <andi@splitbrain.org> sont également reconnues.

Internes

Les liens internes sont créés en utilisant des crochets. Vous pouvez juste utiliser un nom de page ou utiliser un texte de lien. 

Les liens internes sont créés en utilisant des crochets. Vous pouvez juste
utiliser un [[nom de page]] ou utiliser un [[nom de page|texte de lien]].

Les noms de pages wiki sont automatiquement convertis en minuscules ; les caractères spéciaux ne sont pas autorisés.

Vous pouvez utiliser les categories en utilisant les deux points dans le nom de page. 

Vous pouvez utiliser les [[voici:des:categories]] en utilisant
les deux points dans le nom de page.

Pour plus de détails sur les catégories, voir Catégories.

Les liens vers une section spécifique d'une page sont également possibles (voir la partie Découpage en sections). Ajoutez simplement le nom de la section après un caractère dièse comme en HTML. Ce lien renvoie vers cette section. 

Ce lien renvoie vers [[syntax#internes|cette section]].

Notes :

Interwiki

Les liens Interwiki sont des liens rapides vers d'autres Wikis.
Par exemple Wiki ou Wiki sont des liens vers la définition des Wikis dans Wikipedia en français. 

Les liens [[doku>fr:interwiki|Interwiki]] sont des liens rapides vers d'autres Wikis.\\
Par exemple [[wpfr>Wiki|Wiki]] ou [[wp>fr:Wiki|Wiki]] sont des liens vers la définition des Wikis dans Wikipedia en français.

Partages Windows

Les partages Windows tels que ceci sont également reconnus. Veuillez noter qu'ils n'ont un sens que dans un groupe d'utilisateurs homogène tels qu'un Intranet d'entreprise. 

Les partages Windows tels que [[\\serveur\partage|ceci]] sont également reconnus.

Notes :

Liens images

Vous pouvez aussi utiliser une image afin de créer un lien vers une autre page interne ou externe en combinant les syntaxes des liens et des images (voir plus bas) comme ceci : 

[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom de lien.

la totalité des syntaxes d'image et de Liens est possible (y compris le redimensionnement d'image, les images internes et externes, les URL et les liens interwikis).

Notes de pied de page

Vous pouvez ajouter des notes de pied de page 1) en utilisant des parenthèses doubles. 

Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page)) en utilisant des parenthèses doubles.

Découpage en sections

Vous pouvez utiliser jusqu'à cinq niveaux de titres différents afin de structurer le contenu. Si vous avez plus de trois titres, une table des matières est construite automatiquement – ceci peut être désactivé en incluant la chaîne ~~NOTOC~~ dans le document.

Titre niveau 3

Titre niveau 4

Titre niveau 5
==== Titre niveau 3 ====
=== Titre niveau 4 ===
== Titre niveau 5 ==

En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale : 


----

Images et autres fichiers

Vous pouvez insérer des images, fichiers audio et vidéo (ou autres fichiers) internes ou externes avec des accolades. Additionnelement, vous pouvez en préciser la taille.

taille originale :

largeur donnée :

hauteur et largeur données2) :

Image externe redimensionnée 

taille originale :                {{wiki:dokuwiki-128.png}}
largeur donnée :                  {{wiki:dokuwiki-128.png?50}}
hauteur et largeur données :      {{wiki:dokuwiki-128.png?200x50}}
Image externe redimensionnée :    {{http://de3.php.net/images/php.gif?200x50}}

Par défaut les images se placent au fil du texte, centrées verticalement.

Vous pouvez les aligner avec des espaces à gauche ou à droite : 

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Bien sûr, vous pouvez ajouter un titre, affiché comme une bulle d'aide par les navigateurs.

Ceci est le titre 

{{ wiki:dokuwiki-128.png |Ceci est le titre}}

Les fichiers qui ne sont pas affichables (voir tableau des médias pris en charge dans la section suivante), sont représentés uniquement comme un lien de téléchargement. Par défaut, les images disposent d'un lien vers une page de détails.

Vous pouvez modifier ce comportement :

Pas de lien.
Lien direct sur le media.
dokuwiki-128.png Uniquement le lien direct.
Lien vers une page. Voir liens images ci dessus 

{{wiki:dokuwiki-128.png?nolink}} Pas de lien.
{{wiki:dokuwiki-128.png?direct}} Lien direct sur le media.
{{wiki:dokuwiki-128.png?linkonly}} Uniquement le lien direct.
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]] Lien vers une page. Voir [[#liens images]] ci dessus

Vous pouvez combiner plusieurs effets avec & :

Le titre 

{{wiki:dokuwiki-128.png?50&nolink|Le titre}}

Médias pris en charge

DokuWiki peut directement présenter les formats de fichiers suivants

Image gif, jpg, png
Vidéo webm, ogv, mp4
Audio ogg, mp3, wav
Flash swf

Si vous indiquez un fichier dans un format non pris en charge, DokuWiki le présentera comme un lien de téléchargement.

Formats de repli

Malheureusement, certains navigateurs ne comprennent qu'un ensemble restreint de formats vidéo et audio. Pour atténuer ce problème, vous pouvez téléverser vos vidéos et audio dans différents formats pour augmenter la compatibilité avec les divers navigateurs. DokuWiki présentera alors des alternatives au navigateur.

Par exemple, si vous avez téléversé film.webm, film.ogv et film.mp4, lorsque vous présentez la vidéo mp4 comme ceci : 

{{film.mp4|une vidéo sympa}}

DokuWiki indiquera automatiquement les alternatives film.webm, film.ogv de telle sorte que l'un des formats au moins soit reconnu par le navigateur.

De plus, DokuWiki permet d'utiliser une image poster qui est affichée avant le démarrage de la vidéo. Cette image doit avoir le même nom que la vidéo et être soit une image jpeg, soit une image png. Dans l'exemple précédent, on aurait pu utiliser une image nommée film.jpg.

Listes

DokuWiki accepte les listes ordonnées et non ordonnées. Pour créer un élément de liste, indentez votre texte par deux espaces et utilisez une * pour une liste non ordonnée ou un - pour une liste ordonnée.

  1. La même liste mais ordonnée
  2. Un autre élément
    1. Utilisez simplement l'indentation pour des niveaux plus profonds
  3. Et voilà
  * Ceci est une liste
  * Le second élément
    * Vous pouvez avoir plusieurs niveaux
  * Un autre élément

  - La même liste mais ordonnée
  - Un autre élément
    - Utilisez simplement l'indentation pour des niveaux plus profonds
  - Et voilà

Vous pouvez aussi consulter notre FAQ sur les listes

Conversions textuelles

DokuWiki peut convertir certains caractères ou chaînes de caractère prédéfinis en image, autre texte, ou HTML.

Les conversions en image sont principalement utilisée pour les émoticônes (smileys). Les conversions en texte ou HTML sont utilisées pour des raisons de typographie, mais peuvent également être configurées pour utiliser d'autres balises HTML.

Emoticônes (smileys)

DokuWiki transforme les Émoticônes courantes en leurs équivalents graphiques. On peut facilement en ajouter d'autres. Voici une vue d'ensemble des émoticônes incluses dans DokuWiki.

Typographie

DokuWiki peut convertir de simples caractères de texte brut en leurs entités typographiques correctes. Voici un exemple des caractères reconnus.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…” 

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Il est possible de faire la même chose pour n'importe quelle balise HTML. Il suffit pour cela de rajouter une ligne dans le fichier de motifs.

Il existe trois exceptions à ce mécanisme. le symbole de multiplication (640×480), les 'apostrophes' et les “guillemets”. On peut toutefois désactiver ces trois substitutions par une option de configuration.

Citations

Parfois vous souhaitez marquer du texte afin de montrer que c'est une réponse ou un commentaire. Vous pouvez utiliser la syntaxe suivante : 

Je pense que nous devrions le faire

> Non nous ne devrions pas

>> Eh bien, je pense que si

> Vraiment ?

>> Oui !

>>> Alors faisons-le !

Je pense que nous devrions le faire

Non nous ne devrions pas
Eh bien, je pense que si
Vraiment ?
Oui !
Alors faisons-le !

Tableaux

DokuWiki propose une syntaxe simple pour créer des tableaux.

Titre 1 Titre 2 Titre 3
Ligne 1 Col 1 Ligne 1 Col 2 Ligne 1 Col 3
Ligne 2 Col 1 colonnes fusionnées (notez la double barre verticale)
Ligne 3 Col 1 Ligne 2 Col 2 Ligne 2 Col 3

Les lignes de tableau doivent commencer et se terminer avec une barre verticale | pour des lignes normales ou avec un ^ pour les titres. 

^ Titre 1         ^ Titre 2           ^ Titre 3                            ^
| Ligne 1 Col 1   | Ligne 1 Col 2     | Ligne 1 Col 3                      |
| Ligne 2 Col 1   | colonnes fusionnées (notez la double barre verticale) ||
| Ligne 3 Col 1   | Ligne 2 Col 2     | Ligne 2 Col 3                      |

Pour fusionner des cellules horizontalement, videz simplement complètement la cellule suivante comme il est montré ci-dessus. Assurez-vous d'avoir toujours le même nombre de séparateurs de cellules !

Les titres de tableau verticaux sont également possibles.

Titre 1 Titre 2
Titre 3 Ligne 1 Col 2 Ligne 1 Col 3
Titre 4 pas de fusion cette fois
Titre 5 Ligne 2 Col 2 Ligne 2 Col 3

Comme vous pouvez le constater, c'est le séparateur ('|' ou '^') précédant une cellule qui détermine le format : 

|              ^ Titre 1                  ^ Titre 2          ^
^ Titre 3      | Ligne 1 Col 2            | Ligne 1 Col 3    |
^ Titre 4      | pas de fusion cette fois |                  |
^ Titre 5      | Ligne 2 Col 2            | Ligne 2 Col 3    |

Vous pouvez fusionner des cellules verticalement en ajoutant ::: dans les cellules sous celles avec laquelle elles doivent fusionner. :!: Cette fonctionnalité n'est disponible que pour les versions supérieures à 2009-02-14b

Titre 1 Titre 2 Titre 3
Ligne 1 Col 1 Cette cellule s'étend
verticalement 		Ligne 1 Col 3
Ligne 2 Col 1 Ligne 2 Col 3
Ligne 3 Col 1 Ligne 3 Col 3

Ces cellules ne doivent rien contenir d'autre que l'indicateur de fusion vertical. 

^ Titre 1       ^ Titre 2                                  ^ Titre 3       ^
| Ligne 1 Col 1 |  Cette cellule s'étend\\ verticalement   | Ligne 1 Col 3 |
| Ligne 2 Col 1 | :::                                      | Ligne 2 Col 3 |
| Ligne 3 Col 1 | :::                                      | Ligne 3 Col 3 |

Vous pouvez également aligner les contenus du tableau (uniquement horizontalement). Ajoutez simplement au moins deux espaces à l'extrémité opposée de votre texte : ajoutez deux espaces sur la gauche pour aligner à droite, deux espaces sur la droite pour aligner à gauche et deux espaces au moins à chaque extrémité pour centrer le texte.

Tableau avec alignement
droite centré gauche
gauche droite centré
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Voici à quoi ça ressemble dans le code source : 

^          Tableau avec alignement         ^^^
|        droite|    centré    |gauche        |
|gauche        |        droite|    centré    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Blocs non analysés

Si vous avez besoin d'afficher du texte exactement comme il est saisi (sans aucun formatage), entourez le texte soit de balises <nowiki> soit, plus simplement encore, de double signe pourcent %%.

Voilà du texte qui contient une adresse : http://www.splitbrain.org et de la **mise en formee** ; mais il est reproduit tel quel. La même chose est vraie pour //__ce__ texte// avec une émoticône ;-). 

<nowiki>
Voilà du texte qui contient une adresse : http://www.splitbrain.org et de la **mise en formee** ; mais
il est reproduit tel quel.
</nowiki>
La même chose est vraie pour  %%//__ce__ texte// avec une émoticône ;-)%%.
<nowiki>

Blocs de code

Vous pouvez inclure des blocs non analysés dans vos documents soit en les indentant avec au moins deux espaces (comme on peut le voir dans les exemples précédents) soit en utilisant les balises <code> ou <file>. 

Ce texte est indenté avec deux espaces.
Ceci est du code préformaté, tous les espaces sont préservés :
comme           <- ceci
C'est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer
que vous avez cité un fichier. 
  Ce texte est indenté avec deux espaces.

<code>
Ceci est du code préformaté, tous les espaces sont préservés :
comme           <- ceci
</code>

<file>
C'est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer
que vous avez cité un fichier. 
</file>

Coloration syntaxique

DokuWiki peut mettre en forme et en couleur du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter GeSHi – donc n'importe quel langage connu de GeSHi est accepté. La syntaxe est la même que dans le bloc de code de la section précédente, mais cette fois le nom du langage utilisé est inséré dans la balise. Par exemple : <code java>. 

/** 
 * La classe HelloWorldApp implémente une application qui
 * affiche simplement "Hello World!" dans la sortie standard.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Affiche la chaîne.
    }
}

DokuWiki reconnait les identifiants de langage suivants : 4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript, actionscript3, ada, aimms, algol68, apache, applescript, apt_sources, arm, asm, asp, asymptote, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, batch, bf, biblatex, bibtex, blitzbasic, bnf, boo, c, caddcl, cadlisp, ceylon, cfdg, cfm, chaiscript, chapel, cil, c_loadrunner, clojure, c_mac, cmake, cobol, coffeescript, cpp, cpp-qt, cpp-winapi, csharp, css, cuesheet, c_winapi, d, dart, dcl, dcpu16, dcs, delphi, diff, div, dos, dot, e, ecmascript, eiffel, email, epc, erlang, euphoria, ezt, f1, falcon, fo, fortran, freebasic, freeswitch, fsharp, gambas, gdb, genero, genie, gettext, glsl, gml, gnuplot, go, groovy, gwbasic, haskell, haxe, hicest, hq9plus, html, html4strict, html5, icon, idl, ini, inno, intercal, io, ispfpanel, j, java, java5, javascript, jcl, jquery, julia, kixtart, klonec, klonecpp, kotlin, latex, lb, ldif, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, mathematica, matlab, mercury, metapost, mirc, mk-61, mmix, modula2, modula3, mpasm, mxml, mysql, nagios, netrexx, newlisp, nginx, nimrod, nsis, oberon2, objc, objeck, ocaml, ocaml-brief, octave, oobas, oorexx, oracle11, oracle8, oxygene, oz, parasail, parigp, pascal, pcre, per, perl, perl6, pf, phix, php, php-brief, pic16, pike, pixelbender, pli, plsql, postgresql, postscript, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, pys60, python, q, qbasic, qml, racket, rails, rbs, rebol, reg, rexx, robots, rpmspec, rsplus, ruby, rust, sas, sass, scala, scheme, scilab, scl, sdlbasic, smalltalk, smarty, spark, sparql, sql, standardml, stonescript, swift, systemverilog, tcl, tclegg, teraterm, texgraph, text, thinbasic, tsql, twig, typoscript, unicon, upc, urbi, uscript, vala, vb, vbnet, vbscript, vedit, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xbasic, xml, xojo, xorg_conf, xpp, yaml, z80, zxbasic.

D'autres options avancées sont disponibles, comme la mise en évidence des lignes ou l'ajout de numéros de lignes.

Bloc de code téléchargeables

Quand vous utilisez les balises <code> ou <file>, vous pouvez rendre disponible en téléchargement le code affiché. Il faut alors préciser un nom de fichier juste après le code du langage.

monexemple.php
<?php echo "hello world!"; ?>
<file php monexemple.php>
<?php echo "hello world!"; ?>
</file>

Si vous ne voulez pas de coloration syntaxique, il suffit de fournir un tiret (-) en guise de code de langage :
<code - monfichier.toto>.

Inclure du code HTML ou PHP

Vous pouvez inclure du code HTML ou PHP pur dans vos documents en utilisant les balises <html> ou <php>. En utilisant des balises en majuscule, vous définissez un bloc. Les balises en minuscule insèrent les éléments en ligne.

exemple HTML : 

Ceci est <html>de l'<span style="color:red;font-size:150%;">HTML en ligne</span>
</html>

Quant à <HTML>
<p style="border:2px dashed red;">ceci, un bloc HTML</p>
</HTML>

Ceci est de l'HTML en ligne

Quant à

ceci, un bloc HTML

exemple PHP : 

<php>
echo 'Version de PHP: ';
echo phpversion();
echo ' (HTML en ligne généré)';
</php>
<PHP>
echo '<table class="inline"><tr><td>La même chose, mais dans un élément de niveau bloc:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';
</PHP>

echo 'Version de PHP: '; echo phpversion(); echo ' (HTML en ligne généré)'; 

echo '<table class="inline"><tr><td>La même chose, mais dans un élément de niveau bloc:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';

NB : L'inclusion de code HTML et PHP est désactivée dans la configuration par défaut. Dans ce cas, le code est affiché au lieu d'être exécuté.

Agrégation de fils RSS/ATOM

DokuWiki peut agréger les données de fils XML externes. Pour l'analyse des fils XML, il utilise SimplePie. On peut utiliser tous les formats connus de SimplePie dans DokuWiki. Vous pouvez modifier le comportement en ajoutant plusieurs paramètres séparés par des espaces :

Paramètre Description
tout nombre sera utilisé comme le nombre maximum d'éléments à montrer, 8 par défaut
reverse affiche les derniers éléments en premier dans le fil
author affiche le nom des auteurs des éléments
date affiche les dates des éléments
description affiche les descriptions des éléments. Si HTML est désactivé, toutes les balises seront enlevées
nosort ne trie pas les éléments du fil
n[dhm] durée de rafraîchissement, ou d=days (jours), h=heures, m=minutes. (Par exemple 12h = 12 heures).

La période de rafraîchissement est par défaut de 4 heures. Toute valeur inférieure à 10 minutes sera traitée comme 10 minutes. DokuWiki essaiera en général de fournir une version de la page à partir du cache ; évidemment, cela est inadapté si la page a un contenu dynamique externe. Ce paramètre informe DokuWiki qu'il doit reconstruire la page s'il s'est écoulé plus de temps que la période de rafraîchissement depuis la dernière reconstruction.

Exemple : 

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Macros

Certains mots-clef modifient la manière dont DokuWiki génère une page, sans rajouter aucun contenu. Les macros suivantes sont disponibles :

Macro Description
~~NOTOC~~ Si cette macro est présente dans une page, aucune table des matières ne sera générée.
~~NOCACHE~~ Par défaut, DokuWiki met en cache les pages qu'il génère. Parfois, ce n'est pas ce qui est voulu (par exemple quand la syntaxe <php> vue ci-dessus est utilisée), ajouter cette macro va forcer DokuWiki à générer une page à chaque appel de celle-ci.

Extensions de syntaxe

La syntaxe de DokuWiki peut être étendue par des extensions. La manière d'utiliser les extensions installées est détaillée dans leurs pages de description respectives. Les extensions de syntaxe suivantes sont disponibles dans cette installation particulière de DokuWiki :

1)
Ceci est une note de pied de page
2)
Si les proportions de l'image ne sont pas respectées, celle-ci sera découpée avant redimensionnement selon les nouvelles proportions