Syntaxe de mise en page

DokuWiki utilise un langage de balises simple, qui essaie de rendre les fichiers de données aussi lisibles que possible. Cette page contient la description des éléments de syntaxe possibles que vous pourrez utiliser en modifiant les pages. Regardez simplement le source de cette page en cliquant sur le bouton « Éditer cette page » dans le menu de gauche. Si vous souhaitez essayer quelque chose, rendez-vous dans le bac à sable. Les balises les plus simples sont facilement accessibles depuis la barre d'outils d'édition.

Afin de faciliter la création et la modification des pages de la documentation nous recommandons l'utilisation de nos modèles, et des mini-tutoriels (boutons d'insertion dans la barre d'outils). De plus pour lier plus facilement les pages entre elles nous utilisons un système de tags à mettre en début de toutes nos pages.

DokuWiki supporte les textes en italique, gras, souligné et à espace fixe (pour du code en ligne). Bien sûr, vous pouvez aussi les combiner.

DokuWiki supporte les textes en //italique//, **gras**, __souligné__ et ''à espace fixe'' (pour du code en ligne).
Bien sûr, vous pouvez aussi 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 du contenu comme supprimé.

De plus, vous pouvez marquer du contenu comme <del>supprimé</del>.

Les paragraphes sont créés depuis les lignes vides. Si vous souhaitez forcer un saut de ligne sans paragraphe, vous pouvez utiliser deux antislashes suivis par un espace ou une fin de ligne.

Voilà du texte avec des sauts de ligne
remarquez que les deux antislashes sont seulement reconnus en fin de ligne
ou suivis par
un espace ; \\cela arrive sinon.

Voilà du texte avec des sauts de ligne\\ remarquez que les
deux antislashes sont seulement reconnus en fin de ligne\\
ou suivis par\\ un espace ; \\cela arrive sinon.

Vous devriez forcer des sauts de ligne uniquement si c'est réellement nécessaire.

Dans la documentation ubuntu-fr.org, les tags permettent de créer des liens d'arborescences entre toutes les pages, ainsi une page sans tags est une page qui sera très peu consultée et donc inutile, c'est pourquoi il est nécessaire d'ajouter le champ des tags avec les tags appropriés, bien évidement avec une orthographe correcte (accents y compris) et au singulier.

• Pour utiliser des tags (mots-clés) dans les pages du wiki :

{{tag>liste des tag}}

• À la place de « liste des tag », écrivez tous les tags qui peuvent être utilisés pour la page, séparés par une espace. Pour avoir la liste des tags disponibles, reportez-vous à l'index.

Les tags devant être accentués le sont. Exemples : matériel, système, sécurité, etc.

{{tag>matériel système sécurité}}

• Pour inclure une espace dans le nom du tag, remplacez-la par un tiret bas. Exemple ci-dessous.

• Les tags doivent être intégralement en minuscule, excepté le tag « BROUILLON » afin qu'il soit visible. Les tags des versions d'Ubuntu peuvent prendre une majuscule.

• Les tags de versions (Jaunty, Karmic …) correspondent aux versions pour lesquelles la page est valide; ils sont utiles pour toutes les pages de la documentation sauf les portails.

• Enfin, les tags doivent suivre l'ordre suivant :

