ReStructuredText

Les paragraphes

L'élément de base est le paragraphe. C'est un bloc de lignes séparé du reste par au moins une ligne vide.

Si un paragraphe est indenté, il apparaît comme une citation. Par exemple:

Qu'est ce que l'indentation :

  L'indentation est le fait de précéder chaque ligne d'un paragraphe
  d'un certain nombre d'espace.

Donne à l'affichage :

Qu'est ce que l'indentation :

L'indentation est le fait de précéder chaque ligne d'un paragraphe d'un certain nombre d'espace.

Mise en forme des caractères

A l'intérieur d'un paragraphe, un texte entouré d'astérisques comme *italique* apparaît en italique. Alors que **gras** apparaîtra en gras.

Pour insérer un caractère spécial comme *, on le précède d'une barre oblique inverse ou antislash \.

Pour désactiver la mise en forme et utiliser une police à espacement proportionnel, on entoure le texte de double apostrophes inversées. Le texte ``double apostrophes inversées`` sera affiché comme ceci : double apostrophes inversées.

Listes

Une liste doit toujours être précédée d'une ligne vide. Les listes non-énumérées peuvent commencer par "-", "+" ou "*". Les listes énumérées sont marquées par un chiffre ou une lettre suivi d'un point:

* Première ligne.
* Seconde ligne.

1. Première ligne.
2. Seconde ligne.

a. Première ligne.
b. Seconde ligne.

Donne :

• Première ligne.
• Seconde ligne.

1. Première ligne.
2. Seconde ligne.

1. Première ligne.
2. Seconde ligne.

Une entrée de la liste peut avoir plusieurs paragraphes ou sous-listes. Mais il faut que tout soit aligné sur la première ligne de texte

* La première entrée est sur deux ligne. La deuxième
  ligne commence à la même colonne.

  1. Une sous-liste bien alignée.

  2. Reste bin alignée.

Donne :

• La première entrée est sur deux ligne. La deuxième ligne commence à la même colonne.
  1. Une sous-liste bien alignée.
  2. Suivie d'une autre.

Les listes de définitions permettent par exemple de faire des glossaires. Chaque entrée consiste en un terme et sa définition

azerty
  Clavier français.

qwerty
  Clavier américain.

Donne:

azerty

Clavier français.

qwerty

Clavier américain.

Texte sans mise en page (verbatim)

Pour insérer un texte sans aucune mise en forme et en préservant les sauts de lignes, il faut ajouter :: à la fin du paragraphe précédent. Le bloc a formatter doit-être indenté comme une citation. La fin de l'indentation détermine la fin du bloc:

Un texte sans mise en page::

  Tous est
    respecté.
      même les caractères comme les *astérisques*.

Donne:

Un texte sans mise en page:

Tous est
  respecté.
    même les caractères comme les *astérisques*.

Le signe :: peut être seul dans un paragraphe. Dans ce cas, il n'est pas affiché.

On peut aussi vouloir conserver l'indentation et les sauts de lignes en bénéficiant des autres possibilités de mise en page. Pour cela, il faut mettre une barre verticale à gauche du texte

| Les barres verticales permettent
| d'obtenir des **mises en pages**
| rapides.

Donne :

Les barres verticales permettent

d'obtenir des mises en pages

rapides.

Titres et sous-titres

Un titre est défini en le soulignant ou en le soulignant et le surlignant par des lignes de même longueurs composées de caractères de ponctuations. Les caractères sont choisis parmi = - ` : ' " ~ ^ _ * + # < >.

Il faut associer un signe de ponctuation à chaque niveau. Sachant qu'un titre surligné ne sera pas considéré au même niveau qu'un titre uniquement souligné même si les lignes sont formées avec le même signe de ponctuation:

Chapitre 1
==========

Section 1.1
-----------

Sous-section 1.1.1
~~~~~~~~~~~~~~~~~~

Section 1.2
-----------

Chapitre 2
==========

Un titre est automatiquement un lien. On peut insérer un renvoi vers un titre en faisant suivre son nom d'un caractère souligné comme `Section 1.1`_. Il faut des apostrophes inversées si le titre contient des espaces.

Pour le titre général d'un document, il faut utiliser un marquage qui ne sera pas réutilisé. On peut réserver le surlignage à cet effet:

===================
 Titre du document
===================

Section 1
=========

Lignes horizontale

Un paragraphe composé uniquement d'une suite de plus de 4 signes de ponctuation est transformé en une ligne horizontale.

Images

Pour inclure une image, il faut utiliser la directive image:

.. image:: smiley.png

Donne :

On peut inclure une image en ligne par une substitution:

Le rire |smiley| est le propre de l'homme.

.. |smiley| image:: smiley.png

Donne:

Le rire est le propre de l'homme.

Liens hypertextes

Un lien hypertexte nommé est indiqué par un caractère souligné après le nom. L'URL correspondante est définit plus bas. Un lien anonyme se définit par deux caractères soulignés. Une URL peut-être mise directement dans le texte

Le w3c_ est une organisation qui vise à définir des `standards du web`_. C'est
important de `rendre le web accessible à tous`__. Pourquoi ne pas se rendre
sur http://www.openweb.eu.org/

.. _w3c: http://www.w3.org/
.. _standards du web: http://www.w3.org/WAI/
__ http://www.openweb.eu.org/accessibilite/

Donne :

Le w3c est une organisation qui vise à définir des standards du web. C'est important de rendre le web accessible à tous. Pourquoi ne pas se rendre sur http://www.openweb.eu.org/

Tableaux

Un tableau se dessine naturellement en respectant les alignements:

+------------+------------+-----------+
| Entête 1   | Entête 2   | Entête 3  |
+============+============+===========+
| (1,1)      | (1,2)      | (1,3)     |
+------------+------------+-----------+
| (2,1)      | Cellule multi-colonne  |
+------------+------------+-----------+
| (3,1)      | Cellule    | (3,3)     |
+------------+ multi-     +-----------+
| (4,1)      | ligne      | (4,3)     |
+------------+------------+-----------+

Donne :