Impression
| author: | William Dode |
|---|---|
| Contact: | wilk at flibuste.net |
| Copyright: | Ce texte est placé dans le domaine public. |
Les directives sont indiquées de cette manière:
.. nom de la directive:: paramètre (facultatif ou non suivant la directive)
:option: contenu d'une option (toujours facultative)
<--- ligne vide --->
Texte de la directive (facultatif ou non suivant la directive)
admonition
Le titre est automatiquement le nom de la directive.
Insertion d'une image
| paramètre: | chemin de l'image |
|---|---|
| height: | taille verticale |
| width: | taille horizontale |
| scale: | échelle |
| alt: | texte à afficher si le navigateur ne peut pas afficher les images (utile pour les aveugles par ex.) |
| align: | alignement ("top" en haut , "middle" au milieu, "bottom" en bas, "left" à gauche, "center" au centre, ou "right" à droite) |
| class: | classe de l'image |
| target: | url en cas de clic sur l'image |
image avec plus d'options, un sous-titre et une légende
le premier bloc est le sous-titre, les suivants la légende
| figwidth: | largeur du cadre contenant les légendes et l'image |
|---|---|
| figclass: | classe de la figure |
| paramètre: | titre du sujet (impératif) |
|---|---|
| class: | définition de la classe |
Texte encadré avec titre et sous-titre
| paramètre: | titre de l'encadré (impératif) |
|---|---|
| subtitle: | sous-titre |
| class: |
Bloc de texte dont la mise en forme ne sera pas modifiée
| class: |
|---|
le rendu d'un code-interprété sera légèrement différent
Défini une section/rubrique qui ne fait pas partie de la structure du document et ne rentrera pas dans le sommaire
| paramètre: | titre de l'intertitre (impératif) |
|---|
pas de contenu
Épigraphe, généralement en tête de document (mais pas obligatoirement), avec une éventuelle attribution
-- attribution facultative (précédé impérativement de --)
Chapeau, généralement en tête de document (mais pas obligatoirement)
-- attribution facultative
Permet d'afficher le sommaire du document
| paramètre: | titre facultatif |
|---|---|
| depth: | profondeur |
| local: | uniquement sur les sous-section de la section en cours |
| backlinks: | "entry", "top", "none" génère un lien des sections vers la section dans le sommaire, des sections vers le sommaire ou aucun lien. |
Permet de numéroter automatiquement les sections de tout le document
| depth: | profondeur maximale |
|---|
Affiche la liste de tous les liens externes du type
`lien`_ .. _`lien`: url du lien externe
Inclure un texte (reStructuredText ou texte brut)
| paramètre: | chemin d'accès au fichier |
|---|---|
| literal: | pour ne pas analyser la structure du texte (si ce n'est pas un texte rst) |
Insére du texte brut (html ou latex) qui ne sera pas analysé par rst
| paramètre: | html ou latex |
|---|---|
| file: | chemin d'accès d'un fichier html ou latex à inclure |
| url: | url d'un document html à inclure (seulement html) |
Permet de remplacer automatiquement un texte, souvent utilisé pour des abréviations
tout le texte entre des barres (|rst| par exemple) va être remplacé par reStructuredText .. |rst| remplacer:: reStructuredText
Pour affecter une classe à un bloc de texte hors directive:
.. class:: special Ceci est un paragraphe spécial .. class:: exceptionnel Une section exceptionnelle ========================== Un paragraphe ordinaire
Pour affecter une classe à un bloc décalé il faut faire suivre la directive par un commentaire vide:
.. classe:: special .. bloc de texte spécial décalé