[[wiki:syntaxe]]
Piste: » syntaxe
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.
Les « tags »
Syntaxe
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.
Enfin, les tags doivent suivre l'ordre suivant :
Versions autres_tags tutoriel BROUILLON
Les « topics »
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.).
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: [[http://www.google.fr|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 [[doku>wiki:pagename]] ou utiliser un [[doku>wiki:pagename|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 [[wiki:namespaces|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 [[syntaxe#internes|cette section]].
Notes :
- Les liens vers des pages existantes sont montrés dans un style différent des pages inexistantes.
- 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/
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/
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 [[\\serveur\partage|ceci]] sont également reconnus. Veuillez noter qu'ils n'ont un sens que dans un groupe d'utilisateurs homogène tels qu'un [[wpfr>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 :
[[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.
Redirection
Il est également possible de rediriger automatiquement une page vers une page déjà existante :
~~REDIRECT>Nom de la page vers laquelle pointer~~
NB : Les redirections en cascade ont été désactivées,car elles sont dangereuses (risque de boucle).
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 ((Ceci est 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
Vous pouvez inclure des images externes et internes entre des accolades doubles. Vous pouvez spécifier leur taille en pixel après un ? (facultatif).
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.
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
Notes encadrées
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 important> Ceci est un exemple de note importante. </note>
<note tip> Ceci est un exemple d'astuce ou de conseil. </note>
<note help> Ceci est un exemple d'aide. </note>
<note warning> Ceci est un exemple de warning. </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
Non nous ne devrions pasEh bien, je pense que siVraiment ?
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 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.
| 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 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.
| Tableau avec alignement | ||
|---|---|---|
| droite | centré | gauche |
| gauche | droite | centré |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Voici à quoi ressemble 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 (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 :
- Note Plugin 2006-03-29 par Olivier Cortès / Eric Hameleers / Christopher Smith
Add Note/Important/Tip/Warning/Help Capability (DIV+CSS box) - OrphansWanted Plugin ver 2.3 2006-06-07 par Doug Edmunds
Find orphan pages and wanted pages .
syntax ~~ORPHANSWANTED:<choice>[!<excluded namespaces>]~~ .
<choice> :: orphans|wanted|valid|all .
<excluded namespaces> are optional, start each namespace with ! - Tag Plugin (tag component) 2007-01-16 par Esther Brunner
Displays links to categories the page belongs to - Tag Plugin (topic component) 2007-01-12 par Esther Brunner
Displays a list of wiki pages with a given category tag
