Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
wiki:syntaxe [Le 21/03/2015, 14:27] MicP [Texte non analysé] |
wiki:syntaxe [Le 11/09/2022, 13:16] (Version actuelle) moths-art Suppression des espaces en fin de ligne (détecté et corrigé via le bot wiki-corrector (https://forum.ubuntu-fr.org/viewtopic.php?id=2067892) |
||
---|---|---|---|
Ligne 10: | Ligne 10: | ||
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. | 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. | ||
+ | ===== Bouton de la fenêtre d'écriture du texte===== | ||
+ | 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 ===== | ===== Mise en forme de texte simple ===== | ||
Ligne 30: | Ligne 32: | ||
- | **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. | + | **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 | Voilà du texte avec des sauts de ligne\\ remarquez que les | ||
deux antislashes sont seulement reconnus en fin de ligne\\ | deux antislashes sont seulement reconnus en fin de ligne\\ | ||
- | ou suivis par\\ un espace ; \\cela arrive sinon. | + | ou suivis par\\ une espace ; \\Voici le résultat dans le cas contraire !. |
<code>Voilà du texte avec des sauts de ligne\\ remarquez que les | <code>Voilà du texte avec des sauts de ligne\\ remarquez que les | ||
deux antislashes sont seulement reconnus en fin de ligne\\ | deux antislashes sont seulement reconnus en fin de ligne\\ | ||
- | ou suivis par\\ un espace ; \\cela arrive sinon.</code> | + | ou suivis par\\ une 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. | Vous devriez forcer des sauts de ligne uniquement si c'est **réellement** nécessaire. | ||
Ligne 48: | Ligne 50: | ||
Vous pouvez utiliser jusqu'à cinq niveaux différents 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 ''<nowiki>~~NOTOC~~</nowiki>'' dans le document. | Vous pouvez utiliser jusqu'à cinq niveaux différents 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 ''<nowiki>~~NOTOC~~</nowiki>'' dans le document. | ||
- | |||
- | ====== Titre de la page ====== | ||
- | ===== Titre niveau 2 ===== | ||
- | ==== Titre niveau 3 ==== | ||
- | === Titre niveau 4 === | ||
- | == Titre niveau 5 == | ||
====== Titre de la page ====== | ====== Titre de la page ====== | ||
Ligne 60: | Ligne 56: | ||
=== Titre niveau 4 === | === Titre niveau 4 === | ||
== Titre niveau 5 == | == Titre niveau 5 == | ||
+ | |||
==== Les listes ==== | ==== Les listes ==== | ||
Ligne 173: | Ligne 170: | ||
==== Externes ==== | ==== Externes ==== | ||
- | Les liens externes sont reconnus automatiquement : http://www.google.fr ou simplement www.google.fr | + | 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. | 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> | <code> | ||
Ligne 192: | Ligne 190: | ||
<code> | <code> | ||
Les liens internes sont créés en utilisant les crochets. Vous pouvez | 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 | automatiquement en minuscules, les caractères spéciaux ne sont pas | ||
autorisés ce qui donne //nom_de_page//. | autorisés ce qui donne //nom_de_page//. | ||
Ligne 225: | Ligne 223: | ||
==== Interwiki ==== | ==== 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) | * [[wp>wiki|définition des Wikis dans Wikipedia]] (version anglaise) | ||
* [[wpfr>wiki|définition des Wikis dans Wikipedia]] (version française) | * [[wpfr>wiki|définition des Wikis dans Wikipedia]] (version française) | ||
* [[google>Wiki]] liens vers une recherche Google. | * [[google>Wiki]] liens vers une recherche Google. | ||
* [[pu>dokuwiki]] liens vers une recherche sur http://packages.ubuntu.com/ | * [[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> | <code> | ||
DokuWiki propose les liens [[doku>wiki:interwiki|Interwiki]]. | 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) | * [[wp>wiki|définition des Wikis dans Wikipedia]] (version anglaise) | ||
* [[wpfr>wiki|définition des Wikis dans Wikipedia]] (version française) | * [[wpfr>wiki|définition des Wikis dans Wikipedia]] (version française) | ||
* [[google>Wiki]] liens vers une recherche Google. | * [[google>Wiki]] liens vers une recherche Google. | ||
* [[pu>dokuwiki]] liens vers une recherche sur http://packages.ubuntu.com/ | * [[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> | </code> | ||
+ | |||
Ligne 284: | Ligne 291: | ||
{{wiki:dokuwiki-128.png}} | {{wiki:dokuwiki-128.png}} | ||
- | Redimension à une largeur donnée : | + | Redimension à une largeur donnée : |
{{wiki:dokuwiki-128.png?50}} | {{wiki:dokuwiki-128.png?50}} | ||
Ligne 290: | Ligne 297: | ||
{{wiki:dokuwiki-128.png?200x50}} | {{wiki:dokuwiki-128.png?200x50}} | ||
- | Image externe redimensionnée : | + | Image externe redimensionnée : |
- | {{http://de3.php.net/images/php.gif?200x50}} | + | {{http://php.net/images/php.gif?200x50}} |
Taille réelle : | Taille réelle : | ||
{{wiki:dokuwiki-128.png}} | {{wiki:dokuwiki-128.png}} | ||
- | Redimension à une largeur donnée : | + | Redimension à une largeur donnée : |
{{wiki:dokuwiki-128.png?50}} | {{wiki:dokuwiki-128.png?50}} | ||
Redimension à une largeur et une hauteur données : | Redimension à une largeur et une hauteur données : | ||
{{wiki:dokuwiki-128.png?200x50}} | {{wiki:dokuwiki-128.png?200x50}} | ||
- | Image externe redimensionnée : | + | Image externe redimensionnée : |
- | {{http://de3.php.net/images/php.gif?200x50}} | + | {{http://php.net/images/php.gif?200x50}} |
Ligne 388: | Ligne 395: | ||
==== Texte non analysé ==== | ==== Texte non analysé ==== | ||
- | Pour empêcher l'analyseur d'interpréter les caractères de mise en forme d'un bloc de texte, encadrez ce bloc par des balises "%%<nowiki>%%" ou avec des paires de caractère "<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>''. |
- | ^ En mode édition ^ Affiché ^ | + | |
- | | <nowiki>rw-r---r--</nowiki> | rw-r---r-- | | + | Exemples : |
- | | %% <nowiki>rw-r---r--</nowiki>%% | %%rw-r---r--%% | | + | |
- | | <nowiki>%%rw-r---r--%%</nowiki> | %%rw-r---r--%% | | + | * Exemple 1 : le tag ''nowiki'' fait que <nowiki>**ce texte n'est pas rendu en gras**</nowiki>, malgré les astérisques. |
- | | %%https://doc.ubuntu-fr.org/wiki/syntaxe%% | https://doc.ubuntu-fr.org/wiki/syntaxe | | + | |
- | | <nowiki>%%https://doc.ubuntu-fr.org/wiki/syntaxe%%</nowiki> | %%https://doc.ubuntu-fr.org/wiki/syntaxe%% | | + | * Exemple 2 : le tag ''nowiki'' fait que l'URL <nowiki>http://www.google.fr</nowiki> n'est pas rendue comme un lien. |
- | | %%<nowiki>https://doc.ubuntu-fr.org/wiki/syntaxe</nowiki>%% | <nowiki>https://doc.ubuntu-fr.org/wiki/syntaxe</nowiki> | | + | |
- | | <nowiki>**Gras**</nowiki> | **Gras** | | + | * Exemple 3 : |
- | | %%<nowiki>**Gras**</nowiki>%% | <nowiki>**Gras**</nowiki> | | + | * 3a : KO : ''--force'' : du code //inline// avec un double trait d'union qui perd son double trait d'union au rendu ; |
- | | <nowiki>%%**Gras**%%</nowiki> | %%**Gras**%% | | + | * 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>'' ; |
- | | <nowiki>%%</nowiki>%%<nowiki>**Gras**</nowiki>%%<nowiki>%%</nowiki> | %%<nowiki>**Gras**</nowiki>%% | | + | |
- | | %%<nowiki>%%<nowiki>%%**Gras**%%</nowiki>%%</nowiki>%% | <nowiki>%%**Gras**%%</nowiki> | | + | |
==== Blocs de code ==== | ==== 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> | <code> | ||
Ligne 429: | Ligne 434: | ||
==== Blocs fichiers ==== | ==== Blocs fichiers ==== | ||
- | Pour représenter le contenu de fichier on utilise la balise ''file''. | + | Pour représenter le contenu de fichier on utilise la balise ''file'' |
<file> | <file> | ||
Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avez cité un fichier. | 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// ** | ||
+ | <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! | ||
</file> | </file> | ||
- | On peut également permettre de télécharger le fichier ainsi inséré, de cette façon : | + | Cela permet de télécharger le fichier ainsi inséré, et si disponible, ajouter la coloration syntaxique, de cette façon : |
<code> | <code> | ||
<file php myexample.php> | <file php myexample.php> | ||
Ligne 510: | Ligne 519: | ||
<code><box> Une boîte simple </box></code> | <code><box> Une boîte simple </box></code> | ||
- | La syntaxe complète qui peut donner quelque chose comme ça : | + | La syntaxe complète : |
+ | <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 : | ||
<box 75% round orange|Une boite complète>Texte de contenu</box|Avec une légende> | <box 75% round orange|Une boite complète>Texte de contenu</box|Avec une légende> | ||
+ | |||
+ | 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 %%<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>%%** | **%%<box largeur classes couleurs | titre> Texte de contenu </box|légende>%%** | ||
Ligne 534: | Ligne 564: | ||
===== Voir aussi ===== | ===== Voir aussi ===== | ||
- | * **(fr)** [[http://www.dokuwiki.org/fr:syntax|Guide de la syntaxe sur www.dokuwiki.org]] | + | * **(fr)** [[http://www.dokuwiki.org/fr:wiki:syntax|Guide de la syntaxe sur www.dokuwiki.org]] |
* **(en)** [[http://www.dokuwiki.org/syntax|Guide de la syntaxe sur www.dokuwiki.org]] | * **(en)** [[http://www.dokuwiki.org/syntax|Guide de la syntaxe sur www.dokuwiki.org]] | ||