Index: jrst2/doc/index.rst diff -u jrst2/doc/index.rst:1.2 jrst2/doc/index.rst:1.3 --- jrst2/doc/index.rst:1.2 Fri Dec 29 09:23:45 2006 +++ jrst2/doc/index.rst Wed May 30 17:07:05 2007 @@ -1,37 +1,69 @@ -JRst -==== +================================== +Parseur reStructuredText : le JRst +================================== -.. contents:: +Documentation utilisateur +========================= + +.. contents:: Sommaire Présentation ------------ -JRst is Java ReStructuredText parser. +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. -Internaly Rst document is a dom4j tree that represent python docutils xml. -You can generate docbook, xhtml, xdoc or your own files with your own XSL -files. Usage ----- -To generate python docutils xml just write:: +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 fichier 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 - JRST myfile.rst -To generate html:: +ex : - JRST -t html myfile.rst +:: -To generate in specified file:: + JRST --force -t html -o myfile.html myfile.rst - JRST -t xdoc -o myfile.xml 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 disponnible à l'adresse suivante -http://jrst.labs.libre-entreprise.org/maven-jrst-plugin . Il permet l'utilisation +http://jrst.labs.libre-entreprise.org/maven-jrst-plugin. Il permet l'utilisation depuis maven de JRst.