Révision n°1.2 du 03/05/2008

Fiche de référence pour mdown

Voyez l’article d’essai pour le résultat des structures présentées ici.

Mécanismes

commentaires ligne débutant par %-
directives ligne débutant par % et un caractère autre que -
échappement un caractère précédé de \ vaut pour lui-même

Les directives sont ignorées par mdown mais peuvent être utilisées par d’autres programmes.

Texte

paragraphe blocs de texte séparés par des lignes vides
emphase texte entre traits obliques : /texte/
forte emphase texte entre astérisques : *texte*
locution latine texte entre plus : +texte+
locution étrangère texte entre plus : +texte+(langue)
acronyme mot entre points : .MOT.(définition)
acronyme étranger mot entre points : .MOT.(définition)(langue)
code verbatim texte entre une ou plusieurs apostrophes gauches ` (autant de ` d’un côté que de l’autre)
retour à la ligne forcé ligne se terminant par des espaces superflues

Le premier caractère d’un acronyme ne doit pas être un caractère blanc ou de ponctuation.

Listes

Chaque élément est précédé d’un préfixe qui détermine le type de la liste. Les lignes suivant la première sont indentées de deux espaces. La liste est naturellement constituée de ses éléments consécutifs.

- liste à puces
+ hiérarchie
NOMBRE. (un nombre décimal suivi d’un point) liste ordonnée
:LABEL: (du texte entre deux symboles deux-points) liste descriptive

Pour une liste descriptive, le premier deux-points peut être remplacé par une espace et le second par une tabulation.

S’il n’y a pas d’espace vertical entre les éléments et que ceux-ci ne contiennent que du texte, alors la liste est dite simple, ses éléments ne seront pas transformés en paragraphes.

Remarque

Une manière de réaliser un comportement similaire, lorsque la première condition est remplie mais pas la seconde, est de placer sur la ligne suivant directement la liste un commentaire dont le préfixe %- est aligné avec le préfixe des éléments de la liste, comme ceci :

- ...
- ...
%-

Tableaux simples

Un tableau simple a une syntaxe similaire à une liste, excepté que les éléments (les lignes) débutent par | et, à l’intérieur d’une ligne, les cellules sont divisées par des | elles-mêmes. Un | ne doit pas se retrouver par mégarde en début de ligne. Dans un tableau, seuls les éléments de texte sont acceptés, on ne peut y placer ni paragraphes, ni listes, etc.

Blocs

Une citation sous forme de bloc voit toutes ses lignes préfixées par >␣ (un signe « supérieur à » suivi d’une espace).

Un bloc de code verbatim a toutes ses lignes indentées de deux espaces.

Un environnement nommé possède la même syntaxe qu’un bloc verbatim, excepté qu’il doit être précédé d’une ligne de la forme :

# CLASSE : TITRE

ou simplement :

# CLASSE

Cette ligne ne doit pas être indentée, seul le bloc qui suit l’est. Les environnements sont transcrits dans le format de sortie de la manière la plus naturelle possible (en balises <div> pour la sortie XHTML, en environnements LaTeX pour le format LaTeX, etc.).

Structure

Un titre de section est un bloc préfixé par des symboles =, de un à cinq, « un » étant le niveau le plus important. Si un titre tient sur plusieurs lignes, les lignes suivantes sont indentées de deux espaces. À l’instar des tableaux, seul le texte est accepté dans un titre.

Séparateurs

Le caractère ^L (form feed) permet de séparer les « pages » logiques d’un document. Il est rendu différemment selon le format de sortie. Il deviendra un élément <hr> en XHTML.

Formats alternatifs : source (mdown)
Thèmes :