baud123 : styles + sommaire + ajout de lignes blanches avant ``` et suppression de text dans ```text (ne fonctionne plus ?) (16 mars 2012 22:25:59)
Aide à l'édition
================
Que ce soit pour poster une dépêche, un commentaire, ou écrire dans le [wiki](LinuxFrorg), LinuxFr.org utilise un langage à balisage afin de permettre aux utilisateurs d'ajouter du contenu aisément. Il s'agit de la syntaxe [Markdown](http://fr.wikipedia.org/wiki/Markdown "Définition Wikipédia").
Markdown est une syntaxe ayant pour but d'être facile à lire et écrire, ainsi, un document formaté en Markdown ne donne pas l'impression d'être marqué par des balises. Pour en savoir plus, vous pouvez consulter la [documentation officielle](http://daringfireball.net/projects/markdown/syntax) ou encore sa traduction en [français](http://michelf.com/projets/php-markdown/syntaxe/).
Le site _LinuxFr.org_ modifie quelque peu la syntaxe Markdown et y apporte quelques [extensions](http://www.pell.portland.or.us/~orc/Code/discount/#Language+extensions). Cette page présente les éléments les plus importants de la syntaxe utilisée sur le site _LinuxFr.org_.
Afin de vous essayer à cette syntaxe, vous pouvez utiliser le [bac à sable](Bac-a-sable).
Caractères
----------
Caractères spéciaux à copier/coller
æ Æ à À â Â ä Ä
ç Ç
€ é É è È ê Ê ë Ë
î Î ï Ï
œ Œ ô Ô ö Ö
ù Ù û Û ü Ü
ÿ Ÿ
¹ ² ³ ⁴ ⁵ ⁶ ⁷ ⁸ ⁹ ⁰
½ « » ~ # @ … ‰ € – —
Titres
------
Il existe cinq niveaux de titres. Un titre est précédé du symbole `#`, le nombre de fois où ce symbole est répété indique le niveau du titre.
```text
# Titre de niveau 1
## Titre de niveau 2
### Titre de niveau 3
#### Titre de niveau 4
##### Titre de niveau 5
```
# Titre de niveau 1
## Titre de niveau 2
### Titre de niveau 3
#### Titre de niveau 4
##### Titre de niveau 5
Afin de clarifier le texte, les titres de niveau 1 et 2 peuvent êtres écrits sous cette forme :
```text
Titre de niveau 1
=================
Titre de niveau 2
-----------------
Fin de la section titre
=======================
```
Le résultat étant le même que précédemment.
Titre de niveau 1
=================
Titre de niveau 2
-----------------
Fin de la section titre
=======================
Mise en forme du texte
----------------------
Afin de donner du caractère à votre texte, la syntaxe vous permet d'utiliser du **gras** (qui correspond à l'emphase forte), de l'_italique_ (qui correspond à l'emphase normale), et bien plus encore.
```text
_italique_ ou *italique*
__gras__ ou **gras**
`chasse fixe`
~~barré~~
```
_italique_ ou *italique*
__gras__ ou **gras**
`chasse fixe`
~~barré~~
Si vous voulez vraiment entourer votre texte avec les caractères précédents, vous devez les échapper avec le caractère `\`.
```text
Mon texte sans \_mise\_ en \*\*forme\*\*.
```
Mon texte sans \_mise\_ en \*\*forme\*\*.
Code
----
Vous avez aussi la possibilité d'ajouter du code, voir http://pygments.org/languages/ pour la liste des langages gérés.
\`\`\`java
public class Bonjour {
public static int main(String[] args) {
System.out.println("Bonjour !");
}
}
\`\`\`
\`\`\`python
>>> print "Bonjour !"
Bonjour !
\`\`\`
```java
public class Bonjour {
public static int main(String[] args) {
System.out.println("Bonjour !");
}
}
```
```python
>>> print "Bonjour !"
Bonjour !
```
À savoir, le langage utilisé doit être spécifié. S'il ne s'agit pas d'un langage en particulier, vous pouvez soit utiliser le formatage `text` ou faire précéder chaque ligne de code de quatre espaces.
\`\`\`text
Ceci est un texte qui n'utilise pas
un langage de programmation en
particulier.
\`\`\`
équivaut à :
(4 espaces) Ceci est un texte qui n'utilise pas
(4 espaces) un langage de programmation en
(4 espaces) particulier.
Ceci est un texte qui n'utilise pas
un langage de programmation en
particulier.
Paragraphes
-----------
Un paragraphe est simplement une ou plusieurs lignes consécutives de texte séparées par une ou plusieurs lignes vides.
```text
Mox dicta finierat, multitudo omnis ad, quae imperator voluit, promptior laudato consilio consensit in pacem ea ratione maxime percita, quod norat expeditionibus crebris fortunam eius in malis tantum civilibus vigilasse, cum autem bella moverentur externa, accidisse plerumque luctuosa, icto post haec foedere gentium ritu perfectaque sollemnitate imperator Mediolanum ad hiberna discessit.
Exsistit autem hoc loco quaedam quaestio subdifficilis, num quando amici novi, digni amicitia, veteribus sint anteponendi, ut equis vetulis teneros anteponere solemus. Indigna homine dubitatio! Non enim debent esse amicitiarum sicut aliarum rerum satietates; veterrima quaeque, ut ea vina, quae vetustatem ferunt, esse debet suavissima; verumque illud est, quod dicitur, multos modios salis simul edendos esse, ut amicitiae munus expletum sit.
```
> Mox dicta finierat, multitudo omnis ad, quae imperator voluit, promptior laudato consilio consensit in pacem ea ratione maxime percita, quod norat expeditionibus crebris fortunam eius in malis tantum civilibus vigilasse, cum autem bella moverentur externa, accidisse plerumque luctuosa, icto post haec foedere gentium ritu perfectaque sollemnitate imperator Mediolanum ad hiberna discessit.
> Exsistit autem hoc loco quaedam quaestio subdifficilis, num quando amici novi, digni amicitia, veteribus sint anteponendi, ut equis vetulis teneros anteponere solemus. Indigna homine dubitatio! Non enim debent esse amicitiarum sicut aliarum rerum satietates; veterrima quaeque, ut ea vina, quae vetustatem ferunt, esse debet suavissima; verumque illud est, quod dicitur, multos modios salis simul edendos esse, ut amicitiae munus expletum sit.
Attention, en contradiction avec la spécification markdown, LinuxFR active le "hard wrapping" : un retour à la ligne au milieu d'un paragraphe n'est pas ignoré, et se traduit par un retour à la ligne dans le rendu, même en l'absence de deux espaces en fin de ligne.
```text
Eminuit autem inter humilia supergressa iam impotentia fines (pas d'espaces ajoutées)
mediocrium delictorum nefanda Clematii cuiusdam Alexandrini nobilis mors repentina.
```
> Eminuit autem inter humilia supergressa iam impotentia fines (pas d'espaces ajoutées)
mediocrium delictorum nefanda Clematii cuiusdam Alexandrini nobilis mors repentina.
Ce choix perturbe moins les utilisateurs ne connaissant pas markdown, qui s'attendent à ce qu'un saut de ligne dans le document source se traduise en un saut de ligne forcé au rendu. Si vous utilisez un éditeur externe, il faudra le configurer pour éviter les sauts de ligne de présentation (commande [unfill-region](http://www.emacswiki.org/emacs/UnfillRegion) pour Emacs par exemple).
Attention, ce comportement s'applique seulement aux sauts de lignes au sein d'un paragraphe, pas à plusieurs lignes vides répétées qui sont traduites en une unique ligne inter-paragraphe.
```text
ceci
cela
```
> ceci
>
>
>
> cela
Pour obtenir plusieurs lignes vides (un choix typographique discutable), on peut insérer le caractère d'échappement ` ` sur les lignes interstitielles.
Citations
---------
Les citations sont un ensemble de lignes précédés par le symbole `>`.
```text
> Itaque verae amicitiae difficillime reperiuntur in iis qui in honoribus reque publica
> versantur; ubi enim istum invenias qui honorem amici anteponat suo? Quid? Haec ut
> omittam, quam graves, quam difficiles plerisque videntur calamitatum societates!
> Ad quas non est facile inventu qui descendant. Quamquam Ennius recte.
```
> Itaque verae amicitiae difficillime reperiuntur in iis qui in honoribus reque publica
> versantur; ubi enim istum invenias qui honorem amici anteponat suo? Quid? Haec ut
> omittam, quam graves, quam difficiles plerisque videntur calamitatum societates!
> Ad quas non est facile inventu qui descendant. Quamquam Ennius recte.
Les plus paresseux peuvent simplement placer ce symbole sur la première ligne d'un paragraphe.
```text
> Itaque verae amicitiae difficillime reperiuntur in iis qui in honoribus reque publica
versantur; ubi enim istum invenias qui honorem amici anteponat suo? Quid? Haec ut
omittam, quam graves, quam difficiles plerisque videntur calamitatum societates!
Ad quas non est facile inventu qui descendant. Quamquam Ennius recte.
```
> Itaque verae amicitiae difficillime reperiuntur in iis qui in honoribus reque publica
versantur; ubi enim istum invenias qui honorem amici anteponat suo? Quid? Haec ut
omittam, quam graves, quam difficiles plerisque videntur calamitatum societates!
Ad quas non est facile inventu qui descendant. Quamquam Ennius recte.
Il est aussi possible d'insérer une citation dans la citation ou encore utiliser des éléments de la syntaxe Markdown.
```text
> Chapitre 1
> ==========
```
> Sed maximum est in amicitia parem esse inferiori. Saepe enim excellentiae quaedam sunt, qualis erat Scipionis in nostro, ut ita dicam, grege. Numquam se ille Philo, numquam Rupilio, numquam Mummio anteposuit, numquam inferioris ordinis amicis, Q. vero Maximum fratrem, egregium virum omnino, sibi nequaquam parem, quod is anteibat aetate, tamquam superiorem colebat suosque omnes per se posse esse ampliores volebat.
>> Senator exempla publicae ipsas publicae hominum quis fui factorum semper hominum mihi omnium mihi petenda.
```
> Chapitre 1
> ==========
> Sed maximum est in amicitia parem esse inferiori. Saepe enim excellentiae quaedam sunt, qualis erat Scipionis in nostro, ut ita dicam, grege. Numquam se ille Philo, numquam Rupilio, numquam Mummio anteposuit, numquam inferioris ordinis amicis, Q. vero Maximum fratrem, egregium virum omnino, sibi nequaquam parem, quod is anteibat aetate, tamquam superiorem colebat suosque omnes per se posse esse ampliores volebat.
>> Senator exempla publicae ipsas publicae hominum quis fui factorum semper hominum mihi omnium mihi petenda.
## Hyperliens
----------
Afin d'étoffer vos propos, vous aurez sûrement besoin d'ajouter quelques liens. Nous pouvons différencier trois types de liens : les liens internes qui sont des liens vers le wiki du site, les liens externes qui pointent vers un site internet et les liens vers un article [Wikipédia](http://fr.wikipedia.org/wiki/Wikipédia "Définition Wikipédia") :
```text
* lien vers la page principale du wiki : [LinuxFrorg](/wiki/LinuxFrorg "Lien du wiki interne LinuxFr.org") ;
* lien nommé vers la [page principale du wiki](LinuxFrorg) ;
* lien externe : <http://linuxfr.org> ;
* lien externe nommé : [LinuxFr.org](http://linuxfr.org) ;
* lien vers une définition Wikipédia : [Wikipédia](http://fr.wikipedia.org/wiki/Wikipédia "Définition Wikipédia").
```
Ce qui donne :
* lien vers la page principale du wiki : [LinuxFrorg](/wiki/LinuxFrorg "Lien du wiki interne LinuxFr.org") ;
* lien nommé vers la [page principale du wiki](LinuxFrorg) ;
* lien externe : <http://linuxfr.org> ;
* lien externe nommé : [LinuxFr.org](http://linuxfr.org) ;
* lien vers une définition Wikipédia : [Wikipédia](http://fr.wikipedia.org/wiki/Wikipédia "Définition Wikipédia").
Pour faire un lien vers une définition dans une autre langue, il suffit de préfixer le mot par le [code ISO 639-1](http://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1) à deux lettres de la langue, ainsi, pour la page anglaise concernant Linux :
```text
[Linux](http://fr.wikipedia.org/wiki/en:Linux "Définition Wikipédia")
```
donnera : « [Linux](http://fr.wikipedia.org/wiki/en:Linux "Définition Wikipédia") ».
## Les listes et énumérations
--------------------------
Il existe trois types de listes, **penser à mettre une ligne blanche avant pour les utiliser** :
### les listes à puces
```text
* élément 1 (un point‐virgule précédé d’une espace fine insécable (“ ”) termine chaque élément) ;
* élément 2 ;
* Je peux même y mettre un texte qui s'étend sur (2 espaces en fin de ligne)
plusieurs lignes :
* et faire des listes imbriquées (une simple virgule sépare les sous‐éléments),
* de cette manière,
* en indentant de 2 espaces en début de ligne (le dernier sous‐élément est terminé par un point‐virgule précédé de son inséparable espace fine insécable) ;
* élément final.
```
* élément 1 ;
* élément 2 ;
* Je peux même y mettre un texte qui s'étend sur
plusieurs lignes :
* et faire des listes imbriquées,
* de cette manière,
* en indentant de 2 espaces en début de ligne ;
* élément final.
### les listes ordonnées
```text
1. élément 1 ;
1. élément 2 ;
1. élément 3.
```
1. élément 1 ;
1. élément 2 ;
1. élément 3.
### Les listes de définition
```text
terme 1
(4 espaces) Définition 1.
terme 2
Définition 2.
```
terme 1
Définition 1.
terme 2
Définition 2.
Tableaux
--------
La syntaxe Markdown permet d'insérer des tableaux de façon intuitive.
```text
Titre 1 | Titre 2 | Titre 3
------------|-----------|----------
**Ligne 1** | Élément 3 | Élément 5
**Ligne 2** | Élément 4 | Élément 6
```
Titre 1 | Titre 2 | Titre 3
------------|-----------|----------
**Ligne 1** | Élément 3 | Élément 5
**Ligne 2** | Élément 4 | Élément 6
Images
------
Grande nouveauté sur LinuxFr.org, on peut maintenant incorporer des images où l'on veut alors profitons en :
```text
![Logo LinuxFr.org](http://linuxfr.org/images/logos/linuxfr2_100.png)
```
![Logo LinuxFr.org](http://linuxfr.org/images/logos/linuxfr2_100.png)
Il est possible de mettre un titre sur l'image :
```text
![Ici le texte alternatif](http://linuxfr.org/images/logos/linuxfr2_100.png "ici le titre")
```
![Ici le texte alternatif](http://linuxfr.org/images/logos/linuxfr2_100.png "ici le titre")
Si votre image est trop grande, vous pouvez spécifier la taille à laquelle vous souhaitez l'inclure (mais cela ne fonctionne plus depuis l'ajout du titre /o\\) :
```text
![Logo LinuxFr.org](http://linuxfr.org/images/logos/linuxfr2_classic_back.png "=100x100") (2 espaces)
Image originale : (2 espaces)
![Logo LinuxFr.org](http://linuxfr.org/images/logos/linuxfr2_classic_back.png)
```
![Logo LinuxFr.org](http://linuxfr.org/images/logos/linuxfr2_classic_back.png "=100x100")
Image originale :
![Logo LinuxFr.org](http://linuxfr.org/images/logos/linuxfr2_classic_back.png)
Ligne de séparation
-------------------
Il est possible de créer une ligne de démarcation en faisant suivre trois ou plus des caractères suivants : `*`, `-`, `_`.
```text
***
----
_____
```
***
----
_____
Adresse de courriel, XMPP…
--------------------------
Les adresse de courriel sont automatiquement transformée avec le lien `mailto` : example@example.com
Pour les adresse XMPP, il faut utiliser la même syntaxe que pour les liens http : `[xmpp:example@example.com](xmpp:example@example.com)` donne [xmpp:example@example.com](xmpp:example@example.com)
En bref
-------
Quelques éléments qui peuvent s'avérer utiles :
* “\ ”, espace insécable (le caractère UTF-8 “ ” doit être préféré à cet antique code HTML) ;
* 2`^`8 pour mettre un caractère en exposant (très mal implémenté, puisque si vous avez besoin de mettre autre chose qu'une espace‐mot [espace classique, caractère 32], comme une espace insécable, une ponctuation [ici, par exemple, on ne peut pas mettre de virgule], votre caractère sera mis également en exposant, ainsi que tous les autres caractères jusqu’au premier espace rencontré !).
* “ ”, espace insécable ;
* 2^8 pour mettre un caractère en exposant.
Le mot de la fin
----------------================
Cette page ne présente qu'un sous‐ensemble de la syntaxe Markdown mais devrait vous suffire à proposer du contenu sur le site _LinuxFr.org_. Si vous voulez en savoir plus sur la syntaxe Markdown, n'hésiter à jeter un œil sur [le Web](http://lmgtfy.com/?q=markdown) et pensez au [bac à sable](Bac-a-sable) pour vous entraîner.