L'icône rouge permet de télécharger chaque page du wiki visitée au format PDF et la grise au format ODT →

Différences

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

--- atelier:coloration-syntaxique [03/12/2013 19:10]
bendia [En prime]
+++ atelier:coloration-syntaxique [11/02/2021 16:07]
chalu [Conventions]
@@ Ligne 1: / Ligne 1: @@
 ====== Utiliser la coloration syntaxique dans le forum ======
+===== Préambule =====
+Pour aider les contributeurs, l'équipe des administrateurs de Debian Facile a mis en place des boutons préprogrammés.
+{{https://debian-facile.org/images/file-R82adf5387e07501c073333cd0e5f0d7b.png?800}}
 ===== Pourquoi =====
+Sans coloration syntaxique, il est pénible de s'y retrouver en lisant un long message avec tout mélangé : du texte, des commandes et des sorties de commandes.
+Pour aider les entraideurs, merci de respecter les conventions suivantes :
-**Premier exemple d'intervention sur le forum : **
+===== Conventions =====
-Voici une question très longue et très complexe au milieu de laquelle j'insère une commande\\
+<note tip>**Il est tout à fait possible** de mettre en page son message même après l'avoir publié. Il suffit de cliquer sur le bouton //Modifier// en bas à droite de votre message, puis d'insérer les balises avant et après les commandes et les retours.
-ls -l | egrep '[^.tex]$' \\
+</note>
-et vous pouvez constater que le retour n'est pas piqué des hannetons\\
-total 16 \\
--rw-r--r-- 1 user user 1243 févr.  6  2013 APropos \\
--rw-r--r-- 1 user user  731 févr.  5  2013 APropos~ \\
-drwxr-xr-x 4 user user 4096 sept. 25 18:37 src \\
-**Deuxième exemple d'intervention sur le forum : **
+==== Pour une commande utilisateur et sa sortie ====
-Voici une question très longue et très complexe au milieu de laquelle j'insère une commande
+Pour indiquer la commande qui doit être passée en tant que simple utilisateur, utilisez les balises :
-<code user>ls -l | egrep '[^.tex]$'</code>
+<code>[code=user]ma_commande[/code]
-et vous pouvez constater que le retour n'est pas piqué des hannetons
+[code]sa sortie[/code]</code>
-<code>total 16
--rw-r--r-- 1 user user 1243 févr.  6  2013 APropos
--rw-r--r-- 1 user user  731 févr.  5  2013 APropos~
-drwxr-xr-x 4 user user 4096 sept. 25 18:37 src</code>
+Soit, par exemple :
+<code>Voici le résultat de la commande :
+[code=user]ls -l /lib/systemd/[/code]
+[code]total 336
+drwxr-xr-x 6 root root  36864 mai   10 10:26 system
+-rwxr-xr-x 1 root root 300612 avril 17 16:37 systemd-udevd
+[/code]
+</code>
-Je vous laisse juger sur pièce de la lisibilité de ces 2 interventions ;-)
+Ce qui apparaîtra sur le forum comme :
+> Voici le résultat de la commande :
+> <code user>ls -l /lib/systemd/</code><code>total 336
+drwxr-xr-x 6 root root  36864 mai   10 10:26 system
+-rwxr-xr-x 1 root root 300612 avril 17 16:37 systemd-udevd
+</code>
+<note important>**Attention**: Ne pas commencer la commande par le prompt ''user@nom-machine:dossier$'' ni même par une version raccourcie.
-===== Comment =====
+Pour indiquer que l'on est dans un dossier particulier, il suffit de l'indiquer avant, ou de commencer la première ligne par ''cd'':
+<code user>cd ~/.config/
+du -h --maxdepth=1</code>
+</note>
-Pour indiquer une commande qui doit être passée en tant que simple utilisateur, utilisez les balises
+==== Pour une commande root et sa sortie ====
-<code>[code=user]ma_commande[/code]</code>
+Pour indiquer la commande qui doit être passée en tant que [[doc:systeme:superutilisateur|super-utilisateur]], même chose, en remplaçant « user » par « root » :
+<code>[code=root]ma_commande[/code]
+[code]sa sortie[/code]</code>
-Pour indiquer une commande qui doit être passée en tant que [[doc:systeme:superutilisateur|super-utilisateur]], utilisez les balises
+Soit, par exemple:
+<code>Voici le résultat de la commande :
+[code=root]ls -l /var/log/apache2/[/code]
+[code]total 336
+-rwxr-xr-x 1 root root  36864 mai   10 10:26 access.log
+-rwxr-xr-x 1 root root 300612 mai   10 16:37 error.log
+[/code]
+</code>
-<code>[code=root]ma_commande[/code]</code>
+Ce qui apparaîtra sur le forum comme :
+> Voici le résultat de la commande :
+> <code root>ls -l /var/log/apache2/</code><code>total 336
+-rwxr-xr-x 1 root root  36864 mai   10 10:26 access.log
+-rwxr-xr-x 1 root root 300612 mai   10 16:37 error.log
+</code>
-Pour indiquer qu'il s'agit d'une entrée de //[[doc:systeme:apt:sources.list|sources.list]]//, utilisez les balises
+<note important>**Attention**: dans la commande ''sudo ls /root'', le shell est a priori un shell utilisateur simple (sans quoi, il ne serait pas nécessaire de faire sudo)
-<code>[code=apt_sources]deb entree_sources.list[/code]</code>
+Donc, c'est au choix:
+<code root>ls /root</code>
+<code user>sudo ls /root</code>
+<code user>su -c 'ls /root'</code>
+</note>
-Pour indiquer le retour d'une commande, utilisez simplement les balises
+==== Les fichiers et langages de programmation ====
-<code>[code]Le retour de ma commande[/code]</code>
+Il est également possible d'activer la coloration syntaxique pour différents types de fichiers.
+Exemple pour indiquer un extrait de //[[doc:systeme:apt:sources.list|sources.list]]//, utilisez le code « apt_sources » :
+Soit, par exemple:
+<code>[code=apt_sources]deb http://ftp.debian.org/debian jessie main contrib non-free[/code]</code>
-P.S. : Cela supporte même des tas d'autres langages de programmation. Il suffit en général de faire
+Ce qui donne sur le forum:
-<code>[code=langage]code[/code]</code>
+<code apt_sources>deb http://ftp.debian.org/debian jessie main contrib non-free</code>
-Merci à **captnfab** qui a codé ça 8-)
-===== Utilisation =====
+Même chose pour « apt_preferences »
-Il est tout à fait possible de mettre en page son message même après l'avoir publié. Il suffit de cliquer sur le bouton //Modifier// en bas à droite de votre message, puis d'insérer les balises avant et après les commandes et les retours.
+Il en va de même avec les langages de programmation (perl, bash, C, python, etc.):
-===== En prime =====
+Il suffit (en général) de faire :
+<code>[code=langage]code[/code]</code>
+Pour obtenir la distinction de leurs colorations particulières.
+===== La prime =====
-Tout membre DF qui indiquera le lien vers cette page
+DF ne reculant devant aucun sacrifice, il est dit et entendu ici que tout membre DF qui indiquera sur le forum par copie/colle le lien vers cette page ci-dessous :
-  * ''%%[i][url=http://wiki.debian-facile.org/atelier:coloration-syntaxique]Le code, ça pique moins les yeux en couleur[/url][/i]%%''
+  * %%[i][url=http://debian-facile.org/atelier:coloration-syntaxique]Voir le tuto : Le code, ça pique moins les yeux en couleur[/url][/i]%%
-sera récompensé par **1 point chocolat DF** en plus de l'économie en lunettes et autre soins ophtalmologiques que sa contribution lui aura procurée :-D
+aura pour récompense **1 point chocolat DF** de plus dans sa besace ! (//en plus de l'économie en lunettes et autre soins ophtalmologiques que sa contribution lui aura procurée//) :-D
-//Petit rappel : il faut **1000** points pour prétendre au carré de chocolat, et c'est Jojo le gourmand  qui tient les comptes// LOL
+//Petit rappel annexe : il faut **1000** points pour prétendre au carré de chocolat, et c'est Jojo le gourmand  qui tient les comptes// LOL
 <note warning>Afin d'éviter de privilégier la forme sur le fond, le point chocolat ne sera attribué **qu'une seule fois** par discussion</note>

atelier/coloration-syntaxique.txt · Dernière modification: 11/02/2021 16:11 par chalu

Debian-facile

Différences

Pied de page des forums