Author: glorieux Date: 2009-09-14 11:26:45 +0200 (Mon, 14 Sep 2009) New Revision: 92 Modified: test_rstedit/src/site/rst/index.rst Log: return Modified: test_rstedit/src/site/rst/index.rst =================================================================== --- test_rstedit/src/site/rst/index.rst 2009-09-14 09:26:11 UTC (rev 91) +++ test_rstedit/src/site/rst/index.rst 2009-09-14 09:26:45 UTC (rev 92) @@ -1 +1,68 @@ -on test \ No newline at end of file +================================= +Parseur reStructuredText : le JRst +================================== + +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. + +JRST est un parseur RST en Java permettant de créer une représentation en arbre +d'un document. Il devient alors facile de générer une représentation du document +vers différents formats. + + +Usage +----- + +Le parser JRST prend un fichier reStructuredText en entré 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, le odt (Open-Office), le rtf, ou encore le XML. + +:: + + 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 : + +-o file,--outFile=file pour rediriger la sortie vers un fichier. +-t format,--outType format pour préciser un format de sortie, donc utiliser un ou des fichiers XSL de génération. + Plusieurs formats sont disponibles xhtml, docbook, xml, html, xdoc, rst, pdf, odt, rtf. +-x xslFile,--xslFile xslFile sert � préciser le fichier xsl de génération � utiliser. +--force forcer l'écriture d'un fichier, si le fichier de sortie existe, il sera remplacé. +--help pour afficher les options disponibles : + + +:: + + Usage: [options] FILE + [--force] : overwrite existing out 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 + +Note : Seul les formats html, xhtml, DocBook, xdoc et pdf sont disponible pour le moment. + +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://jrst.labs.libre-entreprise.org/maven-jrst-plugin. +Il permet l'utilisation depuis Maven de JRst. \ No newline at end of file