Author: chatellier Date: 2009-01-14 10:40:26 +0000 (Wed, 14 Jan 2009) New Revision: 245 Added: maven-jrst-plugin/trunk/README.txt maven-jrst-plugin/trunk/changelog.txt maven-jrst-plugin/trunk/src/site/en/ maven-jrst-plugin/trunk/src/site/en/rst/ maven-jrst-plugin/trunk/src/site/en/rst/index.rst maven-jrst-plugin/trunk/src/site/site_en.xml maven-jrst-plugin/trunk/src/site/site_fr.xml Removed: maven-jrst-plugin/trunk/changelog maven-jrst-plugin/trunk/src/site/fr/rst/Todo.rst maven-jrst-plugin/trunk/src/site/site.xml Modified: maven-jrst-plugin/trunk/pom.xml maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java maven-jrst-plugin/trunk/src/site/fr/rst/index.rst Log: Update lutinproject and site. Add en site. Added: maven-jrst-plugin/trunk/README.txt =================================================================== --- maven-jrst-plugin/trunk/README.txt (rev 0) +++ maven-jrst-plugin/trunk/README.txt 2009-01-14 10:40:26 UTC (rev 245) @@ -0,0 +1,3 @@ +Maven JSRT Plugin +================= + Deleted: maven-jrst-plugin/trunk/changelog =================================================================== --- maven-jrst-plugin/trunk/changelog 2009-01-14 10:39:34 UTC (rev 244) +++ maven-jrst-plugin/trunk/changelog 2009-01-14 10:40:26 UTC (rev 245) @@ -1,8 +0,0 @@ -ver-0-8-3 thimel 200810XX - * 20081008 [chemit] refactor plugin to generate ony when required - * 20081008 [chemit] Using lutinpluginproject 3.0 in a better way :) - * 20081008 [chemit] add log4j.properties - * 20081008 [chemit] use a DirectoryScanner instead of FileAction since we do not want to parse scm admin files... - -ver-0-8-2 thimel 20080922 - * 20080922 [thimel] Using lutinpluginproject 3.0 Copied: maven-jrst-plugin/trunk/changelog.txt (from rev 243, maven-jrst-plugin/trunk/changelog) =================================================================== --- maven-jrst-plugin/trunk/changelog.txt (rev 0) +++ maven-jrst-plugin/trunk/changelog.txt 2009-01-14 10:40:26 UTC (rev 245) @@ -0,0 +1,8 @@ +ver-0-8-3 thimel 200810XX + * 20081008 [chemit] refactor plugin to generate ony when required + * 20081008 [chemit] Using lutinpluginproject 3.0 in a better way :) + * 20081008 [chemit] add log4j.properties + * 20081008 [chemit] use a DirectoryScanner instead of FileAction since we do not want to parse scm admin files... + +ver-0-8-2 thimel 20080922 + * 20080922 [thimel] Using lutinpluginproject 3.0 Property changes on: maven-jrst-plugin/trunk/changelog.txt ___________________________________________________________________ Name: svn:mergeinfo + Modified: maven-jrst-plugin/trunk/pom.xml =================================================================== --- maven-jrst-plugin/trunk/pom.xml 2009-01-14 10:39:34 UTC (rev 244) +++ maven-jrst-plugin/trunk/pom.xml 2009-01-14 10:40:26 UTC (rev 245) @@ -9,7 +9,7 @@ <parent> <groupId>org.codelutin</groupId> <artifactId>lutinpluginproject</artifactId> - <version>3.0</version> + <version>3.3</version> </parent> <!--groupId>org.codelutin</groupId--> @@ -19,7 +19,7 @@ <dependency> <groupId>org.codelutin</groupId> <artifactId>jrst</artifactId> - <version>0.8.3</version> + <version>0.8.4-SNAPSHOT</version> <scope>compile</scope> </dependency> <dependency> @@ -33,7 +33,7 @@ <!-- ************************************************************* --> <!-- *** Project Information ************************************* --> <!-- ************************************************************* --> - <name>Plugin maven JRst</name> + <name>Maven JRST Plugin</name> <version>0.8.4-SNAPSHOT</version> <description> Plugin pour maven2 pour la génération de xdoc à partir de fichiers RST. @@ -52,29 +52,10 @@ <!-- nom du projet sur le labs --> <labs.project>jrst</labs.project> + <!-- Site en et fr --> + <maven.site.locales>fr,en</maven.site.locales> </properties> - <build> - <plugins> - - <!-- plugin license switcher --> - <plugin> - <groupId>org.codelutin</groupId> - <artifactId>maven-license-switcher-plugin</artifactId> - <version>0.2</version> - <executions> - <execution> - <goals> - <goal>license</goal> - <goal>third-party</goal> - </goals> - </execution> - </executions> - </plugin> - - </plugins> - </build> - <!-- ************************************************************* --> <!-- *** Build Environment ************************************** --> <!-- ************************************************************* --> @@ -84,31 +65,5 @@ <url>${maven.scm.url}</url> </scm> - <!-- Maven Environment : profiles --> - <profiles> - <profile> - <id>license</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.codelutin</groupId> - <artifactId>maven-license-switcher-plugin</artifactId> - <version>0.2</version> - <executions> - <execution> - <goals> - <goal>switch</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> - </build> - </profile> - </profiles> - </project> Modified: maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java =================================================================== --- maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java 2009-01-14 10:39:34 UTC (rev 244) +++ maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java 2009-01-14 10:40:26 UTC (rev 245) @@ -40,22 +40,21 @@ import java.io.IOException; /** - * Génére du xdoc à partir de fichiers Rst. + * Transform rst site documentation into xdoc, to + * be used by maven * <p/> - * Les fichiers rst sont dans les repertoires: - * <li> src/site/fr/rst/ - * <li> src/site/en/rst/ - * <li> src/site/es/rst/ - * <li> ... - * <p/> - * et ils iront au final dans: - * <li> target/generated-rst/fr/xdoc/ - * <li> target/generated-rst/en/xdoc/ - * <li> target/generated-rst/es/xdoc/ - * <li> ... - * <p/> - * tous les autres fichiers iront dans target/generated-site en - * respectant la meme hierarchie de repertoire. + * RST file have to be located in: + * <li>src/site/en/rst/</li> + * <li>src/site/fr/rst/</li> + * <li>src/site/es/rst/</li> + * <li>...</li> + * and they will be generated in : + * <li>target/generated-site/xdoc/ (if <tt>en</tt> is default language)</li> + * <li>target/generated-site/fr/xdoc/</li> + * <li>target/generated-site/es/xdoc/</li> + * <li>...</li> + * All other files will be put on <tt>target/generated-site</tt> in + * same directory structure. * * @goal jrst * @phase pre-site Added: maven-jrst-plugin/trunk/src/site/en/rst/index.rst =================================================================== --- maven-jrst-plugin/trunk/src/site/en/rst/index.rst (rev 0) +++ maven-jrst-plugin/trunk/src/site/en/rst/index.rst 2009-01-14 10:40:26 UTC (rev 245) @@ -0,0 +1,102 @@ +Home +==== + +.. contents:: + +Presentation +------------ + +Maven plugin to use JRST library. + + +Operation +--------- + +Maven can't manage RST documentation file format. So, that's +why maven-jrst-plugin has been made. + +It use the same directory structure for site sources, transform +it into xdoc, and maven-site-plugin is used to build finale site. + +But, pom has to be configured: + - to pre generate xdoc file from rst + - change maven default site directory + + +POM configuration +----------------- + +pre-site : maven-jrst-plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + <plugin> + <groupId>org.codelutin</groupId> + <artifactId>maven-jrst-plugin</artifactId> + <version>${jrst.version}</version> + <configuration> + <directoryIn>${basedir}/src/site</directoryIn> + <directoryOut>${project.build.directory}/generated-site</directoryOut> + <defaultLocale>en</defaultLocale> + <inputEncoding>UTF-8</inputEncoding> + <outputEncoding>UTF-8</outputEncoding> + </configuration> + <executions> + <execution> + <phase>pre-site</phase> + <goals> + <goal>jrst</goal> + </goals> + </execution> + </executions> + </plugin> + + +pre-site : maven-antrun-plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This plugin is used to copy non rst files (such as images...) +into the generation site directory. + +:: + + <plugin> + <artifactId>maven-antrun-plugin</artifactId> + <executions> + <execution> + <phase>pre-site</phase> + <configuration> + <tasks> + <mkdir dir="${basedir}/src/site"/> + <copy todir="${project.build.directory}/generated-site" verbose="${maven.verbose}" overwrite="false"> + <fileset dir="${basedir}/src/site"> + <exclude name="**/rst/**"/> + </fileset> + </copy> + </tasks> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + + +site : maven-site-plugin +~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + <plugin> + <artifactId>maven-site-plugin</artifactId> + <version>2.0-beta-7</version> + <configuration> + <siteDirectory>${project.build.directory}/generated-site</siteDirectory> + <inputEncoding>UTF-8</inputEncoding> + <outputEncoding>UTF-8</outputEncoding> + <generateReports>true</generateReports> + <locales>en,fr</locales> + </configuration> + </plugin> \ No newline at end of file Deleted: maven-jrst-plugin/trunk/src/site/fr/rst/Todo.rst =================================================================== --- maven-jrst-plugin/trunk/src/site/fr/rst/Todo.rst 2009-01-14 10:39:34 UTC (rev 244) +++ maven-jrst-plugin/trunk/src/site/fr/rst/Todo.rst 2009-01-14 10:40:26 UTC (rev 245) @@ -1,2 +0,0 @@ -TODO -==== \ No newline at end of file Modified: maven-jrst-plugin/trunk/src/site/fr/rst/index.rst =================================================================== --- maven-jrst-plugin/trunk/src/site/fr/rst/index.rst 2009-01-14 10:39:34 UTC (rev 244) +++ maven-jrst-plugin/trunk/src/site/fr/rst/index.rst 2009-01-14 10:40:26 UTC (rev 245) @@ -1,13 +1,102 @@ -maven-jrst-plugin -================= +Accueil +======= .. contents:: - Présentation ------------ -Le plugin maven pour utiliser la librairie jrst TODO +Le plugin maven pour utiliser la librairie jrst. -**Veuillez consulter la JavaDoc pour de plus ample détails sur les différentes -librairies.** +Fonctionnement +-------------- + +Maven ne gere pas le RST par defaut, voilà pourquoi le plugin +maven-jrst-plugin a été développé. + +Il utilise donc une structure similaire des sources des sites +maven, mais les transforme en xdoc, et passe ensuite le relai +à maven. + +Le pom, doit doit être configuré pour : + - demander la génération des fichiers xdoc + - changer le répertoire par défaut des sources du site + + +Configuration du pom +-------------------- + +pre-site : maven-jrst-plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + <plugin> + <groupId>org.codelutin</groupId> + <artifactId>maven-jrst-plugin</artifactId> + <version>${jrst.version}</version> + <configuration> + <directoryIn>${basedir}/src/site</directoryIn> + <directoryOut>${project.build.directory}/generated-site</directoryOut> + <defaultLocale>fr</defaultLocale> + <inputEncoding>UTF-8</inputEncoding> + <outputEncoding>UTF-8</outputEncoding> + </configuration> + <executions> + <execution> + <phase>pre-site</phase> + <goals> + <goal>jrst</goal> + </goals> + </execution> + </executions> + </plugin> + + +pre-site : maven-antrun-plugin +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Ce plugin est utilisé pour copier les fichier "non-rst" +dans le répertoire de generation de site. + +:: + + <plugin> + <artifactId>maven-antrun-plugin</artifactId> + <executions> + <execution> + <phase>pre-site</phase> + <configuration> + <tasks> + <mkdir dir="${basedir}/src/site"/> + <copy todir="${project.build.directory}/generated-site" verbose="${maven.verbose}" overwrite="false"> + <fileset dir="${basedir}/src/site"> + <exclude name="**/rst/**"/> + </fileset> + </copy> + </tasks> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + + +site : maven-site-plugin +~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + <plugin> + <artifactId>maven-site-plugin</artifactId> + <version>2.0-beta-7</version> + <configuration> + <siteDirectory>${project.build.directory}/generated-site</siteDirectory> + <inputEncoding>UTF-8</inputEncoding> + <outputEncoding>UTF-8</outputEncoding> + <generateReports>true</generateReports> + <locales>fr,en</locales> + </configuration> + </plugin> \ No newline at end of file Deleted: maven-jrst-plugin/trunk/src/site/site.xml =================================================================== --- maven-jrst-plugin/trunk/src/site/site.xml 2009-01-14 10:39:34 UTC (rev 244) +++ maven-jrst-plugin/trunk/src/site/site.xml 2009-01-14 10:40:26 UTC (rev 245) @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project name="${project.name}"> - - <publishDate format="dd/MM/yyyy"/> - - <skin> - <groupId>org.codelutin</groupId> - <artifactId>maven-lutin-skin</artifactId> - <version>0.2.1</version> - </skin> - - <bannerLeft> - <name>${project.name}</name> - </bannerLeft> - - <bannerRight> - <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> - <href>${project.organization.url}</href> - </bannerRight> - - <poweredBy> - <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> - <logo href="http://jrst.labs.libre-entreprise.org" name="JRst" img="images/jrst-logo.png"/> - <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" - img="images/restructuredtext-logo.png"/> - </poweredBy> - - <body> - <links> - <item name="Labs" href="http://labs.libre-entreprise.org/"/> - <item name="${project.organization.name}" href="${project.organization.url}"/> - </links> - - <menu ref="parent"/> - <menu name="Utilisateur"> - <item name="Accueil" href="index.html"/> - <item name="Détail des goals" href="plugin-info.html"> - <item name="jrst:jrst" href="jrst-mojo.html"/> - <item name="jrst:help" href="help-mojo.html"/> - </item> - </menu> - - <menu name="Téléchargement"> - <item href="${labs.builder.url}/org/codelutin/${project.artifactId}/${project.version}" - name="Télécharger la dernière version"/> - <item href="${labs.builder.url}/org/codelutin/${project.artifactId}" - name="Voir toutes les versions"/> - </menu> - - <menu name="Développeur"> - <item name="A faire" href="Todo.html"/> - </menu> - - <menu ref="reports"/> - - </body> -</project> Added: maven-jrst-plugin/trunk/src/site/site_en.xml =================================================================== --- maven-jrst-plugin/trunk/src/site/site_en.xml (rev 0) +++ maven-jrst-plugin/trunk/src/site/site_en.xml 2009-01-14 10:40:26 UTC (rev 245) @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <skin> + <groupId>org.codelutin</groupId> + <artifactId>maven-lutin-skin</artifactId> + <version>0.2.1</version> + </skin> + + <bannerLeft> + <name>${project.name}</name> + </bannerLeft> + + <bannerRight> + <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> + <href>${project.organization.url}</href> + </bannerRight> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> + <logo href="http://jrst.labs.libre-entreprise.org" name="JRst" img="images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" + img="images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + <links> + <item name="Labs" href="http://labs.libre-entreprise.org/"/> + <item name="${project.organization.name}" href="${project.organization.url}"/> + <item name="[fr" href="../index.html"/> + <item name="en]" href="index.html"/> + </links> + + <!--menu ref="parent"/ --> + + <menu name="Users"> + <item name="Home" href="index.html"/> + <item name="Goals" href="plugin-info.html"> + <item name="jrst:jrst" href="jrst-mojo.html"/> + <item name="jrst:help" href="help-mojo.html"/> + </item> + </menu> + + <menu name="Download"> + <item href="${labs.builder.url}/org/codelutin/${project.artifactId}/${project.version}" + name="Last version"/> + <item href="${labs.builder.url}/org/codelutin/${project.artifactId}" + name="All versions"/> + </menu> + + <!--menu name="Developper"> + <item name="TODO" href="Todo.html"/> + </menu--> + + <menu ref="reports"/> + + </body> +</project> Copied: maven-jrst-plugin/trunk/src/site/site_fr.xml (from rev 243, maven-jrst-plugin/trunk/src/site/site.xml) =================================================================== --- maven-jrst-plugin/trunk/src/site/site_fr.xml (rev 0) +++ maven-jrst-plugin/trunk/src/site/site_fr.xml 2009-01-14 10:40:26 UTC (rev 245) @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <publishDate format="dd/MM/yyyy"/> + + <skin> + <groupId>org.codelutin</groupId> + <artifactId>maven-lutin-skin</artifactId> + <version>0.2.1</version> + </skin> + + <bannerLeft> + <name>${project.name}</name> + </bannerLeft> + + <bannerRight> + <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> + <href>${project.organization.url}</href> + </bannerRight> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> + <logo href="http://jrst.labs.libre-entreprise.org" name="JRst" img="images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" + img="images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + <links> + <item name="Labs" href="http://labs.libre-entreprise.org/"/> + <item name="${project.organization.name}" href="${project.organization.url}"/> + <item name="[fr" href="index.html"/> + <item name="en]" href="en/index.html"/> + </links> + + <!--menu ref="parent"/ --> + + <menu name="Utilisateur"> + <item name="Accueil" href="index.html"/> + <item name="Détail des goals" href="plugin-info.html"> + <item name="jrst:jrst" href="jrst-mojo.html"/> + <item name="jrst:help" href="help-mojo.html"/> + </item> + </menu> + + <menu name="Téléchargement"> + <item href="${labs.builder.url}/org/codelutin/${project.artifactId}/${project.version}" + name="Dernière version"/> + <item href="${labs.builder.url}/org/codelutin/${project.artifactId}" + name="Toutes les versions"/> + </menu> + + <!--menu name="Développeur"> + <item name="A faire" href="Todo.html"/> + </menu--> + + <menu ref="reports"/> + + </body> +</project> Property changes on: maven-jrst-plugin/trunk/src/site/site_fr.xml ___________________________________________________________________ Name: svn:keywords + Author Date Id Revision Name: svn:mergeinfo + Name: svn:eol-style + native