Index: jrst2/src/site/en/rst/user/index.rst diff -u jrst2/src/site/en/rst/user/index.rst:1.1 jrst2/src/site/en/rst/user/index.rst:1.2 --- jrst2/src/site/en/rst/user/index.rst:1.1 Tue Jun 5 15:52:14 2007 +++ jrst2/src/site/en/rst/user/index.rst Wed Jun 6 12:21:28 2007 @@ -1,37 +1,75 @@ -JRst -==== +=============================== +reStructuredText_ parser : JRst +=============================== + +Documentation utilisateur +========================= .. contents:: -Présentation +Presentation ------------ -JRst is Java ReStructuredText parser. +reStructuredText_ format is a document description format. Like other LaTex_ +or DocBook_, it can be converted toward a multitude of formats. These formats +have usually invading syntax which, if it is necessary for very specific +documents, becomes useless when it is used to quickly creating a simple +document. RST has a so simple syntax that it becomes almost invisible. -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. +JRST is a Java ReStructuredText_ parser enabling to create a tree representation +document. It becomes easy to generate document representation towards differents +fomats. -Usage ------ +How to use it +------------- -To generate python docutils xml just write:: +JRST parser takes a reStructuredText_ file and generates XML file. Which could be used to produce +various files formats with generation XSL_ files. The available output formats are HTML, xhtml, +rst, pdf, docbook, odt(Open-Office), rtf, or XML [1]_. - JRST myfile.rst +:: -To generate html:: + JRST myfile.rst - JRST -t html myfile.rst +This command converts myfile.rst toward XML file, displayed to the standard output (console). +Several options are available : -To generate in specified file:: +-o file,--outFile=file to write toward a file. +-t format,--outType format to specify exit format, so using generation XSL_ file(s). Several formats are available xhtml, docbook, xml, HTML, xdoc, rst, pdf, odt, rtf. +-x xslFile,--xslFile xslFile to specify generation XSL_ file at using. +--force to overwrite, if file exists, it will be replaced by the new one. +--help to display available options : - JRST -t xdoc -o myfile.xml myfile.rst +:: + 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 -Plugin maven ------------- +ex : + +:: + + JRST --force -t html -o myfile.html myfile.rst + +This command produces html file (myfile.html) from rst file (myfile.rst) +even if myfile.html already exists. + + +Maven_ Plugin +------------- + +Maven_ plugin is available at the following links : http://jrst.labs.libre-entreprise.org/maven-jrst-plugin. +It enables the use of JRST from Maven_. + +.. [1] Only html, xhtml, DocBook_, xdoc and pdf are available for the moment. -Un plugin maven est disponnible à l'adresse suivante -http://jrst.labs.libre-entreprise.org/maven-jrst-plugin . Il permet l'utilisation -depuis maven de JRst. +.. _reStructuredText: RSTpresentation.html +.. _Maven: http://maven.apache.org/ +.. _XSL: http://jrst.labs.libre-entreprise.org/en/devel/XSLpresentation.rst +.. _DocBook: http://www.docbook.org/ +.. _LaTex: http://www.latex-project.org/ Index: jrst2/src/site/en/rst/user/RSTpresentation.rst diff -u jrst2/src/site/en/rst/user/RSTpresentation.rst:1.1 jrst2/src/site/en/rst/user/RSTpresentation.rst:1.2 --- jrst2/src/site/en/rst/user/RSTpresentation.rst:1.1 Tue Jun 5 15:52:14 2007 +++ jrst2/src/site/en/rst/user/RSTpresentation.rst Wed Jun 6 12:21:28 2007 @@ -167,13 +167,13 @@ Results in: - * a bullet point using "*" +* a bullet point using "*" - - a sub-list using "-" + - a sub-list using "-" - + yet another sub-list + + yet another sub-list - - another item + - another item **definition** lists (quickref__) @@ -212,7 +212,7 @@ block is finished when the text falls back to the same indentation level as a paragraph prior to the preformatted block. For example:: -An example:: + An example:: Whitespace, newlines, blank lines, and all kinds of markup (like *this* or \this) is preserved by literal blocks. @@ -221,12 +221,12 @@ Results in: - An example:: +An example:: - Whitespace, newlines, blank lines, and all kinds of markup - (like *this* or \this) is preserved by literal blocks. + Whitespace, newlines, blank lines, and all kinds of markup + (like *this* or \this) is preserved by literal blocks. - no more example +no more example Note that if a paragraph consists only of "``::``", then it's removed from the output::