Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente | ||
wiki:syntaxe [Le 21/03/2015, 14:27] – [Texte non analysé] MicP | wiki:syntaxe [Le 20/05/2020, 21:50] (Version actuelle) – correction lien erroné Arverne73 | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
+ | {{tag> | ||
+ | |||
+ | ---- | ||
+ | |||
+ | |||
+ | ====== Syntaxe de mise en page ====== | ||
+ | |||
+ | [[: | ||
+ | |||
+ | Afin de faciliter la création et la modification des pages de la documentation nous recommandons l' | ||
+ | |||
+ | ===== Bouton de la fenêtre d' | ||
+ | les chapitres suivants montrent les details de la syntaxe , mais on n'est pas obligé de tout écrire : y a des bouton en haut de la fenêtre qui facillitent l’écriture | ||
+ | ===== Mise en forme de texte simple ===== | ||
+ | |||
+ | DokuWiki permet des textes en // | ||
+ | Bien sûr, vous pouvez aussi les **__//'' | ||
+ | |||
+ | < | ||
+ | DokuWiki permet des textes en // | ||
+ | '' | ||
+ | Bien sûr, vous pouvez aussi les **__//'' | ||
+ | </ | ||
+ | |||
+ | |||
+ | Vous pouvez aussi utiliser < | ||
+ | < | ||
+ | |||
+ | |||
+ | De plus, vous pouvez marquer du contenu comme < | ||
+ | < | ||
+ | |||
+ | |||
+ | **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 une 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\\ une espace ; \\Voici le résultat dans le cas contraire !. | ||
+ | |||
+ | < | ||
+ | deux antislashes sont seulement reconnus en fin de ligne\\ | ||
+ | ou suivis par\\ une espace ; \\Voici le résultat dans le cas contraire !.</ | ||
+ | |||
+ | Vous devriez forcer des sauts de ligne uniquement si c'est **réellement** nécessaire. | ||
+ | |||
+ | |||
+ | ===== Éléments de mise en page ===== | ||
+ | |||
+ | ==== Les titres ==== | ||
+ | |||
+ | Vous pouvez utiliser jusqu' | ||
+ | |||
+ | ====== Titre de la page ====== | ||
+ | ===== Titre niveau 2 ===== | ||
+ | ==== Titre niveau 3 ==== | ||
+ | === Titre niveau 4 === | ||
+ | == Titre niveau 5 == | ||
+ | |||
+ | ==== Les 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' | ||
+ | - 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' | ||
+ | - Et voilà | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Les 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 ! | ||
+ | >>> | ||
+ | |||
+ | Je pense que nous devrions le faire | ||
+ | > Non nous ne devrions pas | ||
+ | >> Eh bien, je pense que si | ||
+ | > Vraiment ? | ||
+ | >> Oui ! | ||
+ | >>> | ||
+ | |||
+ | ==== Les 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\\ passage à la ligne | Ligne 2 Col 3 | | ||
+ | |||
+ | Les lignes de tableau doivent commencer et terminer avec un //pipe// '' | ||
+ | |||
+ | Les deux barres obliques ' | ||
+ | |||
+ | ^ 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\\ passage à la ligne | Ligne 2 Col 3 | | ||
+ | |||
+ | Pour fusionner des cellules horizontalement (// | ||
+ | |||
+ | 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 (' | ||
+ | |||
+ | | ^ 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 | | ||
+ | |||
+ | Vous pouvez aussi fusionner les cellules verticalement : | ||
+ | | ^ Titre 1 ^ Titre 2 ^ | ||
+ | ^ Titre 3 | Lignes fusionnées | ||
+ | ^ Titre 4 | ::: | | | ||
+ | ^ Titre 5 | ::: | Ligne 2 Col 3 | | ||
+ | |||
+ | | ^ Titre 1 ^ Titre 2 ^ | ||
+ | ^ Titre 3 | Lignes fusionnées | ||
+ | ^ Titre 4 | ::: | | | ||
+ | ^ Titre 5 | ::: | Ligne 2 Col 3 | | ||
+ | |||
+ | Vous pouvez également aligner le contenu du tableau. Ajoutez simplement au moins deux espaces blancs à l' | ||
+ | |||
+ | ^ Tableau avec alignement | ||
+ | | droite| | ||
+ | |gauche | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | Voici à quoi ressemble le code source : | ||
+ | |||
+ | ^ Tableau avec alignement | ||
+ | | droite| | ||
+ | |gauche | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | |||
+ | |||
+ | ===== Les Liens ===== | ||
+ | |||
+ | DokuWiki propose plusieurs moyens de créer des liens. | ||
+ | |||
+ | |||
+ | ==== Externes ==== | ||
+ | |||
+ | Les liens externes sont reconnus automatiquement : http:// | ||
+ | |||
+ | Vous pouvez aussi donner des noms aux liens : [[http:// | ||
+ | < | ||
+ | |||
+ | < | ||
+ | Les liens externes sont reconnus automatiquement : http:// | ||
+ | ou simplement www.google.fr - Vous pouvez aussi donner des noms aux | ||
+ | liens : [[http:// | ||
+ | adresses email telles que celle-ci : < | ||
+ | reconnues. | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Internes ==== | ||
+ | |||
+ | 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 // | ||
+ | |||
+ | < | ||
+ | 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 // | ||
+ | </ | ||
+ | |||
+ | |||
+ | Vous pouvez utiliser les [[: | ||
+ | |||
+ | < | ||
+ | Vous pouvez utiliser les [[: | ||
+ | utilisateurs en utilisant les //deux points// dans le nom de page | ||
+ | //Nom de page//, ce qui donne [[: | ||
+ | </ | ||
+ | |||
+ | Pour plus de détails sur les catégories (// | ||
+ | |||
+ | |||
+ | 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 [[syntaxe# | ||
+ | |||
+ | Ce lien renvoie vers [[syntaxe# | ||
+ | |||
+ | < | ||
+ | * Les liens vers des [[: | ||
+ | * Nous n' | ||
+ | * Lorsque le titre d'une section est modifié, alors le // | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Interwiki ==== | ||
+ | |||
+ | DokuWiki propose les liens [[doku> | ||
+ | * [[gufr> | ||
+ | * [[wp> | ||
+ | * [[wpfr> | ||
+ | * [[google> | ||
+ | * [[pu> | ||
+ | * [[man> | ||
+ | * [[du> | ||
+ | * [[wu> | ||
+ | * [[apps> | ||
+ | |||
+ | < | ||
+ | DokuWiki propose les liens [[doku> | ||
+ | Ce sont des liens rapides vers d' | ||
+ | * [[gufr> | ||
+ | * [[wp> | ||
+ | * [[wpfr> | ||
+ | * [[google> | ||
+ | * [[pu> | ||
+ | * [[man> | ||
+ | * [[du> | ||
+ | * [[wu> | ||
+ | * [[apps> | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ==== 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:// | ||
+ | |||
+ | < | ||
+ | |||
+ | 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> | ||
+ | |||
+ | exemple sur la page [[:tv]]: | ||
+ | |||
+ | ~~REDIRECT> | ||
+ | |||
+ | qui est la page http:// | ||
+ | |||
+ | <note importante> | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== Les insertions d' | ||
+ | |||
+ | ==== Les images ==== | ||
+ | |||
+ | <note help> | ||
+ | |||
+ | Vous pouvez inclure des [[doku> | ||
+ | |||
+ | Taille réelle : | ||
+ | {{wiki: | ||
+ | |||
+ | Redimension à une largeur donnée : | ||
+ | {{wiki: | ||
+ | |||
+ | Redimension à une largeur et une hauteur données : | ||
+ | {{wiki: | ||
+ | |||
+ | Image externe redimensionnée : | ||
+ | {{http:// | ||
+ | |||
+ | Taille réelle : | ||
+ | {{wiki: | ||
+ | Redimension à une largeur donnée : | ||
+ | {{wiki: | ||
+ | Redimension à une largeur et une hauteur données : | ||
+ | {{wiki: | ||
+ | Image externe redimensionnée : | ||
+ | {{http:// | ||
+ | |||
+ | |||
+ | En utilisant des espaces à gauche ou à droite, vous pouvez choisir l' | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | {{wiki: | ||
+ | {{ wiki: | ||
+ | |||
+ | Bien sûr, vous pouvez aussi ajouter un titre (affiché comme une bulle d'info par la plupart des navigateurs). | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | Si vous spécifiez un nom de fichier (externe ou interne) qui n'est pas une image ('' | ||
+ | |||
+ | |||
+ | ==== Un trait de séparation ==== | ||
+ | En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale (Il faut sauter une ligne avant et après pour que cela fonctionne) : | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Émoticônes (smileys) ==== | ||
+ | |||
+ | DokuWiki transforme les [[wpfr> | ||
+ | |||
+ | * 8-) %% 8-) %% | ||
+ | * 8-O %% 8-O %% | ||
+ | * :-( %% :-( %% | ||
+ | * :-) %% :-) %% | ||
+ | * =) %% =) %% | ||
+ | * :-/ %% :-/ %% | ||
+ | * :-\ %% :-\ %% | ||
+ | * :-? %% :-? %% | ||
+ | * :-D %% :-D %% | ||
+ | * :-P %% :-P %% | ||
+ | * :-O %% :-O %% | ||
+ | * :-X %% :-X %% | ||
+ | * :-| %% :-| %% | ||
+ | * ;-) %% ;-) %% | ||
+ | * ^_^ %% ^_^ %% | ||
+ | * :?: %% :?: %% | ||
+ | * :!: %% :!: %% | ||
+ | * LOL %% LOL %% | ||
+ | * FIXME %% FIXME %% | ||
+ | * DELETEME %% DELETEME %% | ||
+ | |||
+ | |||
+ | ==== 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 (c) (tm) (r) | ||
+ | "He thought ' | ||
+ | |||
+ | < | ||
+ | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
+ | "He thought ' | ||
+ | </ | ||
+ | |||
+ | NB : Ces conversions peuvent être interdites dans le fichier de configuration. | ||
+ | |||
+ | |||
+ | ==== Notes de pied de page ==== | ||
+ | |||
+ | Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page)) en utilisant 2 doubles parenthèses. | ||
+ | |||
+ | < | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== Les éléments blocs ===== | ||
+ | Ces éléments permettent de faire ressortir du texte important, de mettre en valeur du code source ou de juste présenter des informations importantes différemment. | ||
+ | |||
+ | |||
+ | |||
+ | ==== Texte non analysé ==== | ||
+ | |||
+ | Pour laisser l' | ||
+ | |||
+ | < | ||
+ | Voici du texte qui contient des adresses comme ceci : | ||
+ | http:// | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | http:// | ||
+ | </ | ||
+ | ==== Blocs de code ==== | ||
+ | Pour représenter du code source ou des commandes à taper dans un [[: | ||
+ | |||
+ | < | ||
+ | Ceci est du code préformaté, | ||
+ | <-ceci | ||
+ | </ | ||
+ | |||
+ | |||
+ | [[DokuWiki]] peut surligner du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter | ||
+ | [[http:// | ||
+ | |||
+ | <code java> | ||
+ | /** | ||
+ | * La classe HelloWorldApp implemente une application qui | ||
+ | * affiche simplement "Hello World!" | ||
+ | */ | ||
+ | class HelloWorldApp { | ||
+ | public static void main(String[] args) { | ||
+ | System.out.println(" | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Les identificateurs de langage suivants sont actuellement reconnus : //4cs, abap, actionscript-french, | ||
+ | |||
+ | |||
+ | ==== Blocs fichiers ==== | ||
+ | Pour représenter le contenu de fichier on utilise la balise '' | ||
+ | |||
+ | < | ||
+ | Ceci est pratiquement la même chose, mais vous pouvez l' | ||
+ | </ | ||
+ | ou mieux encore ** //file - chemin/ | ||
+ | <file - / | ||
+ | Comme cela il n'y a pas d’ambiguïté sur le fichier à modifier, à éviter si ça se répète trop, on peut le mettre alors que sur le premier extrait! | ||
+ | </ | ||
+ | |||
+ | Cela permet de télécharger le fichier ainsi inséré, et si disponible, ajouter la coloration syntaxique, de cette façon : | ||
+ | < | ||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </ | ||
+ | |||
+ | Note : pour ne pas colorer le code, remplacer le nom du langage par un **-**. | ||
+ | |||
+ | |||
+ | ==== Notes encadrées ==== | ||
+ | |||
+ | Pour ajouter un encadré avec une icône, il faut suivre la syntaxe suivante : | ||
+ | |||
+ | < | ||
+ | Ceci est un exemple de note classique ou de remarque. | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | < | ||
+ | Ceci est un exemple de note classique ou de remarque. | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <note tip> | ||
+ | Ceci est un exemple d' | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | <note tip> | ||
+ | Ceci est un exemple d' | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <note help> | ||
+ | Ceci est un exemple d' | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | <note help> | ||
+ | Ceci est un exemple d' | ||
+ | </ | ||
+ | </ | ||
+ | <note important> | ||
+ | Ceci est un exemple de note importante. On l' | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | <note important> | ||
+ | Ceci est un exemple de note importante.On l' | ||
+ | </ | ||
+ | </ | ||
+ | <note warning> | ||
+ | Ceci est un exemple de warning. On l' | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | <note warning> | ||
+ | Ceci est un exemple de warning. On l' | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== Les boîtes ==== | ||
+ | Pour aller plus loin que les notes encadrées, nous avons également un type boite très paramétrable, | ||
+ | |||
+ | <box> Une boîte simple </ | ||
+ | < | ||
+ | |||
+ | La syntaxe complète : | ||
+ | < | ||
+ | |||
+ | qui peut donner quelque chose comme ça : | ||
+ | |||
+ | <box 75% round orange|Une boite complète> | ||
+ | |||
+ | si vous désirez insérer du texte non formaté — du type « page de code bash » ou pour afficher une page écran du terminal — on inclura des balises %%< | ||
+ | ce qui donne : | ||
+ | < | ||
+ | < | ||
+ | Texte de contenu | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | Une page écran du terminal apparaîtra alors dans votre page de documentation, | ||
+ | |||
+ | <box 75% round orange|Une boite complète> | ||
+ | < | ||
+ | message du terminal ou code source | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | **%%<box largeur classes couleurs | titre> Texte de contenu </ | ||
+ | |||
+ | * largeur -- une largeur en em, px ou % | ||
+ | * classes -- une ou plusieurs classes d' | ||
+ | * round -- coins arrondis | ||
+ | * blue -- thème bleu | ||
+ | * red -- thème rouge | ||
+ | * green -- thème vert | ||
+ | * orange -- thème orange | ||
+ | * left -- alignement à gauche | ||
+ | * right -- alignement à droite | ||
+ | * couleurs — 1 à 4 couleurs en hex CSS ou en RGB (exemples #F00 #fcab94 rgb(255, | ||
+ | * fond du contenu | ||
+ | * fond du titre | ||
+ | * fond du pourtour de la boîte | ||
+ | * bordures | ||
+ | * titre -- texte affiché au dessus du contenu de la boîte. | ||
+ | * légende — texte affiché en dessous du contenu de la boîte. | ||
+ | |||
+ | ===== Voir aussi ===== | ||
+ | |||
+ | * **(fr)** [[http:// | ||
+ | * **(en)** [[http:// | ||