Le format RST : reStructuredText

July 11th, 2005 by lucas

Le format RST (reStructuredText) est un format ouvert WYSIWYG très simple et très pratique, avec un rapport signal/bruit proche de l’optimal. Son cas d’utilisation typique est l’écriture de petits documents (TODO lists, résumés, courts articles, etc…). Il permet d’écrire des documents naturellement, avec simple éditeur de texte. Mais prenons plutôt un petit exemple :

 ================= Titre du document ================= Titre de section ================ Titre de sous-section --------------------- Titre de sous-sous-section ~~~~~~~~~~~~~~~~~~~~~~~~~~ ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe ceci est un paragraphe. - Une liste - 2eme item   * imbrication de listes   * imbrication de listes, 2eme item - 3e item 1) liste ordonnée 2) suite de la liste ordonnée --------- Il y avait une ligne de séparation avant ce paragraphe. Une autre section ================= Les liens comme http://www.perdu.com sont transformés dans la version HTML. On peut aussi faire des liens avec des titres comme `ce lien <http://www.perdu.com>` 

Et on peut exporter vers de l’HTML (XHTML 1.0 Transitional, en fait), du LaTeX (pour faire du PostScript ou du PDF) ou du XML (idéal si vous maitrisez XSLT). Le convertisseur vers l’HTML est suffisamment rapide pour l’exécuter depuis un fichier PHP : ca vous fait un moyen de lire facilement votre TODO list à distance.

Pour installer rst2html, rst2latex et rst2xml sous Debian, c’est le paquet python-docutils (RST étant utilisé pour écrire de la doc Python).

Si vous voulez en savoir plus :

3 Responses to “Le format RST : reStructuredText”

  1. gaerun wrote on 07/18/05 at 6:07 pm :

    Je me sens soudain comme un monsieur Jourdain, qui ferait depuis des années du RST sans le savoir.

  2. Thomas wrote on 08/1/05 at 2:20 pm :

    Ça serait bien d’avoir des Wiki qui utilisent cette syntaxe, histoire d’avoir un format Wiki avec lequel on puisse faire quelque chose (générer des PDFs, des RTFs, etc.). Là, il y a plein de formats Wiki de partout, incompatibles entre eux. Le jour où on veut changer de Wiki, vive la galère ;-(

  3. Pierrick wrote on 08/11/05 at 7:46 pm :

    Excellent ! J’utilise un format "perso" très très proche pour la rédaction du README accompagnant chacun des patchs que je livre à mon travail. Je vais me caler sur RST pour pouvoir générer du PDF (via LaTeX), j’éviterais ainsi les blagues vaseuses du client :

    > ah oui, les docs de Pierrick, c’est de la doc de pauvre (ie en
    > texte)…".

    Merci Lucas