Index: jrst2/src/site/fr/rst/index.rst diff -u jrst2/src/site/fr/rst/index.rst:1.1 jrst2/src/site/fr/rst/index.rst:1.2 --- jrst2/src/site/fr/rst/index.rst:1.1 Tue Jun 5 15:52:14 2007 +++ jrst2/src/site/fr/rst/index.rst Wed Jun 6 12:21:27 2007 @@ -1,6 +1,6 @@ -================================== -Parseur reStructuredText : le JRst -================================== +=================================== +Parseur reStructuredText_ : le JRst +=================================== Documentation utilisateur ========================= @@ -11,14 +11,14 @@ 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 +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 +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 +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. @@ -26,7 +26,10 @@ 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. +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 [1]_. :: @@ -35,9 +38,9 @@ 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. +-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 : @@ -58,12 +61,21 @@ 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à. +Cette commande produira un fichier html (myfile.html) à partir du fichier reStructuredText_ (myfile.rst) +même si myfile.html existe déjà. -Plugin maven ------------- +Plugin Maven_ +------------- -Un plugin maven est disponnible à l'adresse suivante +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. +depuis Maven_ de JRst. + +.. [1] Seul les formats html, xhtml, DocBook_, xdoc et pdf sont disponible pour le moment. + +.. _reStructuredText: presentationRST.html +.. _Maven: http://maven.apache.org/ +.. _XSL: http://jrst.labs.libre-entreprise.org/fr/devel/presentationXSL.rst +.. _DocBook: http://www.docbook.org/ +.. _LaTex: http://www.latex-project.org/ \ No newline at end of file