Author: jpages Date: 2012-05-31 10:49:47 +0200 (Thu, 31 May 2012) New Revision: 691 Url: http://nuiton.org/repositories/revision/jrst/691 Log: Version finale de la documentation pour JRST 1.6 (correction de quelques coquilles) Ajout des fichiers sources pour les diagrammes (.dia) dans les ressources. Added: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/class-diagram.dia branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeGeneration.dia branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeSequence.dia 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/externalDoc.rst 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/diagrammeGeneration.png branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docDeveloppeur.rst branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docExterne.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/jrst-doc/src/site/en/rst/devel/developerDoc.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/developerDoc.rst 2012-05-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/developerDoc.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -50,7 +50,6 @@ Links : - * xml2rst.xsl (conversion from xml of docutils towards rst) : http://www.merten-home.de/FreeSoftware/xml2rst * dn2dbk.xsl (conversion from xml of docutils towards docbook) : http://membres.lycos.fr/ebellot/dn2dbk * nwalsh xsl (conversion from docbook towards FO and xhtml) : http://nwalsh.com * IText (conversion from HTML towards PDF) : http://itextpdf.com/ @@ -131,7 +130,7 @@ JRST --xslFile XSLfile, XSLfile2 RSTfile JRST process RST_ file, returned DocUtils_ XML will be transformed by JRSTgenerator Class -starting by XSLfile then XSL2file2... +starting by "XSLfile" then "XSL2file2". .. [1] `Cascading Style Sheets`_ .. [2] XSL documentation is available here_. Modified: branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/externalDoc.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/externalDoc.rst 2012-05-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/externalDoc.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -31,6 +31,6 @@ reStructured DTD : http://docutils.sourceforge.net/docs/ref/doctree.html -XSL used to convert the XML into RST : http://www.merten-home.de/FreeSoftware/xml2rst/ +XSL used to convert the XML into RST : http://docutils.sourceforge.net/sandbox/xml2rst/ To generate javadoc in RST form : http://java.sun.com/javase/6/docs/technotes/guides/javadoc/doclet/overview.h... 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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/devel/library.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -35,10 +35,10 @@ Dom4j_ is an easy to use, open source library for working with XML, XPath and XSLT on the Java platform using the Java Collections Framework and with full support for DOM, SAX and JAXP. -javax.xml.transform_ -==================== +Saxon_ +====== -Librairy used to the XSL transformation. +Saxon_ is an open source XSLT processor for Java. In this project, it is used to apply XSL stylesheets to XML. IText_ ====== @@ -53,7 +53,7 @@ DocUtils_ ========= -DocUtils_ is a set of Python scripts to transform RST_ files into useful formats, such as HTML, ODT, Latex and more. +DocUtils_ is a set of Python scripts to transform RST_ files into useful formats, such as HTML, ODT, Latex and more. Jython_ ======= @@ -63,7 +63,7 @@ .. _dom4j: http://www.dom4j.org -.. _javax.xml.transform: http://java.sun.com/javase/6/docs/api/javax/xml/transform/package-summary.ht... +.. _Saxon: http://java.sun.com/javase/6/docs/api/javax/xml/transform/package-summary.ht... .. _IText: http://itextpdf.com/ .. _Xmlunit: http://xmlunit.sourceforge.net/ .. _RST: http://docutils.sourceforge.net/rst.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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/index.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -42,7 +42,7 @@ 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 uses Jython_ and DocUtils_ to transform RST_ files to XML to create a tree representation +JRST uses Jython_ to execute DocUtils_ scripts to transform RST_ files to DocUtils XML to create a tree representation document. It becomes easy to generate document representation towards different formats. @@ -63,7 +63,7 @@ Several options are available : -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. +-t format, --outType format To specify exit format, so using generation XSL_ file(s). Several formats are available xhtml, docbook, xml, HTML, xdoc, pdf. -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 : 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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/en/rst/user/index.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -42,7 +42,7 @@ 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 uses Jython_ and DocUtils_ to transform RST_ files to XML to create a tree representation +JRST uses Jython_ to execute DocUtils_ scripts to transform RST_ files to DocUtils XML to create a tree representation document. It becomes easy to generate document representation towards different formats. @@ -63,7 +63,7 @@ Several options are available : -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. +-t format, --outType format To specify exit format, so using generation XSL_ file(s). Several formats are available xhtml, docbook, xml, HTML, xdoc, pdf. -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 : Added: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/class-diagram.dia =================================================================== (Binary files differ) Property changes on: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/class-diagram.dia ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeGeneration.dia =================================================================== (Binary files differ) Property changes on: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeGeneration.dia ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeGeneration.png =================================================================== (Binary files differ) Added: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeSequence.dia =================================================================== (Binary files differ) Property changes on: branches/jrst-docutils-jython/jrst-doc/src/site/resources/schemas/diagrammeSequence.dia ___________________________________________________________________ Added: svn:mime-type + application/octet-stream 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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docDeveloppeur.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -53,10 +53,9 @@ Référence : - * xml2rst.xsl (convertion de xml de docutils vers rst) : http://www.merten-home.de/FreeSoftware/xml2rst - * dn2dbk.xsl (convertion de xml de docutils vers docbook) : http://membres.lycos.fr/ebellot/dn2dbk - * les xsl de nwalsh (convertion de docbook vers FO et xhtml) : http://nwalsh.com - * IText (convertion de HTML vers PDF) : http://itextpdf.com/ + * dn2dbk.xsl (conversion de xml de docutils vers docbook) : http://membres.lycos.fr/ebellot/dn2dbk + * les xsl de nwalsh (conversion de docbook vers FO et xhtml) : http://nwalsh.com + * IText (conversion de HTML vers PDF) : http://itextpdf.com/ Exemple d'utilisation @@ -133,7 +132,7 @@ JRST --xslFile fichierXSL, fichierXSL2 fichierRST JRST traitera le fichierRST, le XML de DocUtils_ qui est retourné sera transformé par la Class JRSTgenerator -en commençant par le fichierXSL puis par le fichierXSL2... +en commençant par "fichierXSL" puis par "fichierXSL2". .. [1] `Cascading Style Sheets`_ .. [2] Une documentation sur le XSL est diponible ici_. Modified: branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docExterne.rst =================================================================== --- branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docExterne.rst 2012-05-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/docExterne.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -31,6 +31,6 @@ La DTD reStructuredText : http://docutils.sourceforge.net/docs/ref/doctree.html -Un XSL permettant de convertir le XML en RST : http://www.merten-home.de/FreeSoftware/xml2rst/ +Un XSL permettant de convertir le XML en RST : http://docutils.sourceforge.net/sandbox/xml2rst/ Pour la génération de la javaDoc en RST : http://java.sun.com/javase/6/docs/technotes/guides/javadoc/doclet/overview.h... 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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/devel/librairies.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -34,10 +34,10 @@ Dom4j_ est une API Open Source Java permettant de travailler avec XML, XPath et XSLT. Cette bibliothèque est compatible avec les standards DOM, SAX et JAXP. -javax.xml.transform_ -==================== +Saxon_ +====== -Librairie permettant la transformation XSL. +Saxon_ est une bibliothèque permettant d'effectuer des traitements XSLT. Dans ce projet, elle permet d'appliquer les feuilles de style XSL aux documents XML. IText_ ====== 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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/index.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -43,7 +43,7 @@ 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 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. +JRST utilise Jython_ pour lancer des scripts de DocUtils_ afin de transformer le RST_ en XML de DocUtils 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 @@ -64,7 +64,7 @@ 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. +-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, pdf. -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 : 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-31 08:02:14 UTC (rev 690) +++ branches/jrst-docutils-jython/jrst-doc/src/site/rst/user/index.rst 2012-05-31 08:49:47 UTC (rev 691) @@ -43,7 +43,7 @@ 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 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. +JRST utilise Jython_ pour lancer des scripts de DocUtils_ afin de transformer le RST_ en XML de DocUtils 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 @@ -64,7 +64,7 @@ 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. +-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, pdf. -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 :