meta données pour cette page
  •  

Ceci est une ancienne révision du document !


Syntaxe de mise en forme

DokuWiki prend en charge un langage de balisage simple, qui vise à rendre les fichiers de données aussi lisibles que possible. Cette page contient toutes les syntaxes possibles que vous pouvez utiliser lors de l'édition des pages. Il vous suffit de consulter le code source de cette page en appuyant sur “Modifier cette page”. Si vous souhaitez essayer quelque chose, utilisez simplement la page bac à sable. La mise en forme plus simple est également accessible via les boutons rapides.

Mise en forme de texte de base

DokuWiki prend en charge les textes en gras, italique, souligné et monospace. Bien sûr, vous pouvez combiner tout cela.

DokuWiki prend en charge les textes en **gras**, //italique//, __souligné__ et ''monospace''.
Bien sûr, vous pouvez **__//''combiner''//__** tout cela.

Vous pouvez utiliser indice et exposant, aussi.

Vous pouvez utiliser <sub>indice</sub> et <sup>exposant</sup>, aussi.

Vous pouvez marquer quelque chose comme supprimé également.

Vous pouvez marquer quelque chose comme <del>supprimé</del> également.

Les paragraphes sont créés à partir de lignes vides. Si vous voulez forcer un retour à la ligne sans créer de paragraphe, vous pouvez utiliser deux barres obliques inverses suivies d'un espace ou de la fin de la ligne. Voici un texte avec des retours à la ligne
Notez que les deux barres obliques inverses ne sont reconnues qu'à la fin d'une ligne
ou suivies d'
un espace \\ceci se produit sans cela.

Voici un texte avec des retours à la ligne\\ Notez que les
deux barres obliques inverses ne sont reconnues qu'à la fin d'une ligne\\
ou suivies d'\\ un espace \\ceci se produit sans cela.

Vous devriez utiliser les retours à la ligne forcés uniquement si c'est vraiment nécessaire.

Liens

DokuWiki prend en charge plusieurs façons de créer des liens.

Externes

Les liens externes sont reconnus automatiquement : http://www.google.com ou simplement www.google.com - Vous pouvez également définir le texte du lien : Ce lien pointe vers Google. Les adresses e-mail comme celle-ci : andi@splitbrain.org sont également reconnues.

