Debian
Debian-France
Debian-Facile
Debian-fr.org
Forum-Debian.fr
Debian ?
Communautés
Vous n'êtes pas identifié(e).
L'icône rouge permet de télécharger chaque page du wiki visitée au format
PDF et la grise au format ODT →
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 Prochaine révision Les deux révisions suivantes | ||
|
atelier:coloration-syntaxique [01/02/2014 14:01] bendia [Utilisation] |
atelier:coloration-syntaxique [10/05/2015 14:24] captnfab [Conventions] |
||
|---|---|---|---|
| Ligne 3: | Ligne 3: | ||
| ===== Pourquoi ===== | ===== Pourquoi ===== | ||
| - | Exemple d'un post sur le forum : | + | 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 : | ||
| - | ==== Sans les balises code ==== | + | ===== Conventions ===== |
| - | Ici, la question longue et complexe (notez qu'elle peut être également brève et simple ;-) ) à la suite de laquelle j'insère la commande qui suit :\\ | + | ==== Pour une commande utilisateur et sa sortie ==== |
| - | ls -l | egrep '[^.tex]$' \\ | + | |
| - | et voici le retour 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 \\ | + | |
| - | ==== Avec les balises code ==== | + | 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> | ||
| - | Ici, la question longue et complexe (notez qu'elle peut être également brève et simple ;-) ) à la suite de laquelle j'insère la commande qui suit : | + | Soit, par exemple : |
| - | <code user>ls -l | egrep '[^.tex]$'</code> | + | <code>Voici le résultat de la commande : |
| - | et voici le retour pas piqué des hannetons : | + | [code=user]ls -l /lib/systemd/[/code] |
| - | <code>total 16 | + | [code]total 336 |
| - | -rw-r--r-- 1 user user 1243 févr. 6 2013 APropos | + | drwxr-xr-x 6 root root 36864 mai 10 10:26 system |
| - | -rw-r--r-- 1 user user 731 févr. 5 2013 APropos~ | + | -rwxr-xr-x 1 root root 300612 avril 17 16:37 systemd-udevd |
| - | drwxr-xr-x 4 user user 4096 sept. 25 18:37 src</code> | + | [/code] |
| + | </code> | ||
| - | Je vous laisse juger sur pièce de la lisibilité de ces 2 interventions \\ | + | Ce qui apparaîtra sur le forum comme : |
| - | //Etonnant, non !// m( | + | > 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> | ||
| - | ==== Conclusion ==== | + | <note important>**Attention**: Ne pas commencer la commande par le prompt ''user@nom-machine:dossier$'' ni même par une version raccourcie. |
| - | Vous pouvez constater que de prendre la peine de séparer vos //commentaires libres// des //balises commande// et des //balises de retour//, augmente considérablement la lisibilité de vos interventions dans les posts du forum ! | + | 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> | ||
| - | <note important>Aidez le forum tout entier en les utilisant systématiquement et à bon escient !</note> | + | ==== Pour une commande root et sa sortie ==== |
| - | //Et pis ça réjouira grandement le //**captnfab**// qui a eu la gentillesse de coder tout ça de ses petits doigts glacés par les pizza congelées dont il se repaît quotidiennement !// 8-) | + | 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> | ||
| - | ===== Mode d'emploi ===== | + | Soit, par exemple: |
| + | <code>Voici le résultat de la commande : | ||
| + | [code=user]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> | ||
| - | ==== Les commandes ==== | + | 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> | ||
| - | === user === | + | <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) |
| - | Pour indiquer la commande qui doit être passée en tant que simple utilisateur, utilisez les balises : | + | Donc, c'est au choix: |
| - | <code>[code=user]ma_commande[/code]</code> | + | <code root>ls /root</code> |
| + | <code user>sudo ls /root</code> | ||
| + | <code user>su -c 'ls /root'</code> | ||
| + | </note> | ||
| - | Soit pour l'exemple précédent : | + | ==== Les fichiers et langages de programmation ==== |
| - | <code>[code=userls -l | egrep '[^.tex]$'[/code]</code> | + | |
| - | === root === | + | Il est également possible d'activer la coloration syntaxique pour différents type de fichiers. |
| + | Exemple pour indiquer une extrait de //[[doc:systeme:apt:sources.list|sources.list]]//, utilisez le code « apt_sources » : | ||
| - | Pour indiquer la commande qui doit être passée en tant que [[doc:systeme:superutilisateur|super-utilisateur]], modifiez user en root dans la balise : | + | Soit, par exemple: |
| - | <code>[code=root]ma_commande[/code]</code> | + | <code>[code=apt_sources]deb http://ftp.debian.org/debian jessie main contrib non-free[/code]</code> |
| - | === Les retours === | + | Ce qui donne sur le forum: |
| + | <code apt_sources>deb http://ftp.debian.org/debian jessie main contrib non-free</code> | ||
| - | Pour indiquer le retour d'une commande, utilisez simplement les balises code : | + | Même chose pour « apt_preferences » |
| - | <code>[code]Le retour de ma commande[/code]</code> | + | |
| - | ==== Les entrées ==== | + | Il en va de même avec les langages de programmation (perl, bash, C, python, etc.): |
| - | Exemple pour une entrée apt-sources : \\ | ||
| - | Pour indiquer qu'il s'agit d'une entrée de //[[doc:systeme:apt:sources.list|sources.list]]//, utilisez les balises | ||
| - | <code>[code=apt_sources]deb entree_sources.list[/code]</code> | ||
| - | |||
| - | ==== Les langages de programmation ==== | ||
| - | |||
| - | Cela supporte même des tas d'autres langages de programmation. \\ | ||
| Il suffit (en général) de faire : | Il suffit (en général) de faire : | ||
| <code>[code=langage]code[/code]</code> | <code>[code=langage]code[/code]</code> | ||
| - | |||
| Pour obtenir la distinction de leurs colorations particulières. | Pour obtenir la distinction de leurs colorations particulières. | ||
| - | <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 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> | </note> | ||
| + | |||
| ===== La prime ===== | ===== La prime ===== | ||
| 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 : | 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://wiki.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 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 | ||
