Différences

Ci-dessous, les différences entre deux révisions de la page.

--- wiki:syntaxe [Le 07/03/2017, 11:24] – [Blocs fichiers] privilégier file chemin/fichier bcag2
+++ wiki:syntaxe [Le 21/09/2026, 21:25] (Version actuelle) – fix lien interne krodelabestiole
@@ Ligne 1: / Ligne 1: @@
 {{tag>wiki}}
-----
+====== 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 [[:playground:playground|bac à sable]]. Les balises les plus simples sont facilement accessibles depuis la barre d'outils d'édition.
-====== Syntaxe de mise en page ======
+<note important>
+FIXME
-[[:wiki: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 [[:playground:playground|bac à sable]]. Les balises les plus simples sont facilement accessibles depuis la barre d'outils d'édition.
+Le format [[wpfr>markdown]] arrive sur DokuWiki, et celui-ci est beaucoup plus simple et lisible !
+</note>
 Afin de faciliter la création et la modification des pages de la documentation nous recommandons l'utilisation de nos [[:wiki:modele|modèles]], et des [[:wiki: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 [[:wiki:tags]] à mettre en début de toutes nos pages.
+===== Boutons en haut de la zone d'écriture du texte =====
+Les chapitres suivants montrent les détails de la syntaxe, mais on n'est pas obligé de tout écrire : il y a des boutons en haut de la zone (champ ?) d'écriture du texte qui facilitent l’écriture.
 ===== Mise en forme de texte simple =====
@@ Ligne 14: / Ligne 21: @@
 DokuWiki permet des textes en //italique//, **gras**, __souligné__ et ''à espace fixe'' (pour du code en ligne).
 Bien sûr, vous pouvez aussi les **__//''combiner''//__**.
+<note warning>
+Cependant sur le [[:web]], du texte souligné correspond à des //liens//. En pratique on ne devrait donc à-peu-près jamais utiliser ce formatage ! Le bouton a d'ailleurs été volontairement supprimé de l'interface d'édition.
+Pour plus d'information, voir les [[:wiki:recommandations]].
+</note>
 <code>
@@ Ligne 20: / Ligne 33: @@
 Bien sûr, vous pouvez aussi les **__//''combiner''//__**
 </code>
 Vous pouvez aussi utiliser <sub>indice</sub> et <sup>exposant</sup>.
 <code>Vous pouvez aussi utiliser <sub>indice</sub> et <sup>exposant</sup>.</code>
 De plus, vous pouvez marquer du contenu comme <del>supprimé</del>.
 <code>De plus, vous pouvez marquer du contenu comme <del>supprimé</del>.</code>
+<note warning>
+Le wiki n'étant pas une copie d'école, il est très rare que du texte rayé soit désirable et pertinent, en tout cas pas sur le long terme. Or aucun autre contributeur ou administrateur ne devrait être censé passer derrière ce que chacun écrit.
-**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.
+Mieux vaut donc simplement //supprimer// le contenu obsolète ! Les anciennes versions de chaque page sont de toute façon toujours sauvegardées et restent accessibles.
-Voilà du texte avec des sauts de ligne\\ remarquez que les
+Le bouton a d'ailleurs été volontairement supprimé de l'interface d'édition.
-deux antislashes sont seulement reconnus en fin de ligne\\
-ou suivis par\\ un espace ; \\cela arrive sinon.
-<code>Voilà du texte avec des sauts de ligne\\ remarquez que les
+Pour plus d'information, voir les [[:wiki:recommandations]].
-deux antislashes sont seulement reconnus en fin de ligne\\
+</note>
-ou suivis par\\ un espace ; \\Voici le résultat dans le cas contraire !.</code>
-Vous devriez forcer des sauts de ligne uniquement si c'est **réellement** nécessaire.
+**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.
+Voici 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 !
+<code>
+Voici 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 !
+</code>
+Ne forcer des sauts de ligne que quand strictement nécessaire : pour un nouveau paragraphe, il suffit de sauter une ligne.
 ===== Éléments de mise en page =====
@@ Ligne 54: / Ligne 75: @@
   === Titre niveau 4 ===
   == Titre niveau 5 ==
+Ces niveaux correspondent aux balises ''<h1>'' à ''<h5>'' du langage [[wpfr>Hypertext_Markup_Language|HTML]] (voir [[https://developer.mozilla.org/fr/docs/Web/HTML/Reference/Elements/Heading_Elements|Heading Elements]]).
 ==== Les listes ====
@@ Ligne 80: / Ligne 103: @@
   - Et voilà
 </code>
 ==== Les citations ====
@@ Ligne 158: / Ligne 180: @@
   |gauche        |       droite|    centré     |
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
 ===== Les 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 : [[http://www.google.fr|Ce lien pointe vers google]]. Les adresses email telles que celle-ci : <toto@foo.bar> sont également reconnues.
+<note>Si vous ne donnez pas de noms aux liens et que ceux-ci contiennent des caractères inhabituelles, tel que des paranthèses, ils pourraient être mal reconnus.</note>
 <code>
@@ Ligne 179: / Ligne 199: @@
 reconnues.
 </code>
 ==== Internes ====
@@ Ligne 187: / Ligne 206: @@
 <code>
 Les liens internes sont créés en utilisant les crochets. Vous pouvez
-soit juste donner un [[Nom de page]] ou utiliser un
+soit juste donner un [[:Nom de page]] ou utiliser un
-[[nom de page|titre]]. Les pages (//Nom de page//) wiki sont converties
+[[: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//.
@@ Ligne 216: / Ligne 235: @@
   * Lorsque le titre d'une section est modifié, alors le //bookmark// change aussi. Donc ne comptez pas trop sur les  liens de section.
 </note>
 ==== Interwiki ====
-DokuWiki propose les liens [[doku>interwiki|Interwiki]]. Ce sont des liens rapides vers d'autres Wikis. Par exemple:
+DokuWiki propose les liens [[doku>interwiki|Interwiki]]. Ce sont des liens rapides vers d'autres Wikis. Par exemple :
+  * [[gufr>index]] accès à http://guide.ubuntu-fr.org
   * [[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/
-  * [[man>commande]] page de manuel en anglais de la commande sur http://man:cx
+  * [[man>commande]] page de manuel en anglais de la commande sur http://man.cx
+  * [[du>accueil]]  accès à  https://help.ubuntu.com/community/
+  * [[wu>accueil]] accès à  https://wiki.ubuntu.com/
+  * [[apps>cat]]  accès à https://apps.ubuntu.com
 <code>
 DokuWiki propose les liens [[doku>wiki:interwiki|Interwiki]].
-Ce sont des liens rapides vers d'autres Wikis. Par exemple:
+Ce sont des liens rapides vers d'autres Wikis. Par exemple :
+  * [[gufr>index]] accès à http://guide.ubuntu-fr.org
   * [[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/
-  * [[man>commande]] page de manuel en anglais de la commande sur http://man:cx
+  * [[man>commande]] page de manuel en anglais de la commande sur http://man.cx
+  * [[du>accueil]]  accès à  https://help.ubuntu.com/community/
+  * [[wu>accueil]] accès à  https://wiki.ubuntu.com/
+  * [[apps>cat]]  accès à https://apps.ubuntu.com
 </code>
 ==== Liens images ====
@@ Ligne 246: / Ligne 271: @@
 <code>[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]</code>
-NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom du lien.
+<note>La mise en forme image est la seule syntaxe de mise en forme acceptée comme nom du lien.</note>
 ==== Redirection ====
@@ Ligne 263: / Ligne 286: @@
 <note importante>**N.B. :** Les redirections en cascade ont été désactivées, car elles sont dangereuses (risque de boucle).</note>
 ===== Les insertions d'éléments de syntaxe =====
@@ Ligne 272: / Ligne 291: @@
 ==== Les images ====
-<note help>Pour les images, des informations supplémentaires sont disponibles sur la [[:wiki:ajout_image|page d'ajout des images]].</note>
+<note tip>Pour les images, des informations supplémentaires sont disponibles sur la [[:wiki:ajout_image|page d'ajout des images]].</note>
 Vous pouvez inclure des [[doku>images]] externes et internes entre des accolades doubles. Vous pouvez spécifier leur taille en pixel après un ? (facultatif).
@@ Ligne 279: / Ligne 298: @@
 {{wiki:dokuwiki-128.png}}
 Redimension à une largeur donnée :
 {{wiki:dokuwiki-128.png?50}}
@@ Ligne 285: / Ligne 304: @@
 {{wiki:dokuwiki-128.png?200x50}}
 Image externe redimensionnée :
-{{http://de3.php.net/images/php.gif?200x50}}
+{{http://php.net/images/php.gif?200x50}}
   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}}
+  {{http://php.net/images/php.gif?200x50}}
@@ Ligne 318: / Ligne 337: @@
 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.
+=== Mode clair / sombre ===
+Une modification propre à ubuntu-fr a été implémentée : on peut utiliser les descriptions ''%%|Icône light}}%%'' et ''%%|Icône dark}}%%'' pour afficher une image respectivement en mode clair uniquement ou en mode sombre uniquement.
+Voir le logo GNOME en exemple : [[:GNOME]].
 ==== 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) :
+En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale (il faut sauter une ligne avant pour que cela fonctionne) :
 ----
@@ Ligne 352: / Ligne 377: @@
 ==== Typographie ====
-[[DokuWiki]] peut convertir de simples caractères de texte brut en leurs entités typographiques correctes. Voici un exemple des caractères reconnus.
+[[: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 'It's a man's world'..."
 <code>
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
-"He thought 'It's a man's world'..."
 </code>
-NB : Ces conversions peuvent être interdites dans le fichier de configuration.
+<note>
+Certains remplacements de caractères sont spécifiques au wiki ubuntu-fr :
+  * ''%%\_%%'' est remplacé par une [[wpfr>espace insécable]] (qui empêche le retour à la ligne entre deux mots).
+</note>
 ==== Notes de pied de page ====
@@ Ligne 383: / Ligne 408: @@
 ==== Texte non analysé ====
-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 ''<nowiki>%%</nowiki>''.
+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>..</nowiki>'' ou encore plus simple, avec des doubles caractères pourcent ''<nowiki>%%</nowiki>..<nowiki>%%</nowiki>''.
-<nowiki>
+Exemples :
-Voici du texte qui contient des adresses comme ceci :
-http://www.spiltbrain.org et de la **mise en forme**, mais rien ne se passe.
-</nowiki>
-<nowiki>
+  * Exemple 1 : le tag ''nowiki'' fait que <nowiki>**ce texte n'est pas rendu en gras**</nowiki>, malgré les astérisques.
-http://www.google.fr
-</nowiki>
+  * Exemple 2 : le tag ''nowiki'' fait que l'URL <nowiki>http://www.google.fr</nowiki> n'est pas rendue comme un lien.
+  * Exemple 3 :
+    * 3a : KO : ''--force'' : du code //inline// avec un double trait d'union qui perd son double trait d'union au rendu ;
+    * 3b : OK : ''%%--%%force'' : du code //inline// avec un double trait d'union qui ne perd pas son double trait d'union au rendu, grâce à l'opérateur ''<nowiki>%%</nowiki>'' ;
 ==== Blocs de code ====
-Pour représenter du code source ou des commandes à taper dans un [[:terminal]] on utilise la balise ''code''.
+Pour représenter du code source ou des commandes à taper dans un [[:terminal]] on utilise la balise ''%%<code>%%'' (refermé par la balise ''%%</code>%%'').
 <code>
@@ Ligne 401: / Ligne 427: @@
 </code>
+[[:DokuWiki]] peut surligner du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter
-[[DokuWiki]] peut surligner du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter
 [[http://qbnz.com/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>%%''.
@@ Ligne 426: / Ligne 451: @@
 Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avez cité un fichier.
 </file>
-ou mieux encore ** //file - chemin/fichier// **
+ou mieux encore **//file - chemin/fichier//**
 <file - /etc/fichier>
 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!
@@ Ligne 497: / Ligne 522: @@
 </code>
+==== Les boîtes ====
+Pour aller plus loin que les notes encadrées, nous avons également un type boite très paramétrable, ce qui lui permet de pouvoir faire de belles choses, mais également des choses beaucoup moins agréables. Son utilisation sera contrôlée. N'en abusez pas.
+<note important>La prise en compte des styles a été restreinte sur ubuntu-fr pour garantir l'homogénéité graphique du site.</note>
-==== Les boîtes ====
+<box>Une boîte simple</box>
-Pour aller plus loin que les notes encadrées, nous avons également un type boite très paramétrable, ce qui lui permet de pouvoir faire de belles choses, mais également des choses beaucoup moins agréables. Son utilisation sera contrôlée. N'en abusez pas.
+<code><box>Une boîte simple</box></code>
-<box> Une boîte simple </box>
+La syntaxe complète :
-<code><box> Une boîte simple </box></code>
+<code><box 75% round orange|Une boite complète>Texte de contenu</box|Avec une légende></code>
+qui peut donner quelque chose comme ça :
-La syntaxe complète qui peut donner quelque chose comme ça :
 <box 75% round orange|Une boite complète>Texte de contenu</box|Avec une légende>
-**%%<box largeur classes couleurs | titre> Texte de contenu </box|légende>%%**
+Pour insérer du texte non formaté -- de type code -- ou pour afficher une page écran du terminal -- inclure des balises ''%%<file> texte non formaté </file>%%'' entre les balises ''box'' ; \\
+ce qui donne :
+<code><box 75% round orange|Une boite complète>
+<File>
+Texte de contenu
+</file>
+</box|Avec une légende>
+</code>
+Une page écran du terminal apparaîtra alors dans votre page de documentation, selon le modèle suivant:
+<box 75% round orange|Une boite complète>
+<file>
+message du terminal ou code source
+</file>
+</box|Avec une légende>
+''%%<box largeur classes couleurs | titre> Texte de contenu </box|légende>%%''
-  * largeur -- une largeur en em, px ou %
+  * largeur -- une largeur en ''em'', ''px'' ou ''%''
   * classes -- une ou plusieurs classes d'affichage parmi :
-    * round -- coins arrondis
+    * ''round'' -- coins arrondis
-    * blue -- thème bleu
+    * ''blue'' -- thème bleu
-    * red -- thème rouge
+    * ''red'' -- thème rouge
-    * green -- thème vert
+    * ''green'' -- thème vert
-    * orange -- thème orange
+    * ''orange'' -- thème orange
-    * left -- alignement à gauche
+    * ''left'' -- alignement à gauche
-    * right -- alignement à droite
+    * ''right'' -- alignement à droite
-  * couleurs — 1 à 4 couleurs en hex CSS ou en RGB (exemples #F00 #fcab94 rgb(255,255,0)). Si moins de 4 couleurs sont indiquées, la première est utilisée partout. Les couleurs agissent dans l'ordre sur les éléments suivants.
+  * couleurs -- 1 à 4 couleurs CSS en hexadécimal ou en RGB (exemples ''#F00'', ''#fcab94'', ou ''rgb(255,255,0)''). Si moins de 4 couleurs sont indiquées, la première est utilisée partout. Les couleurs agissent dans l'ordre sur les éléments suivants.
     * fond du contenu
     * fond du titre
@@ Ligne 526: / Ligne 572: @@
     * bordures
   * titre -- texte affiché au dessus du contenu de la boîte.
-  * légende — texte affiché en dessous du contenu de la boîte.
+  * légende -- texte affiché en dessous du contenu de la boîte.
 ===== Voir aussi =====
-  * **(fr)** [[http://www.dokuwiki.org/fr:syntax|Guide de la syntaxe sur www.dokuwiki.org]]
+  * [[https://www.dokuwiki.org/fr:wiki:syntax|Guide officiel de la syntaxe DokuWiki]]
-  * **(en)** [[http://www.dokuwiki.org/syntax|Guide de la syntaxe sur www.dokuwiki.org]]
+  * [[:wiki:Recommandations]]

Différences

Outils de la page

Outils du site

Divers