DokuWiki prend en charge plusieurs façons de créer des liens. Les liens externes sont reconnus
automatiquement : http://www.google.com ou simplement www.google.com - Vous pouvez définir
le texte du lien également : [[http://www.google.com|Ce lien pointe vers Google]]. Les adresses e-mail
comme celle-ci : <andi@splitbrain.org> sont également reconnues.

Internes

Les liens internes sont créés en utilisant des crochets. Vous pouvez soit simplement indiquer un nom_de_page ou utiliser un texte de lien supplémentaire texte du lien.

Les liens internes sont créés en utilisant des crochets. Vous pouvez soit simplement indiquer un
[[nom_de_page]] ou utiliser un texte de lien supplémentaire [[nom_de_page|texte du lien]].

Les noms de page Wiki sont automatiquement convertis en minuscules, les caractères spéciaux ne sont pas autorisés. Vous pouvez utiliser des espaces_de_noms en utilisant un deux-points dans le nom de la page.

Vous pouvez utiliser des [[quelques:espaces_de_noms]] en utilisant un deux-points dans le nom de la page.

Pour plus de détails sur les espaces de noms, voir namespaces. Il est également possible de lier une section spécifique. Il suffit d'ajouter le nom de la section derrière un caractère dièse, comme en HTML. Cela crée un lien vers cette Section.

Cela crée un lien vers [[syntaxe#interne|cette Section]].

Remarques :

  • Les liens vers des pages existantes sont affichés dans un style différent des pages inexistantes.
  • DokuWiki n'utilise pas CamelCase pour créer automatiquement des liens par défaut, mais ce comportement peut être activé dans le fichier config. Astuce : Si DokuWiki est un lien, alors c'est activé.
  • Lorsque l'en-tête d'une section est modifié, son signet change également. Ne vous fiez donc pas trop aux liens de section.

Interwiki

DokuWiki prend en charge les liens Interwiki. Ce sont des liens rapides vers d'autres Wikis. Par exemple, voici un lien vers la page Wikipédia sur les Wikis : Wiki.

DokuWiki prend en charge les liens [[doku>Interwiki]]. Ce sont des liens rapides vers d'autres Wikis.
Par exemple, voici un lien vers la page Wikipédia sur les Wikis : [[wp>Wiki]].

Partages Windows

Les partages Windows comme celui-ci sont également reconnus. Veuillez noter que ceux-ci n'ont de sens que dans un groupe d'utilisateurs homogène comme un Intranet d'entreprise.

Les partages Windows comme [[\\serveur\partage|celui-ci]] sont également reconnus.

Remarques :

  • Pour des raisons de sécurité, la navigation directe dans les partages Windows ne fonctionne par défaut que dans Microsoft Internet Explorer (et uniquement dans la “zone locale”).
  • Pour Mozilla et Firefox, cela peut être activé via différentes solutions de contournement mentionnées dans la Base de connaissances Mozilla. Cependant, il y aura toujours un avertissement JavaScript concernant la tentative d'ouverture d'un partage Windows. Pour supprimer cet avertissement (pour tous les utilisateurs), ajoutez la ligne suivante dans conf/lang/fr/lang.php (plus de détails à localisation) :
    conf/lang/fr/lang.php
    <?php
    /**
     * Personnalisation du fichier de langue française
     * Copiez uniquement les chaînes qui doivent être modifiées
     */
    $lang['js']['nosmblinks'] = '';

Liens d'images

Vous pouvez également utiliser une image pour lier à une autre page interne ou externe en combinant la syntaxe des liens et des images (voir ci-dessous) comme ceci :

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

Veuillez noter : La mise en forme des images est la seule syntaxe de mise en forme acceptée dans les noms de liens. Toute la syntaxe des images et des liens est prise en charge (y compris le redimensionnement des images, les images internes et externes, les URL et les liens interwiki).

Notes de bas de page

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

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

Sections

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

Niveau de titre 3

Niveau de titre 4

Niveau de titre 5
==== Niveau de titre 3 ====
=== Niveau de titre 4 ===
== Niveau de titre 5 ==

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


Fichiers multimédias

Vous pouvez inclure des images, vidéos et fichiers audio internes et externes avec des accolades. Vous pouvez éventuellement spécifier leur taille. Taille réelle : Redimensionner à la largeur donnée : Redimensionner à la largeur et à la hauteur données2) : Image externe redimensionnée :

Taille réelle :                        {{wiki:dokuwiki-128.png}}
Redimensionner à la largeur donnée :   {{wiki:dokuwiki-128.png?50}}
Redimensionner à la largeur et à la hauteur données : {{wiki:dokuwiki-128.png?200x50}}
Image externe redimensionnée :         {{https://www.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 ajouter un titre (affiché comme une infobulle par la plupart des navigateurs), aussi. Voici la légende

{{ wiki:dokuwiki-128.png |Voici la légende}}

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

Formats multimédias pris en charge

DokuWiki peut intégrer directement les formats multimédias suivants.

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

Si vous spécifiez un nom de fichier qui n'est pas un format multimédia pris en charge, il sera affiché comme un lien à la place. En ajoutant ?linkonly vous fournissez un lien vers le média sans l'afficher en ligne

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

dokuwiki-128.png Ceci est juste un lien vers l'image.

Formats de repli

Malheureusement, tous les navigateurs ne comprennent pas tous les formats vidéo et audio. Pour atténuer le problème, vous pouvez télécharger votre fichier dans différents formats pour une compatibilité maximale avec les navigateurs. Par exemple, considérons cette vidéo mp4 intégrée :

{{video.mp4|Une vidéo amusante}}

Lorsque vous téléchargez un fichier video.webm et video.ogv à côté de la video.mp4 référencée, DokuWiki les ajoutera automatiquement comme alternatives afin qu'un des trois fichiers soit compris par votre navigateur. De plus, DokuWiki prend en charge une image “poster” qui sera affichée avant que la vidéo ne commence. Cette image doit avoir le même nom de fichier que la vidéo et être soit un fichier jpg, soit png. Dans l'exemple ci-dessus, un fichier video.jpg fonctionnerait.

Listes

DokuWiki prend en charge les listes ordonnées et non ordonnées. Pour créer un élément de liste, indentiez votre texte de deux espaces et utilisez un * pour les listes non ordonnées ou un - pour les listes ordonnées.

  • Voici une liste
  • Le deuxième élément
    • Vous pouvez avoir différents niveaux
  • Un autre élément
  1. La même liste mais ordonnée
  2. Un autre élément
    1. Utilisez simplement l'indentation pour des niveaux plus profonds
  3. C'est tout
  * Voici une liste
  * Le deuxième élément
    * Vous pouvez avoir différents 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
  - C'est tout

Consultez également la FAQ sur les éléments de liste.

Conversions de texte

DokuWiki peut convertir certains caractères ou chaînes de caractères prédéfinis en images ou en autre texte ou HTML. La conversion de texte en image est principalement effectuée pour les smileys. Et la conversion de texte en HTML est utilisée pour les remplacements typographiques, mais peut être configurée pour utiliser d'autres balises HTML également.

Conversions de texte en image

DokuWiki convertit les emoticons couramment utilisés en leurs équivalents graphiques. Ces Smileys et autres images peuvent être configurés et étendus. Voici un aperçu des smileys inclus dans DokuWiki :

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

Conversions de texte en HTML

Typographie : DokuWiki peut convertir des caractères de texte simples en leurs entités typographiquement correctes. Voici un exemple de 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 de même pour produire tout type de HTML, il suffit de l'ajouter au fichier de motifs. Il y a trois exceptions qui ne proviennent pas de ce fichier de motifs : l'entité de multiplication (640×480), les 'guillemets simples' et “les guillemets doubles”. Elles peuvent être désactivées via une option de configuration.

Citations

Parfois, vous souhaitez marquer un texte pour montrer qu'il s'agit d'une réponse ou d'un commentaire. Vous pouvez utiliser la syntaxe suivante :

Je pense que nous devrions le faire
> Non, nous ne devrions pas
>> Eh bien, je dis que nous devrions
> Vraiment ?
>> Oui !
>>> Alors faisons-le !

Je pense que nous devrions le faire

Non, nous ne devrions pas
Eh bien, je dis que nous devrions

Vraiment ?

Oui !
Alors faisons-le !

Tableaux

DokuWiki prend en charge une syntaxe simple pour créer des tableaux.

En-tête 1 En-tête 2 En-tête 3
Ligne 1 Col 1 Ligne 1 Col 2 Ligne 1 Col 3
Ligne 2 Col 1 fusion de colonnes (notez le double pipe)
Ligne 3 Col 1 Ligne 3 Col 2 Ligne 3 Col 3

Les lignes de tableau doivent commencer et se terminer par un | pour les lignes normales ou un ^ pour les en-têtes.

^ En-tête 1      ^ En-tête 2       ^ En-tête 3          ^
| Ligne 1 Col 1  | Ligne 1 Col 2   | Ligne 1 Col 3      |
| Ligne 2 Col 1  | fusion de colonnes (notez le double pipe) ||
| Ligne 3 Col 1  | Ligne 3 Col 2   | Ligne 3 Col 3      |

Pour connecter des cellules horizontalement, laissez simplement la cellule suivante complètement vide comme montré ci-dessus. Assurez-vous d'avoir toujours le même nombre de séparateurs de cellules ! Les en-têtes de tableau verticaux sont également possibles.

En-tête 1 En-tête 2
En-tête 3 Ligne 1 Col 2 Ligne 1 Col 3
En-tête 4 pas de fusion cette fois
En-tête 5 Ligne 2 Col 2 Ligne 2 Col 3

Comme vous pouvez le voir, c'est le séparateur de cellule avant une cellule qui décide de la mise en forme :

|              ^ En-tête 1            ^ En-tête 2          ^
^ En-tête 3    | Ligne 1 Col 2          | Ligne 1 Col 3      |
^ En-tête 4    | pas de fusion cette fois |                    |
^ En-tête 5    | Ligne 2 Col 2          | Ligne 2 Col 3      |

Vous pouvez avoir des fusions de lignes (cellules connectées verticalement) en ajoutant ::: dans les cellules en dessous de celle à laquelle elles doivent se connecter.

En-tête 1 En-tête 2 En-tête 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 2 Col 3

En dehors de la syntaxe de fusion de lignes, ces cellules ne doivent pas contenir autre chose.

^ En-tête 1      ^ En-tête 2                  ^ En-tête 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 2 Col 3      |

Vous pouvez également aligner le contenu des tableaux. Il suffit d'ajouter au moins deux espaces à l'extrémité opposée de votre texte : ajoutez deux espaces à gauche pour aligner à droite, deux espaces à droite pour aligner à gauche et au moins deux espaces aux deux extrémités pour centrer le texte.

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

Voici à quoi cela ressemble dans la source :

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

Remarque : L'alignement vertical n'est pas pris en charge.

Pas de mise en forme

Si vous devez afficher du texte exactement comme il est tapé (sans aucune mise en forme), encadrez la zone soit avec des balises <nowiki> ou même plus simplement, avec des doubles pourcentages %%. Voici un texte qui contient des adresses comme celle-ci : http://www.splitbrain.org et **mise en forme**, mais rien n'est fait avec. Il en va de même pour //__ce__ texte// avec un smiley ;-).

<nowiki>
Voici un texte qui contient des adresses comme celle-ci : http://www.splitbrain.org et **mise en forme**, mais rien n'est fait avec.
</nowiki>
Il en va de même pour %%//__ce__ texte// avec un smiley ;-)%%.

Blocs de code

Vous pouvez inclure des blocs de code dans vos documents soit en les indentant d'au moins deux espaces (comme utilisé pour les exemples précédents) soit en utilisant les balises <code> ou <file>.

Ce texte est indenté de deux espaces.
Voici du code préformaté, tous les espaces sont conservés : comme              <-ceci
C'est à peu près la même chose, mais vous pourriez l'utiliser pour montrer que vous avez cité un fichier.

Ces blocs ont été créés par cette source :

  Ce texte est indenté de deux espaces.
<code>
Voici du code préformaté, tous les espaces sont conservés : comme              <-ceci
</code>
<file>
C'est à peu près la même chose, mais vous pourriez l'utiliser pour montrer que vous avez cité un fichier.
</file>

Mise en évidence de la syntaxe

DokuWiki peut mettre en évidence le code source, ce qui le rend plus facile à lire. Il utilise le GeSHi Generic Syntax Highlighter – donc tout langage pris en charge par GeSHi est pris en charge. La syntaxe utilise les mêmes blocs de code et de fichier décrits dans la section précédente, mais cette fois le nom de la syntaxe de langage à mettre en évidence est inclus dans la balise, par exemple <code java> ou <file java>.

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

Les chaînes de langage suivantes sont actuellement reconnues : 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript 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 caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e 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 java5 java javascript jcl j 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-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic Il existe des options avancées supplémentaires disponibles pour la mise en évidence de la syntaxe, telles que la mise en évidence de lignes ou l'ajout de numéros de ligne.

Blocs de code téléchargeables

Lorsque vous utilisez la syntaxe <code> ou <file> comme ci-dessus, vous pouvez vouloir rendre le code affiché disponible pour téléchargement également. Vous pouvez le faire en spécifiant un nom de fichier après le code de langage comme ceci :

<file php mon_exemple.php>
<?php echo "bonjour le monde!"; ?>
</file>
mon_exemple.php
<?php echo "bonjour le monde!"; ?>

Si vous ne voulez aucune mise en évidence mais souhaitez un fichier téléchargeable, spécifiez un tiret (-) comme code de langage : <code - monfichier.foo>.

Agrégation de flux RSS/ATOM

DokuWiki peut intégrer des données provenant de flux XML externes. Pour analyser les flux XML, SimplePie est utilisé. Tous les formats compris par SimplePie peuvent également être utilisés dans DokuWiki. Vous pouvez influencer le rendu avec plusieurs paramètres supplémentaires séparés par des espaces :

Paramètre Description
un nombre quelconque sera utilisé comme nombre maximum d'éléments à afficher, par défaut 8
reverse afficher les derniers éléments du flux en premier
author afficher les noms des auteurs des éléments
date afficher les dates des éléments
description afficher la description de l'élément. Toutes les balises HTML seront supprimées
nosort ne pas trier les éléments du flux
n[dhm] période de rafraîchissement, où d=jours, h=heures, m=minutes. (ex. 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 généralement de fournir une version mise en cache d'une page, ce qui est évidemment inapproprié lorsque la page contient du contenu externe dynamique. Le paramètre indique à DokuWiki de rerendre la page si elle est plus ancienne que la période de rafraîchissement depuis le dernier rendu de la page. Par défaut, le flux sera trié par date, les éléments les plus récents en premier. Vous pouvez le trier par les plus anciens en premier en utilisant le paramètre reverse, ou afficher le flux tel quel avec nosort. Exemple :

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

Macros de contrôle

Certaines syntaxes influencent la manière dont DokuWiki rend une page sans créer de sortie. Les macros de contrôle suivantes sont disponibles :

Macro Description
~~NOTOC~~ Si cette macro est trouvée sur la page, aucune table des matières ne sera créée
~~NOCACHE~~ DokuWiki met en cache toute la sortie par défaut. Parfois, cela peut ne pas être souhaité (par exemple, lorsque la syntaxe <php> ci-dessus est utilisée), l'ajout de cette macro forcerait DokuWiki à rerendre une page à chaque appel

Plugins de syntaxe

La syntaxe de DokuWiki peut être étendue par des Plugins. La manière dont les plugins installés sont utilisés est décrite sur leurs pages de description appropriées. Les plugins de syntaxe suivants sont disponibles dans cette installation particulière de DokuWiki :

1)
Ceci est une note de bas de page
2)
lorsque le rapport hauteur/largeur de la largeur et de la hauteur données ne correspond pas à celui de l'image, elle sera recadrée au nouveau rapport avant le redimensionnement