Syntaxe
Table of Contents
Formatage de base du texte
DokuWiki prend en charge les textes en gras, italique, souligné et monospaced
. Bien sûr, On peut combiner
tout cela.
DokuWiki prend en charge les textes en **gras**, //italique//, __souligné__ et `monospaced`. Bien sûr, On peut **__//`combiner`//__** tout cela.
On peut également utiliser indice et exposant.
On peut également utiliser <sub>indice</sub> et <sup>exposant</sup>.
On peut également marquer quelque chose comme supprimé.
On peut également marquer quelque chose comme <del>supprimé</del>.
Les paragraphes sont créés à partir de lignes vides. Si vous souhaitez forcer une nouvelle ligne sans paragraphe, On peut utiliser deux barres obliques inverses suivies d'un espace ou d'une fin de ligne.
Ceci est du texte avec des sauts de ligne
Notez que le
deux barres obliques inverses ne sont reconnues qu'en fin de ligne
ou suivi de
un espace blanc \\cela se produit sans lui.
Ceci est du texte avec des sauts de ligne\\ Notez que le deux barres obliques inverses ne sont reconnues qu'en fin de ligne\\ ou suivi de\\ un espace blanc \\cela se produit sans lui.
Vous ne devez utiliser les retours à la ligne forcés que si cela est vraiment nécessaire.
Liens
DokuWiki prend en charge plusieurs façons de créer des liens.
Externe
Les liens externes sont automatiquement reconnus : http://www.google.com ou simplement www.google.com - On peut é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 - On peut définir texte du lien également : [[http://www.google.com|Ce lien pointe vers google. E-mail
des adresses comme celle-ci : <andi@splitbrain.org> sont également reconnues.
Interne
Les liens internes sont créés à l'aide de crochets. On peut soit simplement donner un pagename, soit utiliser un link text supplémentaire.
Les liens internes sont créés à l'aide de crochets. On peut soit simplement donner un [[nom de page]] ou utilisez un [[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.
On peut utiliser namespaces en utilisant deux-points dans le nom de la page.
On peut utiliser [[some:namespaces]] en utilisant deux-points dans le nom de la page.
Pour plus de détails sur les espaces de noms, voir namespaces.
Un lien vers une section spécifique est également possible. Ajoutez simplement le nom de la section derrière un caractère dièse comme connu du HTML. Cela renvoie à cette section.
Cela renvoie à [[syntax#internal|cette section]].
* Les liens vers les pages existantes sont affichés dans un style différent de ceux des nonexistants.
* DokuWiki n'utilise pas la 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, il est activé.
* Lorsque le titre d'une section est modifié, son signet change également. Ne comptez donc pas trop sur les 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 de 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 de Wikipédia sur les Wikis : [[wp>Wiki]].
Partages Windows
Les partages Windows tels que this 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 tels que [[\\server\share|this]] sont également reconnus.
* Pour des raisons de sécurité, la navigation directe dans les partages Windows ne fonctionne que dans Microsoft Internet Explorer par défaut (et uniquement dans la “zone locale”).
* Pour Mozilla et Firefox, il peut être activé via différentes solutions de contournement mentionnées dans la Mozilla Knowledge Base. 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), mettre la ligne suivante dans conf/lang/en/lang.php
(plus de détails sur localization)
- conf/lang/fr/lang.php
<?php /** * Personnalisation du fichier de langue anglaise * Copier uniquement les chaînes qui doivent être modifiées */ $lang['js']['nosmblinks'] = `;
Liens d'images
On peut également utiliser une image pour créer un lien vers 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}}]]
Le formatage d'image est la seule syntaxe de formatage acceptée dans les noms de lien.
L'ensemble de la syntaxe image et link est pris en charge (y compris le redimensionnement des images, les images internes et externes, les URL et les liens interwiki).
Pied de page
On ne peut ajouter des notes de bas de page 1) en utilisant des doubles parenthèses.
On peut ajouter des notes de bas de page ((Ceci est une note de bas de page)) en utilisant des doubles parenthèses.
Sectionnement
On peut utiliser jusqu'à cinq niveaux de titres différents 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 <nowiki>~~NOTOC~~</nowiki>
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, On peut tracer une ligne horizontale :
Fichiers multimédias
On peut inclure des images, vidéos et fichiers audio externes et internes avec des accolades. En option, On peut spécifier la taille de ceux-ci.
Redimensionner à la largeur donnée :
Redimensionner à la largeur et à la hauteur données 2) :
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 : {{http://php.net/images/php.gif?200x50}}
En utilisant des espaces blancs à gauche ou à droite, On peut choisir l'alignement.
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png}} {{ wiki:dokuwiki-128.png }}
Bien sûr, On peut également ajouter un titre (affiché sous forme d'info-bulle par la plupart des navigateurs).
{{ wiki:dokuwiki-128.png |Ceci est la légende}}
Pour lier une image à une autre page, voir Liens Image ci-dessus.
Formats de mé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 |
Flasher | swf |
Si vous spécifiez un nom de fichier qui n'est pas un format multimédia pris en charge, il sera affiché sous forme de 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 secours
Malheureusement, tous les navigateurs ne comprennent pas tous les formats vidéo et audio. Pour atténuer le problème, On peut télécharger votre fichier dans différents formats pour une compatibilité maximale avec le navigateur.
Par exemple, considérez cette vidéo mp4 intégrée :
{{video.mp4|Une vidéo amusante}}
Lorsque vous téléchargez une video.webm
et une video.ogv
à côté de la video.mp4
référencée, DokuWiki les ajoutera automatiquement comme alternatives afin que l'un des trois fichiers soit compris par votre navigateur .
De plus, DokuWiki prend en charge une image “poster” qui sera affichée avant le début de la vidéo. Cette image doit avoir le même nom de fichier que la vidéo et être un fichier jpg ou 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, indentez votre texte de deux espaces et utilisez un *
pour les listes non ordonnées ou un -
pour les listes ordonnées.
- Ceci est une liste
- Le deuxième élément
- On peut avoir différents niveaux
- Un autre article
- La même liste mais ordonnée
- Un autre article
- Utilisez simplement l'indentation pour les niveaux plus profonds
- C'est ça
* Ceci est une liste * Le deuxième élément * On peut avoir différents niveaux * Un autre article - La même liste mais ordonnée - Un autre article - Utilisez simplement l'indentation pour les niveaux plus profonds - C'est ça
Consultez également la FAQ sur les éléments de la liste.
Conversions de texte
DokuWiki peut convertir certains caractères ou chaînes prédéfinis en images ou autre texte ou HTML.
La conversion de texte en image se fait principalement pour les smileys. Et la conversion de texte en HTML est utilisée pour les remplacements de typographie, mais peut également être configurée pour utiliser d'autres HTML.
Conversions de texte en image
DokuWiki convertit les émoticônes couramment utilisés en leurs équivalents graphiques. Ces Smileys et d'autres images peuvent être configurées et étendues. Voici un aperçu des Smileys inclus dans DokuWiki :
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
- FIXEZ-MOI %% FIXEZ-MOI %%
- SUPPRIMER %% SUPPRIMER %%
Conversions de texte en HTML
Typographie : DokuWiki peut conconvertir les caractères de texte simples en leurs entités typographiquement correctes. Voici un exemple de caractères reconnus.
→ ← ↔ ⇒ ⇐ ⇔ – — © ™ ®
“Il pensait 'C'est un monde d'hommes'…”
-> <- <-> => <= <=> -- --- (c) (tm) (r) "Il pensait 'C'est un monde d'hommes'..."
La même chose peut être faite pour produire n'importe quel type de HTML, il suffit de l'ajouter au pattern file.
Il y a trois exceptions qui ne proviennent pas de ce fichier de modèle : entité de multiplication (640×480), 'single' et “double quotes”. Ils peuvent être désactivés via une config option.
Tableaux
DokuWiki prend en charge une syntaxe simple pour créer des tableaux.
Titre 1 | Titre 2 | Titre 3 |
---|---|---|
Rangée 1 Col 1 | Rangée 1 Col 2 | Rangée 1 Col 3 |
Rangée 2 Col 1 | du colspan (notez le double tuyau) | |
Rangée 3 Col 1 | Rang 3 Col 2 | Rang 3 Col 3 |
Les lignes du tableau doivent commencer et se terminer par un |
pour les lignes normales ou un ^
pour les en-têtes.
^ Titre 1 ^ Titre 2 ^ Titre 3 ^ | Rangée 1 Col 1 | Rangée 1 Col 2 | Rangée 1 Col 3 | | Rangée 2 Col 1 | du colspan (notez le double tuyau) || | Rangée 3 Col 1 | Rang 3 Col 2 | Rang 3 Col 3 |
Pour connecter les cellules horizontalement, il suffit de vider complètement la cellule suivante, comme indiqué ci-dessus. Assurez-vous d'avoir toujours la même quantité de séparateurs de cellules !
Les en-têtes de table verticaux sont également possibles.
Titre 1 | Titre 2 | |
---|---|---|
Titre 3 | Rangée 1 Col 2 | Rangée 1 Col 3 |
Titre 4 | pas de colspan cette fois | |
Titre 5 | Rangée 2 Col 2 | Rangée 2 Col 3 |
Comme On peut le voir, c'est le séparateur de cellule avant une cellule qui décide de la mise en forme :
| ^ Titre 1 ^ Titre 2 ^ ^ Titre 3 | Rangée 1 Col 2 | Rangée 1 Col 3 | ^ Titre 4 | pas de colspan cette fois | | ^ Titre 5 | Rangée 2 Col 2 | Rangée 2 Col 3 |
On peut avoir des rowspans (cellules connectées verticalement) en ajoutant %%:::%%
dans les cellules en dessous de celle à laquelle elles doivent se connecter.
Titre 1 | Titre 2 | Titre 3 |
---|---|---|
Rangée 1 Col 1 | cette cellule s'étend verticalement | Rangée 1 Col 3 |
Rangée 2 Col 1 | Rangée 2 Col 3 | |
Rangée 3 Col 1 | Rangée 2 Col 3 |
En dehors de la syntaxe rowspan, ces cellules ne doivent rien contenir d'autre.
^ Titre 1 ^ Titre 2 ^ Titre 3 ^ | Rangée 1 Col 1 | cette cellule s'étend verticalement | Rangée 1 Col 3 | | Rangée 2 Col 1 | ::: | Rangée 2 Col 3 | | Rangée 3 Col 1 | ::: | Rangée 2 Col 3 |
On peut également aligner le contenu du tableau. Ajoutez simplement au moins deux espaces blancs à l'extrémité opposée de votre texte : ajoutez deux espaces à gauche pour aligner à droite, deux espaces à droite pour aligner à gauche et deux espaces au moins aux deux extrémités pour un texte centré.
Tableau avec alignement | ||
---|---|---|
droite | centre | gauche |
gauche | droite | centre |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Voici à quoi cela ressemble dans la source :
^ Tableau avec alignement ^^ | droite | centre |gauche | |gauche | droite | centre | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
L'alignement vertical n'est pas pris en charge.
Pas de formatage
Lorsqu'on a besoin d'afficher le texte exactement tel qu'il est tapé (sans aucune mise en forme), délimiter la zone soit avec des balises %%<nowiki>%%
ou encore plus simplement, avec des signes de pourcentage doubles <nowiki>%%< /nowiki>
.
C'est un texte qui contient des adresses comme celle-ci : http://www.splitbrain.org et **formatting**, mais rien n'est fait avec. Il en est de même pour //__ce__ texte// avec un smiley ;-).
<nowiki> C'est un texte qui contient des adresses comme celle-ci : http://www.splitbrain.org et **formatting**, mais rien n'est fait avec. </nowiki> Il en est de même pour %%//__ce__ texte// avec un smiley ;-)%%.
Blocs de code
On peut inclure des blocs de code dans vos documents en les indentant d'au moins deux espaces (comme pour les exemples précédents) ou en utilisant les balises %%<code>%%
ou %%<file>% %
.
Ce texte est indenté de deux espaces.
Ceci est du code préformaté tous les espaces sont conservés : comme <-this
<fichier> C'est à peu près la même chose, mais On peut l'utiliser pour montrer que vous avez cité un fichier.</fichier>
Ces blocs ont été créés par cette source :
Ce texte est indenté de deux espaces.
<code> Ceci est du code préformaté tous les espaces sont conservés : comme <-this </code>
<fichier> C'est à peu près la même chose, mais On peut l'utiliser pour montrer que vous avez cité un fichier. </fichier>
Mise en évidence de la syntaxe
DokuWiki peut mettre en évidence le code source, ce qui le rend plus facile à lire. Il utilise le surligneur de syntaxe générique GeSHi - donc toute langue prise en charge par GeSHi est prise en charge. La syntaxe utilise le même code et les mêmes blocs de fichiers décrits dans la section précédente, mais cette fois, le nom de la syntaxe du langage à mettre en évidence est inclus dans la balise, par ex. <nowiki><code java></nowiki>
ou <nowiki><fichier java></nowiki>
.
/** * La classe HelloWorldApp implémente une application qui * affiche simplement "Hello World!" à la sortie standard. */ classe 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, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, huer, c, cloadrunner, cmac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, génie, gdb, glsl, gml, gnuplot, aller, sensationnel, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icône, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, faire, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, non wlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, par, pf, php-brief, php, brochet, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progrès, prologue, propriétés, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, rubis, sas, scala, schéma, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, texte, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic
Blocs de code téléchargeables
Lorsque vous utilisez la syntaxe %%<code>%%
ou %%<file>%%
comme ci-dessus, vous souhaiterez peut-être également rendre le code affiché disponible au téléchargement. On peut le faire en spécifiant un nom de fichier après le code de langue comme ceci :
<fichier php monexemple.php> <?php echo "bonjour le monde!"; ?> </fichier>
<fichier php monexemple.php> <?php echo “bonjour le monde!”; ?> </fichier>
Si vous ne voulez pas de surbrillance mais que vous voulez un fichier téléchargeable, spécifiez un tiret (-
) comme code de langue : %%<code - myfile.foo>%%
.
Intégrer HTML et PHP
On peut intégrer du code HTML ou PHP brut dans vos documents en utilisant les balises %%<html>%%
ou %%<php>%%
. (Utilisez des balises en majuscules si vous devez inclure des éléments de niveau bloc.)
Exemple HTML :
<html> C'est du <span style="color:red;font-size:150%;">HTML intégré</span> </html> <HTML> <p style="border:2px dashed red;">Et ceci est un bloc HTML</p> </HTML>
<html> C'est du HTML intégré </html> <HTML
>
<
p style=“border:2px dashed red;”
>Et ceci est un bloc HTML</p>
<
/HTML
>
Exemple PHP :
<php> echo 'La version PHP : '; echo phpversion(); echo ' (HTML intégré généré)' ; </php> <PHP> echo '<table class="inline"><tr><td>Le même, mais à l'intérieur d'un élément de niveau bloc :</td>' ; echo '<td>'.phpversion().'</td>'; echo '</tr></table>' ; </PHP>
<php> echo 'La version PHP : '; echo phpversion(); echo ' (HTML en ligne)' ; </php> <PHP> echo '<table class=“inline”
><tr><td>Le même, mais à l'intérieur d'un élément de niveau bloc :</td>' ;