{{tag><Versions> <domaine_principal> <domaines spécifiques> <autres_tags> <tutoriel si c'est un tutoriel ou autre> BROUILLON}}

Voir le chantier des tags

Pour lister les pages ayant un tag utilisez cette syntaxe :

{{topic>nom_du_tag}}

Si vous venez d'ajouter un tag à une page et qu'une page listant les pages contenant ce tag via « le wikicode topic » ne contient pas votre page, cela est peut-être du au fait que votre page ne contient pas de titre de niveau 1. Veillez à bien structurer votre page de manière sémantique (c'est-à-dire avec des titres, etc.). Il peut aussi s'agir d'un bug du plugin tag… (cf discussion sur mailing-list).

D'autres syntaxes sont également possibles :

{{topic>tag1 +tag2}}           (tag1 ET tag2)
{{topic>tag1 -tag2}}           (tag1 SAUF tag2)
{{topic>tag1 tag2}}            (tag1 OU tag2)

Pour plus de détails, se référer à l'aide de l'élément Topic sur DokuWiki.

DokuWiki propose plusieurs moyens de créer des liens.

Les liens externes sont reconnus automatiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : Ce lien pointe vers google. Les adresses email telles que celle-ci : toto@foo.bar sont également reconnues.

Les liens externes sont reconnus automatiquement : 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 email telles que celle-ci : <toto@foo.bar> sont également reconnues.

Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner un Nom de page ou utiliser un titre. Les pages (Nom de page) wiki sont converties automatiquement en minuscules, les caractères spéciaux ne sont pas autorisés ce qui donne nom_de_page.

Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner un [[Nom de page]] ou utiliser un [[nom de page|titre]]. Les pages (//Nom de page//) wiki sont converties automatiquement en minuscules, les caractères spéciaux ne sont pas autorisés ce qui donne //nom_de_page//.

Vous pouvez utiliser les catégories tutoriels et utilisateurs en utilisant les deux points dans le nom de page Nom de page, ce qui donne nom_de_page par exemple.

Vous pouvez utiliser les [[:wiki:namespaces|catégories]] tutoriels et utilisateurs en utilisant les //deux points// dans le nom de page //Nom de page//, ce qui donne [[:tutoriel:nom_de_page]] par exemple.

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

Les liens vers une section spécifique d'une page sont également possibles. Ajoutez simplement le nom de la section derrière un caractère dièse comme dans le HTML. Ces liens sont à éviter entre les pages car ils sont défini à l'aide des titres des sections qui peuvent changer au cours d'une modification de page.

Ce lien renvoie vers cette section.

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

DokuWiki propose les liens Interwiki. Ce sont des liens rapides vers d'autres Wikis. Par exemple:

• définition des Wikis dans Wikipedia (version anglaise)
• définition des Wikis dans Wikipedia (version française)
• Wiki liens vers une recherche Google.
• dokuwiki liens vers une recherche sur http://packages.ubuntu.com/

DokuWiki propose les liens [[doku>wiki:interwiki|Interwiki]].
Ce sont des liens rapides vers d'autres Wikis. Par exemple:
  * [[wp>wiki|définition des Wikis dans Wikipedia]] (version anglaise)
  * [[wpfr>wiki|définition des Wikis dans Wikipedia]] (version française)
  * [[google>Wiki]] liens vers une recherche Google.
  * [[pu>dokuwiki]] liens vers une recherche sur http://packages.ubuntu.com/

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 ci-dessous) 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 du lien.

Il est également possible de rediriger automatiquement une page vers une page déjà existante :

~~REDIRECT>Nom de la page vers laquelle pointer~~

exemple sur la page tv:

~~REDIRECT>television~~

qui est la page http://doc.ubuntu-fr.org/tv qui redirige vers http://doc.ubuntu-fr.org/television

Vous pouvez ajouter des notes de pied de page ¹⁾ en utilisant 2 doubles parenthèses.

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

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

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

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

Vous pouvez inclure des images externes et internes entre des accolades doubles. Vous pouvez spécifier leur taille en pixel après un ? (facultatif).

Taille réelle :

Redimension à une largeur donnée :

Redimension à une largeur et une hauteur données :

Image externe redimensionnée :

Taille réelle :                                   
{{wiki:dokuwiki-128.png}}
Redimension à une largeur donnée :                
{{wiki:dokuwiki-128.png?50}}
Redimension à 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'info 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.

DokuWiki supporte 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

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à

DokuWiki transforme les émoticônes généralement utilisées en leurs équivalents graphiques. Plus d'émoticônes (smileys) peuvent être placées dans le répertoire « smiley » et configurés dans le fichier « conf/smileys.conf ». Voici une vue d'ensemble des émoticônes inclues dans DokuWiki.

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

Pour ajouter un encadré avec une icône, il faut suivre la syntaxe suivante :

<note>
Ceci est un exemple de note classique ou de remarque.
</note>

<note tip>
Ceci est un exemple d'astuce ou de conseil.
</note>

<note help>
Ceci est un exemple d'aide.
</note>

<note important>
Ceci est un exemple de note importante.On l'utilise pour faire attention à une manipulation.
</note>

<note warning>
Ceci est un exemple de warning. On l'utilise pour poser un avertissement qui peut causer un dommage.
</note>

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640x480 © ™ ® "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 interdites dans le fichier de configuration.

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 !

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

Les lignes de tableau doivent commencer et terminer avec un pipe | 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 (colspan), rendez 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 titres de tableau verticaux sont également possibles.

Comme vous pouvez le constater, c'est le séparateur ('|' ou '^') précédant une cellule qui détermine son 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    |

Note : les fusions verticales (rowspan) ne sont pas possibles.

Vous pouvez également aligner le contenu du tableau. Ajoutez simplement au moins deux espaces blancs à 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.

Voici à quoi ressemble le code source :

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

Vous pouvez inclure des blocs non analysés (non parsed) dans vos documents soit en les indentant avec au moins deux espaces (comme utilisé dans les exemples précédents) ou en utilisant les tags code ou file.

Ceci est du code préformaté, tous les espaces sont préservés : 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 (ie. ne pas faire de mise en forme dedans), encadrez ce bloc soit avec des tags nowiki ou encore plus simple, avec des doubles caractères pourcent %%.

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 source de cette page pour voir comment utiliser ces blocs.

DokuWiki peut surligner du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter GeSHi – donc n'importe quel langage reconnu par GeSHi est supporté. 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 le tag. Ex : <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, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, html4strict, java, javascript, lisp, lua, mpasm, nsis, objc, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, visualfoxpro, xml

Vous pouvez inclure du code HTML ou PHP pur dans vos documents en utilisant les tags html ou php comme ceci :

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

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

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

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

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

La syntaxe de DokuWiki peut être étendue par des Plugins. La façon dont les plugins installés sont utilisés est décrite sur les pages de description appropriées. En particulier, les plugins de syntaxe suivants sont disponibles sur cette installation de DokuWiki :

• Box Plugin 2016-02-17 par Christopher Smith
  Boxes with titles, colour and rounded corners. Syntax: <box width class colours|title> ... </box|caption> width, class, colours title & caption are optional. The title can include some wiki markup, the box contents can include almost any wiki markup.
• Cloud Plugin 2017-08-05 par Michael Hamann, Michael Klier, Gina Haeussge
  Displays the most used words in a word cloud.
• Backlinks Plugin 2018-06-20 par Mark C. Prins
  Displays backlinks to a given page.
• Info Plugin 2014-10-01 par Andreas Gohr
  Displays information about various DokuWiki internals
• Page Redirect 2017-05-12 par Elan Ruusamäe, David Lorentsen
  Redirects page requests based on content
• Note Plugin 2018-04-28 par Olivier Cortès, Eric Hameleers, Christopher Smith, Aurélien Bompard, LarsDW223
  Add Note/Important/Tip/Warning Capability (DIV+CSS box)
• orphanswanted plugin 2017-06-25 par Doug Edmunds, Cyrille37, Federico Ariel Castagnini, Andy Webber, Matthias Schulte
  Display Orphans, Wanteds and Valid link tables
• Tag Plugin 2017-08-24 par Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  tag wiki pages
• Pagelist Plugin 2017-08-24 par Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
  Lists pages in a nice formatted way

Cette page a été traduite par djakoni. Vous pouvez trouver la version officielle ici