Présentation

Le format reStructuredText est un format de description de documents. A l'image d'autres LaTeX ou DocBook, il peut être décliné en une multitude de formats. Ces formats souffrent habituellement d'une syntaxe envahissante qui, si elle est nécessaire pour des documents très spécifiques, devient gênante quand il s'agit de créer rapidement un document pas trop complexe. RST dispose quant à lui d'une syntaxe tellement simple qu'elle en devient presque invisible.

Deux méthodes de génération sont proposées :

• La première utilise Jython pour lancer des scripts de DocUtils afin de transformer le RST en XML. Toutes les fonctionnalités proposées par ReStructuredText sont prises en comptes mais la génération est un peu plus longue puisque celle-ci est basée sur les scripts externes de DocUtils.

• La seconde utilise notre propre parseur JRST pour générer ce XML, ce qui permet d'obtenir de très bonne performances mais certaines fonctionnalités ne sont pas encore implémentées.

A partir du document XML, nous permettons la transformation en divers formats comme HTML ou PDF.

Usage

JRST prend un fichier reStructuredText en entrée et génère un fichier XML qui pourra ensuite servir à produire divers formats de fichiers grâce à des fichiers XSL de générations. Les formats de sortie disponibles sont le html, le xhtml, le rst, le pdf, le docbook ou du XML [1] .

Lorsque JRST est lancé sans argument, une interface graphique est proposée à l'utilisateur. Ainsi, on peut choisir plus aisément les fichiers, le type de sortie, les feuilles de style XSL externes à appliquer ou bien la génération simplifiée ou non.

JRST myfile.rst

Cette commande aura pour effet de convertir le fichier myfile.rst en XML qui sera affiché sur la sortie standard (console). Plusieurs options sont disponibles :

Usage: [options] FILE
   [--force] : overwrite existing out file
   [--simple] : use our own parser to generate the file
   [--help] : display this help and exit
   [--outFile -o value] : Output file
   [--outType -t /xhtml|docbook|xml|html|xdoc|rst/] : Output type
   [--xslFile -x value] : XSL file list to apply, comma separated

ex :

JRST --force -t html -o myfile.html myfile.rst

Cette commande produira un fichier html (myfile.html) à partir du fichier reStructuredText (myfile.rst) même si myfile.html existe déjà.

Plugin Maven

Un plugin Maven est disponible à l'adresse suivante http://maven-site.nuiton.org/jrst/maven-jrst-plugin. Il permet l'utilisation depuis Maven de JRst.