Author: jpages Date: 2012-05-21 09:17:23 +0200 (Mon, 21 May 2012) New Revision: 668 Url: http://nuiton.org/repositories/revision/jrst/668 Log: Mise ?\195?\160 jour de la documentation pour prendre en compte les modifications apport?\195?\169es avec Jython et Docutils. Modified: branches/jrst-docutils-jython/doxia-module-jrst/src/main/java/org/nuiton/jrst/JrstParser.java branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/developerDoc.rst branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/images/DiagrammeClass.png branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/images/DiagrammeSequance.png branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/library.rst branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/index.rst branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/user/index.rst branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeClass.png branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeSequence.png branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docDeveloppeur.rst branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/librairies.rst branches/jrst-docutils-jython/jrst-doc/src/site/rst/index.rst branches/jrst-docutils-jython/jrst-doc/src/site/rst/user/index.rst Modified: branches/jrst-docutils-jython/doxia-module-jrst/src/main/java/org/nuiton/jrst/JrstParser.java =================================================================== --- branches/jrst-docutils-jython/doxia-module-jrst/src/main/java/org/nuiton/jrst/JrstParser.java 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/doxia-module-jrst/src/main/java/org/nuiton/jrst/JrstParser.java 2012-05-21 07:17:23 UTC (rev 668) @@ -49,6 +49,7 @@ * @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="jrst" */ public class JrstParser extends XdocParser { + protected static Log log = LogFactory.getLog(JRST.class); @Override public void parse(Reader source, Sink sink) throws ParseException { Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/developerDoc.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/developerDoc.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/developerDoc.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -33,25 +33,11 @@ |classDiagramme| -AdvencedReader Class is used to easily read RST_ file using specifics methods: - - String readLine() : return a line. - - String[] readLines(int nb) : return nb lines - - String[] readWhile(Pattern p) : return lines while they match to the pattern - ... +La classe **JRST** contient la méthode main(), elle gère les options, la lecture et l'écriture des fichiers. Elle appelle dans un premier temps la classe **PythonInterpreter** de Jython_ permettant d'exécuter les scripts en Python de DocUtils_ pour générer un fichier XML intermédiaire. Ensuite, il ne reste qu'à appliquer le XSL désiré (si besoin) grâce à la classe **JRSTGenerator**. -**JRSTLexer** Class uses **AdvencedReader** to build XML file, it browses all document to isolate the data types, parameters -and content, so assembling all usefuls informations to build the final XML. It will start by document's head (peekHeader(), -peekDocInfo()), and finally peeking on the body (peekBody()). -**JRSTReader** Class uses **JRSTLexer**, it interprets the returned XML to build the final XML. This one is conform to the Docutils_ -DTD. This Class sometimes needs to be called itself when a document part must be interpreted independently of rest. For exemple, -if a table contains a list, we extract the cell's informations for being interpreted. Admonition's content must be considered like an -independant document. When generation is finished, Class **JRSTReader** build summary (composeContent()) and parse all the inline -specificities (inline()), like, italic or bold words, links, footnotes... All that can appear inside a line. +**JRST** Class contents main() method, it's looking after options, files reading and writing. Iinitially, it calls Jython_ class **PythonInterpreter** which allows to execute DocUtils' Python script to generate an intermediate file. Then it only remains to apply the wish XSL (if needed) by using **JRSTGenerator** Class. -**JRST** Class contents main() method, it's looking after options, files reading and writing. It reads document, parses -it with **JRSTReader** Class and transforms with the wish XSL (if needed) by using **JRSTGenerator** Class. - Generation ========== @@ -154,6 +140,7 @@ .. _RST: http://docutils.sourceforge.net/rst.html .. _Cascading Style Sheets: http://en.wikipedia.org/wiki/Cascading_Style_Sheets .. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html .. |diagrammegeneration| image:: images/diagrammeGeneration.png .. |classDiagramme| image:: images/DiagrammeClass.png -.. |sequenceDiagramme| image:: images/DiagrammeSequence.png \ No newline at end of file +.. |sequenceDiagramme| image:: images/DiagrammeSequence.png Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/images/DiagrammeClass.png =================================================================== (Binary files differ) Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/images/DiagrammeSequance.png =================================================================== (Binary files differ) Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/library.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/library.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/library.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -49,7 +49,22 @@ Xmlunit_ used to compare two XML files to show their differences. +DocUtils_ +========= + +DocUtils_ is a set of scripts to transform RST_ files into useful formats, such as HTML, ODT, Latex and more. + +Jython_ +======= + +Jython_ is a Python interpreter for Java. Here, it allows to execute DocUtils_ scripts. + + + .. _dom4j: http://www.dom4j.org .. _javax.xml.transform: http://java.sun.com/javase/6/docs/api/javax/xml/transform/package-summary.ht... .. _SDoc: http://sdoc.sourceforge.net/wiki/pmwiki.php .. _Xmlunit: http://xmlunit.sourceforge.net/ +.. _RST: http://docutils.sourceforge.net/rst.html +.. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/index.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/index.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/index.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -22,6 +22,7 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - + =============================== reStructuredText_ parser : JRst =============================== @@ -41,14 +42,14 @@ documents, becomes useless when it is used to quickly creating a simple document. RST has a so simple syntax that it becomes almost invisible. -JRST is a Java ReStructuredText_ parser enabling to create a tree representation +JRST uses Jython_ and DocUtils_ to transform RST_ files to XML to create a tree representation document. It becomes easy to generate document representation towards differents fomats. How to use it ------------- -JRST parser takes a reStructuredText_ file and generates XML file. Which could be used to produce +JRST 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]_. @@ -92,8 +93,11 @@ .. [1] Only html, xhtml, DocBook_, xdoc and pdf are available for the moment. -.. _reStructuredText: RSTpresentation.html +.. _reStructuredText: ./user/RSTpresentation.html +.. _RST: ./user/RSTpresentation.html .. _Maven: http://maven.apache.org/ .. _XSL: ./devel/XSLpresentation.html .. _DocBook: http://www.docbook.org/ .. _LaTex: http://www.latex-project.org/ +.. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/user/index.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/user/index.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/user/index.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -22,6 +22,7 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - + =============================== reStructuredText_ parser : JRst =============================== @@ -41,14 +42,14 @@ documents, becomes useless when it is used to quickly creating a simple document. RST has a so simple syntax that it becomes almost invisible. -JRST is a Java ReStructuredText_ parser enabling to create a tree representation +JRST uses Jython_ and DocUtils_ to transform RST_ files to XML to create a tree representation document. It becomes easy to generate document representation towards differents fomats. How to use it ------------- -JRST parser takes a reStructuredText_ file and generates XML file. Which could be used to produce +JRST 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]_. @@ -92,8 +93,11 @@ .. [1] Only html, xhtml, DocBook_, xdoc and pdf are available for the moment. -.. _reStructuredText: RSTpresentation.html +.. _reStructuredText: ./user/RSTpresentation.html +.. _RST: ./user/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/ +.. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html Modified: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeClass.png =================================================================== (Binary files differ) Modified: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeSequence.png =================================================================== (Binary files differ) Modified: branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docDeveloppeur.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docDeveloppeur.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docDeveloppeur.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -22,6 +22,7 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - + ========================= Documentation développeur ========================= @@ -35,20 +36,8 @@ :alt: Diagramme de classes :align: center -La Class **AdvancedReader** à pour fonction de faciliter la lecture du fichier RST_ grâce à différentes méthodes : - - String readLine() : renvoie une ligne - - String[] readLines(int nombresLigne) : renvoie un certain nombre de lignes - - Stringn[] readWhile(Pattern p) : renvoie les lignes tant qu'elles correspondent au pattern - ... +La classe **JRST** contient la méthode main(), elle gère les options, la lecture et l'écriture des fichiers. Elle appelle dans un premier temps la classe **PythonInterpreter** de Jython_ permettant d'exécuter les scripts en Python de DocUtils_ pour générer un fichier XML intermédiaire. Ensuite, il ne reste qu'à appliquer le XSL désiré (si besoin) grâce à la classe **JRSTGenerator**. -La Class **JRSTLexer** utilise **AdvancedReader** pour construire un fichier XML, il parcours l'ensemble du document pour isoler les types de données, leurs paramètres et leurs contenus, donc rassembler toutes les informations utiles à la mise en forme du XML final. Il va commencer par l'entête du document (peekHeader(), peekDocInfo()) pour ensuite s'intéresser au corps (peekBody()). - -La Class **JRSTReader** utilise **JRSTLexer**, il interprète le XML qui lui est renvoyé pour construire le XML final. Celui-ci est conforme à la DTD définie par DocUtils_. Cette Class à parfois besoin de s'appeler elle même lorsque une partie du document doit être interprétée indépendamment du reste. Par exemple, s'il y a une liste dans une case d'un tableau, l'on extrait les informations de la case et on les interprètes, le contenu d'une admoniton (une note) doit lui aussi être considéré comme un document indépendant. Lorsque la génération est terminée, la Class compose le sommaire (composeContent()) puis s'occupe de toutes les spécificités « inline » (inline()), comme par exemple les mots en italique ou gras, les références, les footnotes... Tout ce qui peut apparaître à l'intérieur d'une ligne. - -La Class **reStructuredText** référence toutes les variables nécessaires à la génération du XML final. - -La Class **JRST** contient la méthode main(), elle gère les options, la lecture et l'écriture des fichiers. Elle lit le document, le parse grâce à la class **JRSTReader** puis applique le XSL désiré (si besoin) grâce à la class **JRSTGenerator**. - La génération ============= @@ -154,4 +143,5 @@ .. _Cascading Style Sheets: http://fr.wikipedia.org/wiki/Feuilles_de_style_en_cascade .. _RST: http://docutils.sourceforge.net/rst.html .. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html Modified: branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/librairies.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/librairies.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/librairies.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -22,6 +22,7 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - + ==================================== Les différentes librairies utilisées ==================================== @@ -48,7 +49,20 @@ Xmlunit_ permet de comparer deux fichiers XML pour mettre en évidences les différences. +DocUtils_ +========= + +DocUtils_ est un ensemble de scripts permettant de transformer des fichiers RST_ en formats plus répendus comme le HTML, ODT, Latex et bien plus encore. + +Jython_ +======= + +Jython_ est un interprète Python en Java. Ici, il permet d'exécuter les scripts de DocUtils_. + .. _dom4j: http://www.dom4j.org .. _javax.xml.transform: http://java.sun.com/javase/6/docs/api/javax/xml/transform/package-summary.ht... .. _SDoc: http://sdoc.sourceforge.net/wiki/pmwiki.php -.. _Xmlunit: http://xmlunit.sourceforge.net/ \ No newline at end of file +.. _Xmlunit: http://xmlunit.sourceforge.net/ +.. _RST: http://docutils.sourceforge.net/rst.html +.. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html Modified: branches/jrst-docutils-jython/jrst-doc/src/site/rst/index.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/rst/index.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/index.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -22,6 +22,7 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - + =================================== Parseur reStructuredText_ : le JRst =================================== @@ -42,15 +43,13 @@ 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. +JRST utilise Jython_ et DocUtils_ pour transformer le RST_ en XML 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 +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_, le odt (Open-Office), le rtf, ou encore le XML [1]_. @@ -98,8 +97,11 @@ .. [1] Seul les formats html, xhtml, DocBook_, xdoc et pdf sont disponible pour le moment. -.. _reStructuredText: presentationRST.html +.. _reStructuredText: ./user/presentationRST.html +.. _RST: ./user/presentationRST.html .. _Maven: http://maven.apache.org/ .. _XSL: ./devel/presentationXSL.html .. _DocBook: http://www.docbook.org/ -.. _LaTex: http://www.latex-project.org/ \ No newline at end of file +.. _LaTex: http://www.latex-project.org/ +.. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html Modified: branches/jrst-docutils-jython/jrst-doc/src/site/rst/user/index.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/rst/user/index.rst 2012-05-16 13:47:36 UTC (rev 667) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/user/index.rst 2012-05-21 07:17:23 UTC (rev 668) @@ -22,6 +22,7 @@ .. * <http://www.gnu.org/licenses/lgpl-3.0.html>. .. * #L% .. - + =================================== Parseur reStructuredText_ : le JRst =================================== @@ -42,15 +43,13 @@ 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. +JRST utilise Jython_ et DocUtils_ pour transformer le RST_ en XML 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 +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_, le odt (Open-Office), le rtf, ou encore le XML [1]_. @@ -98,8 +97,11 @@ .. [1] Seul les formats html, xhtml, DocBook_, xdoc et pdf sont disponible pour le moment. -.. _reStructuredText: presentationRST.html +.. _reStructuredText: ./user/presentationRST.html +.. _RST: ./user/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 +.. _LaTex: http://www.latex-project.org/ +.. _DocUtils: http://docutils.sourceforge.net/docs/ref/doctree.html +.. _Jython: http://jython.org/index.html