====== Utilisation des balises BBCode et de la coloration syntaxique sur le forum ======
* Objet : Utilisation des balises BBCode et de la coloration syntaxique sur le forum
* Niveau requis : {{tag>débutant }}
* Commentaires : Aide pour la mise en forme des commentaires sur le forum et explication de la syntaxe.
* Suivi :
* Création par [[user>nIQnutn]] 27/08/2015
* Testé par <...> le <...>
* Commentaires sur le forum : [[https://debian-facile.org/viewtopic.php?pid=135642#p135642 | Lien vers le forum concernant ce tuto]] ((N'hésitez pas à y faire part de vos remarques, succès, améliorations ou échecs !))
===== Introduction =====
Pour poser une question ou y répondre sur le forum, il est important de suivre ces règles basiques :
* utiliser au possible un français correct (orthographe, grammaire, ponctuation)
* éviter les abréviations
* soyez joyeux et polis, //ça l'fera bien//.
Le forum propose également des outils (voir les //boutons// de l'image ci-dessous) pour la mise en forme des message.
{{/file-Rbace58842a71d9d487484646701cd445.png}}
Lors de la rédaction d'un message il est souvent utile de le //mettre en forme// pour en faciliter la lecture par les visiteurs.
On distinguera:
* La mise en forme du texte ( gras / italique / souligné / barré )
* L'ajout de //lien// ( vers une page web / pour afficher une image )
* Les //citations//
* Les //émoticônes//
* Les //commandes// utilisées dans le terminal
* Le code.
\\
===== Utilisation =====
Pour mettre en forme le message, on peut utiliser les boutons. Il suffit de sélectionner le texte et de lui ajouter la balise adéquat en cliquant dessus.
On peut également utiliser directement les balises dans le texte. Il suffit de respecter cette syntaxe:
[balise]mon texte[/balise]
==== Mise en forme ====
- Pour commencer, on rédige simplement son message //brut de coffrage//, c'est à dire sans fioriture.
- Et ensuite on ajoute la mise en forme.
Rien de compliqué, il suffit de **surligner** les mots en les sélectionnant avec la souris et de leurs appliquer la //mise en forme// choisis par les boutons en haut du post. \\
Idem pour les **liens** et les **images**.
Pour résumer l'utilisation des boutons:
^ Bouton ^ Description ^ Résultat ^Balise ^
|**B** | pour mettre en gras (en anglais bold) | **Gras** | [b]Gras[/b]|
|**I** | pour mettre en italique | //Italique// | [i]Italique[/i]|
|**U** | pour souligner (en anglais underline) | __Souligné__ | [u]Souligné[/u]|
|**S** | pour barrer (en anglais strike) | Barré | [s]Barré[/s]|
Un petit exemple sur l'utilisation des boutons :
En manipulant les boutons de mise en forme ainsi :
{{/file-R4b500d5b047dd68b1949762ef351f4aa.png}}
Le message apparaîtra tout beau après validation comme ça :
{{/file-Rdc380289b44322c9d9c2df2f1e206884.png}}
Avant de publier le message (mis en forme ou non), prenez le temps de le //prévisualiser// en cliquant sur le bouton... **Prévisualisation**. ;-)
==== Citations ====
On peut également reprendre le message précédent ou ajouter des citations.
^ Bouton ^ Description ^Balise ^
|**Citation** | pour ajouter une citation | [quote]Citation[/quote] |
|**Citation** | pour ajouter une citation avec son auteur | [quote=nIQnutn]Citation[/quote] |
On peut utiliser le bouton **Citer** pour reprendre le message précédent.
{{/file-Rcf128c79e28cd6738c47a381f875a9f4.png}}
Le résultat:
{{/file-Ra1884a6aa7a2ecf78f1431135055ad52.png}}
Ne citer que la partie importante du message et supprimer le reste.
Sinon, on utilise le bouton **Citation** et on recopie le contenu à la main.
{{/file-R5308655eb4ef2f256f732a0f35876208.png}}
Le résultat:
{{/file-Rb7ff42ca9a2acba7d59142b9476160b7.png}}
==== Commande utilisateur et root ====
Il nous reste à voir la mise en forme des Codes.
Concernant les commandes écrites dans un terminal, il y a deux boutons :
* **Commande utilisateur** simple,
* **Commande [[doc:systeme:superutilisateur|root]]**.
Quand on utilise les balises **Commande** on aura automatiquement une seconde balise **Code** pour le retour du terminal (c'est ce qui s'affiche après l'exécution du terminal).
On fera bien la différence entre la commande qui sera exécutée et ce qui nous sera retourné par le système (qui sera inséré dans la balise **Code**).
^ Bouton ^ Description ^Balise ^
|**Commande utilisateur** | pour ajouter une commande utilisateur | [code=user]man debian-facile[/code] |
|**Commande root** | pour ajouter une commande root | [code=root]apt install debian-facile[/code] |
{{/file-R2468e72f81fd9a2786ec3babb5113781.png}}
Le résultat :
{{/file-R95741d13c7898c00a17fcd15089186f0.png}}
On prendra soin de supprimer les //blocs de retour de commande automatiques// (codes et contenu) lorsque la commande n'en renvoie pas. \\
Blocs d'ailleurs judicieusement indiqués par le texte qu'ils contiennent : « //bloc à supprimer si la commande n’affiche rien.// »
//Sacré //**captnfab**// Comment qu'y pense pour nous tout d'mêm' !// :-D
==== Code ====
Le code doit être intégré dans les balises codes.
Si le langage du code utilisé est présent dans la liste déroulante du //bouton// **Code** (par exemple //apt_sources// pour baliser la liste des //sources//) sélectionnez cette balise spécifique dans //la liste déroulante des balises// qui apparaît pour aider à rendre le contenu du code plus compréhensibles.
^ Bouton ^ Description ^ Résultat ^Balise ^
|**Code** | pour ajouter du code en utilisant la coloration syntaxique | [code=html5]
Debian Facile
[/code] |
|**Autre code** | pour ajouter du code | [code]debian-facile[/code] |
Si vous hésitez, êtes //naufragés// ou si ce langage n'y est pas, utilisez alors la balise simple du //bouton// **Autre code**. 8-)
{{/file-R3595e9950eaefd8a8bdee2ae6bb47106.png}}
Résultat :
{{/file-R0e469e55c8b08e2d84364f40d2b1517d.png}}
N'insérez que le code qui est vraiment utile pour ne pas encombrer la discussion.
===== Aller plus loin =====
==== Syntaxe et balise ====
Il est nécessaire de respecter une syntaxe précise pour utiliser les balises.
* balise ouvrante
* arguments
* texte libre
* balise fermante
Il faut également faire attention quand on utilise plusieurs balises et qu'elles s'imbriquent entre elles.
On ferme toujours la balise la plus "proche"
[i][url=http://wiki.debian-facile.org/atelier:resolu]Voir le tuto : C'est résolu ! Bravo mais il faut l'indiquer dans l'titre.[/url][/i]
et pas [i][url=wiki.debian-facile.org/atelier:resolu]Voir le tuto : C'est résolu ! Bravo mais il faut l'indiquer dans l'titre.[/i]<[/url]
==== Annonce de correction des codes dans le forum ====
%%[b]Edit[/b] : Pour que la lecture du code sur le forum soit lisible par tous, il faut bien dissocier chaque commande hors de son retour. Modif fête. :) %% \\
%%[i][url=https://debian-facile.org/atelier:bbcode]Oh, quel beau BB …code où comment mettre en forme vos messages dans le fofo[/url][/i]%%
==== La Prime ====
Ne reculant devant aucun sacrifice, Debian-Facile offrira **un point-chocolat** à qui insèrera le lien suivant dans un message pour aider son prochain à bien utiliser le BBCode :-D
''[i][url=https://debian-facile.org/atelier:bbcode]Oh, quel beau BB ...code où comment mettre en forme vos messages dans le fofo[/url][/i]''
==== Ressources ====
* La coloration syntaxique du code [[atelier:coloration-syntaxique|Utiliser la coloration syntaxique dans le forum]]
* L'aide complète sur l'utilisation du [[https://debian-facile.org/help.php#bbcode|BBCode]]