wiki:syntax

Bertrand Sennegon — Thu, 24 Dec 2009 12:24:39 +0200

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 Éditer cette page en haut ou en bas de cette page. Si vous souhaitez essayer quelque chose, rendez-vous dans la page du bac à sable.

Les balises les plus simples sont aussi facilement accessibles depuis les raccourcis.

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 _indice et ^exposant.

Vous pouvez aussi utiliser <sub>indice</sub> et <sup>exposant</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\\ une 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 les crochets. Vous pouvez soit juste donner un nom de page soit utiliser un texte pour le titre. Les noms de pages (pagenames) wiki sont convertis automatiquement en minuscules ; les caractères spéciaux ne sont pas autorisés.

Les liens internes sont créés en utilisant les crochets. Vous pouvez soit
juste donner un [[nom_de_page]] soit utiliser un
[[nom_de_page|texte pour le titre]]. Les noms de pages (//pagenames//) wiki
sont convertis automatiquement en minuscules ; les caractères spéciaux ne
sont pas autorisés.

Vous pouvez utiliser des catégories (namespaces) en utilisant les deux points (:) dans le nom de page pagename.

Vous pouvez utiliser des [[categories]] (//namespaces//) en utilisant les //deux points// ('':'') dans le nom de page //pagename//.

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

Les liens vers une section spécifique sont également possibles. 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 :

Les liens vers des pages existantes sont montrés dans un style différent des liens vers des pages inexistantes.
DokuWiki n'utilise pas la syntaxe CamelCase pour utiliser des liens par défaut, mais ce comportement peut être activé dans le fichier de configuration. Astuce : si le mot DokuWiki apparaît sur cette page comme un lien, alors c'est que la syntaxe CamelCase est activée.
Lorsque le titre d'une section est modifié, alors son lien change aussi. Donc ne comptez pas trop sur les liens de section.

Interwiki

DokuWiki propose les liens Interwiki. Ce sont des liens rapides vers d'autres Wikis. Par exemple ceci est un lien vers la définition des Wikis dans Wikipedia : Wiki.

DokuWiki propose les liens [[doku>wiki:fr:interwiki|Interwiki]]. Ce sont des
liens rapides vers d'autres Wikis. Par exemple ceci est un lien vers la
définition des Wikis dans Wikipedia : [[wpfr>Wiki]].

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.

Les syntaxes d'image complète et de Liens sont possibles (incluant 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 ¹⁾ 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 inclure des images externes et internes avec des accolades. Vous pouvez spécifier leur taille (facultatif).

Taille réelle :

Redimensionnement à une largeur donnée :

Redimensionnement à une largeur et une hauteur données :

Image externe redimensionnée :

Taille réelle :                                          {{wiki:dokuwiki-128.png}}
Redimensionnement à une largeur donnée :                 {{wiki:dokuwiki-128.png?50}}
Redimensionnement à une largeur et une hauteur données : {{wiki:dokuwiki-128.png?200x50}}
Image externe redimensionnée :                           {{http://de3.php.net/images/php.gif?200x50}}

En utilisant des espaces à gauche ou à droite, vous pouvez choisir l'alignement.

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

Bien sûr, vous pouvez aussi ajouter un titre (affiché comme une bulle d'aide par la plupart des navigateurs).

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

Si vous spécifiez un nom de fichier (externe ou interne) qui n'est pas une image (gif, jpeg, png), alors il sera affiché comme un lien et non comme une image.

Pour lier une image à une autre page, voir Liens images ci-dessus.

Gestion des Galeries d'Images

Le présent wiki est enrichi du plugin gallery qui permet bien des possibilités pour présenter des images.

Subtilité de ce plugin, il affiche une galerie de tout un répertoire. Il vous faut donc glisser toutes les images que vous souhaitez insérer dans votre galerie dans le même répertoire. (pour rappel, pour créer un nouveau répertoire; taper nom-du-répertoire: devant le nom du fichier que vous uploadez).

 
  {{gallery>nom_du_répertoire}}

vous affichera une miniature de toutes les images contenues dans le répertoire.

Vous pourrez précisez le dimensionnement des miniatures avec:

  {{gallery>nom_du_répertoire?150x150}}

Par défault: 120×120

Le nombre de colonnes:

  {{gallery>nom_du_répertoire?3}}

Vous pourrez utiliser la belle présentation Lightbox avec cette option:

  {{gallery>nom_du_répertoire?lightbox}}

Vous pourrez aussi combiner les options:

  {{gallery>nom_du_répertoire?3&200x200&lightbox}}

Démonstration:

Pas de réponse.

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.

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
1. Utilisez simplement l'indentation pour des niveaux plus profonds
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à

Emoticônes (smileys)

DokuWiki transforme les Émoticônes courantes en leurs équivalents graphiques. Plus d'émoticônes (smileys) peuvent être placées dans le répertoire smiley et configurées dans le fichier conf/smileys.conf. Voici une vue d'ensemble des émoticônes incluse dans DokuWiki.

8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME

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'..."

NB : Ces conversions peuvent être désactivées par une option dans le fichier de configuration ou un fichiers de motifs.

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    |

NB : les fusions verticales ne sont pas possibles.

Vous pouvez également aligner les contenus du tableau. 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

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.

Ceci est du code préformaté, toutes les espaces sont préservées : comme           <-ceci

Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avez cité un fichier.

Pour laisser l'analyseur ignorer complètement un bloc (comme ne pas faire lui appliquer de mise en forme), encadrez ce bloc soit avec des balises nowiki ou, encore plus simple, avec des caractères pourcent doubles %%.

Voici du texte qui contient des adresses comme ceci : http://www.spiltbrain.org et de la **mise en forme**, mais rien ne se passe.

Consultez le code source de cette page pour voir comment utiliser ces blocs.

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 dans la section précédent, mais cette fois le nom du langage utilisé est insérée dans la balise. Par exemple : <code java>.

/** 
 * La classe HelloWorldApp implemente 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.
    }
}

Les identificateurs de langage suivants sont actuellement reconnus : actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80

Agrégation de fils RSS/ATOM

dokuwiki peut agréger les données de fils XML externes. Pour l'analyse des fils XML, SimplePie est utilisé. Tous les formats connus de SimplePie peuvent aussi être utilisés 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 étiquettes (tags) seront enlevées
n[dhm]	durée de rafraîchissement, ou d=days (jours), h=heures, m=minutes. (Par exemple 12h = 12 heures).

La durée 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é quand la page a un contenu dynamique externe. Le paramètre dit à dokuwiki de réengendrer la page s'il y a plus que la durée de rafraîchissement depuis que la page a été engendrée pour la dernière fois.

Exemple :

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

Google Adds Licensing Server DRM To Android Market par Soulskill (2010/07/30 22:39)
Tribalism Is the Enemy Within, Says Shuttleworth par Soulskill (2010/07/30 21:57)
What's Wrong With the American University System par Soulskill (2010/07/30 21:17)
New Mars Rover Rolls For the First Time par Soulskill (2010/07/30 20:56)
An iPhone App Store That Apple Doesn't Control par Soulskill (2010/07/30 20:38)

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 comme ceci :

<html>
Ceci est du <font color="red" size="+1">HTML</font>
</html>

Ceci est du HTML

<php>
echo 'Un logo produit par PHP :';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Logo PHP !" />';
</php>

echo 'Un logo produit par PHP :'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Logo PHP !" />';

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

Gestion des Tags

Le plugin Tags est installé.

Il vous permet d'insérer des tags dans les articles afin de les lister ensuite.

Pour insérer un tag:

Pour afficher dans une page la liste des articles comportant ce tag:

Gestion des Discussions

Le plugin Discussion est installé. Il permet aux visiteurs de réagir aux articles.

~~DISCUSSION~~

Permet d'ouvrir les commentaires aux visiteurs, à placer la où l'article vous semble mériter des commentaires.

Extensions de syntaxe

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

Info Plugin 2008-09-12 par Andreas Gohr
Displays information about various DokuWiki internals
Gallery Plugin 2009-11-02 par Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed
Cloud Plugin 2009-09-12 par Gina Häußge, Michael Klier, Esther Brunner
displays the most used words in a word cloud
Indexmenu tag 2009-08-29 par Samuele Tognini
Indexmenu tag plugin.
Pagelist Plugin 2008-08-08 par Gina Häußge, Michael Klier, Esther Brunner
lists pages
Tag Plugin (topic component) 2009-05-11 par Gina Häußge, Michael Klier, Esther Brunner
Displays a list of wiki pages with a given category tag
Blog Plugin (draft component) 2009-09-12 par Gina Häußge, Michael Klier, Esther Brunner
Marks the current page as draft
Include Plugin 2009-09-12 par Gina Häußge, Michael Klier, Esther Brunner
Displays a wiki page (or a section thereof) within another
Discussion Plugin (threads component) 2009-08-22 par Gina Häußge, Michael Klier, Esther Brunner
Displays a list of recently active discussions
Avatar Plugin 2007-02-21 par Gina Häußge, Michael Klier, Esther Brunner
Displays avatar images
addnewpage 20/12/2006 par iDo
This add a "new page form" in your page. \ Syntax : {{NEWPAGE[>namespace]}} where [>namespace] is optional.

¹⁾ Ceci est une note de pied de page

Brin de paille

wiki-ca - créée