====== 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 :

===== Conventions =====

<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.
</note>

==== Pour une commande utilisateur et sa sortie ====

Pour indiquer la commande qui doit être passée en tant que simple utilisateur, utilisez les balises :
<code>[code=user]ma_commande[/code]
[code]sa sortie[/code]</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>

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.

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 une commande root et sa sortie ====

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>

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>

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>

<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)

Donc, c'est au choix:
<code root>ls /root</code>
<code user>sudo ls /root</code>
<code user>su -c 'ls /root'</code>
</note>

==== Les fichiers et langages de programmation ====

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>

Ce qui donne sur le forum:
<code apt_sources>deb http://ftp.debian.org/debian jessie main contrib non-free</code>

Même chose pour « apt_preferences »

Il en va de même avec les langages de programmation (perl, bash, C, python, etc.):

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 =====

DF ne reculant devant aucun sacrifice, il est dit et entendu ici que tout membre DF qui indiquera sur le forum par copier-coller le lien vers cette page ci-dessous :
 
  * %%[i][url=http://debian-facile.org/atelier:coloration-syntaxique]Voir le tuto : Le code, ça pique moins les yeux en couleur[/url][/i]%%
 
aura pour récompense **1 point chocolat DF** de plus dans sa besace ! (//en plus de l'économie en lunettes et autres soins ophtalmologiques que sa contribution lui aura procuré//) :-D

//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>