Ceci est une ancienne révision du document !
Syntaxe de mise en page
DokuWiki supporte un langage de balises simple, qui essaie de rendre les fichiers de données aussi lisibles que possible. Cette page contient toute la syntaxe possible que vous pourrez utiliser en éditant les pages. Regardez simplement le 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 le bac à sable. Les balises les plus simples sont facilement accessibles depuis les boutons rapides, aussi.
Mise en forme de texte basique
DokuWiki supporte les textes en emphase, emphase forte, souligné (déconseillé) et à espace fixe
(pour du code en ligne).
Bien sûr, vous pouvez tous les combiner
.
DokuWiki supporte les textes en //emphase//, **emphase forte**, __souligné__ (déconseillé) et ''à espace fixe'' (pour du code en ligne). 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 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.
Mini-tutoriels
Installation de paquets
Utilisez une phrase du type : Installez les paquetsfoo bar ou directement par simple clique foo,bar* grâce au code :
<code>Installez les paquets foo bar ou directement par simple clique foo,bar .</code>
==== Suppression de paquets ====
Utiliser une phrase du type : Supprimez les paquets foo bar etc grâce au code :
<code>Supprimez les paquets foo bar etc.</code>
==== Création ou modification de fichier ====
Utilisez une phrase du type : Ouvrez le fichier /chemin/du/fichier grâce au code :
<code>Ouvrez le fichier /chemin/du/fichier.</code>
==== Modification des sources de mises à jour (dépôts) ====
Utilisez aussi un lien vers le mini-tutoriel du type :
Modifiez vos sources de mises à jour pour y ajouter le dépôt suivant :
<file>deb http://url_du_dépôt …</file>
Code à utiliser :
<code>
Modifiez vos sources de mises à jour pour y ajouter le dépôt suivant :
<file>deb http://url_du_dépôt …</file>
</code>
==== Recharger la liste des paquets ====
Utilisez une phrase du type : rechargez la liste des paquets grâce au code :
<code>rechargez la liste des paquets</code>
==== Création d’un lanceur ====
Utilisez un lien vers le tutoriel du type :
Créez un raccourci en utilisant comme commande :
foo
Code à utiliser :
<code>
Créez un raccourci en utilisant comme commande :
foo
</code>
===== Les « tags » =====
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é 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 ( accent pris en compte ) et au singulier.
==== Syntaxe ====
Pour utiliser des tags (mots-clés) dans les pages du wiki :
À la place de « liste des tag », écrivez tous les tags qui peuvent être utilisés pour la page, séparés par un 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.
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. Enfin, les tags doivent suivre l'ordre suivant :
==== Les « topics » ==== Pour lister les pages ayant un tag utilisez cette syntaxe :
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.). D'autres syntaxes sont également possibles :
(tag1 ET tag2)
(tag1 SAUF tag2)
(tag1 OU tag2) Pour plus de détails, se référer à l'aide de l'élément Topic sur DokuWiki. ===== Liens ===== DokuWiki propose plusieurs moyens de créer des liens. ==== Externes ==== 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: Ce lien pointe vers google. Les adresses email telles que celle-ci : toto@foo.bar sont également reconnues. ==== Internes ==== Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner un wiki:pagename ou utiliser un titre. Les catégories (pagenames) wiki sont converties 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 wiki:pagename ou utiliser un titre. Les pages (pagenames) wiki sont converties 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 catégories (namespaces) en utilisant les deux points dans le nom de page pagename. Pour plus de détails sur les catégories (namespaces), voir wiki:namespaces. Les liens vers une section spécifique sont également possibles. Ajoutez simplement le nom de la section derrière un caractère dièse comme dans le HTML. Ce lien renvoie vers cette section. Ce lien renvoie vers cette section. Notes : * Les liens vers des pages existantes sont montrés dans un style différent des pages inexistantes. * DokuWiki n'utilise pas la CamelCase pour utiliser des liens par défaut, mais ce comportement peut être mis en place dans le fichier de config. Astuce : si DokuWiki est un lien, alors c'est mis en place. * Lorsque le titre d'une section est modifié, alors le bookmark 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: * 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/ <code> 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/ </code> ==== 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 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. Notes : * Pour des raisons de sécurité, la navigation directe de partages Windows ne fonctionne que dans Microsoft Internet Explorer par défaut (et seulement dans la « local zone »). * Pour Mozilla et Firefox, elle peut être mise en place dans l'option de configuration security.checkloaduri mais ceci n'est pas recommandé * Veuillez consulter 151 pour plus d'informations ==== 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 ci-dessous) comme ceci : NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom du lien. ==== Redirection ==== Il est également possible de rediriger automatiquement une page vers une page déjà existante :
exemple sur la page tv:
qui est la page http://doc.ubuntu-fr.org/tv qui redirige vers http://doc.ubuntu-fr.org/television <note importante>N.B. : Les redirections en cascade ont été désactivées, car elles sont dangereuses (risque de boucle).</note> ===== Notes de pied de page ===== Vous pouvez ajouter des notes de pied de page 1) en utilisant 2 doubles parenthèses. Vous pouvez ajouter des notes de pied de page 2)
une note de pied de page)) en utilisant 2 doubles parenthèses.===== Découpage en sections ===== 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 ==
==== 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 =====
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.
===== Listes =====
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
- La même liste mais ordonnée
- Un autre élément
- 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à===== Émoticônes (smileys) ===== 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
<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>
<note interdit> Ceci est un exemple d'interdit. On l'utilise pour ne pas faire une action. </note>===== Typographie ===== 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. ===== 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
===== Tableaux ===== DokuWiki propose une syntaxe simple pour créer des tableaux.Non nous ne devrions pasVraiment ?Eh bien, je pense que siOui !Alors faisons-le !
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 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.
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 |
| ^ 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.
Tableau avec alignement | ||
---|---|---|
droite | centré | gauche |
gauche | droite | centré |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
^ Tableau avec alignement ^^^ | droite| centré |gauche | |gauche | droite| centré | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |===== Blocs non analysés ===== 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édant) 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.
===== Surlignement de syntaxe =====
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 ===== Inclure du code HTML ou PHP ===== 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é.
===== Plugins de syntaxe =====
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. - 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