Author: tchemit Date: 2009-08-23 16:24:15 +0200 (Sun, 23 Aug 2009) New Revision: 401 Added: trunk/maven-jrst-plugin/src/site/apt/ trunk/maven-jrst-plugin/src/site/apt/index.apt trunk/maven-jrst-plugin/src/site/en/apt/ trunk/maven-jrst-plugin/src/site/en/apt/index.apt Modified: trunk/maven-jrst-plugin/ trunk/maven-jrst-plugin/src/site/site.xml trunk/maven-jrst-plugin/src/site/site_en.xml Log: no use of jrst for doc (still not available before doxia-jrst-module) Property changes on: trunk/maven-jrst-plugin ___________________________________________________________________ Modified: svn:ignore - target .classpath .project .settings *.ipr *.iws + *.ipr *.iws .classpath .project target nbactions.xml .settings Copied: trunk/maven-jrst-plugin/src/site/apt/index.apt (from rev 396, trunk/maven-jrst-plugin/src/site/rst/index.rst) =================================================================== --- trunk/maven-jrst-plugin/src/site/apt/index.apt (rev 0) +++ trunk/maven-jrst-plugin/src/site/apt/index.apt 2009-08-23 14:24:15 UTC (rev 401) @@ -0,0 +1,103 @@ +---- +Maven-jrst-plugin +---- +---- +2009-08-23 +---- + +Présentation + + Le plugin maven2 pour utiliser la librairie jrst. + +Fonctionnement + + Maven ne gère pas le RST par défaut, 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>${maven-jrst-plugin.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 fichiers "non-rst" + dans le répertoire de génération 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> + <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> + +----------------------------------------------------------------------------------- Copied: trunk/maven-jrst-plugin/src/site/en/apt/index.apt (from rev 396, trunk/maven-jrst-plugin/src/site/en/rst/index.rst) =================================================================== --- trunk/maven-jrst-plugin/src/site/en/apt/index.apt (rev 0) +++ trunk/maven-jrst-plugin/src/site/en/apt/index.apt 2009-08-23 14:24:15 UTC (rev 401) @@ -0,0 +1,98 @@ +---- +Maven-jrst-plugin +---- +---- +2009-08-23 +---- + +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> +-------------------------------------------------------------------------------------- Property changes on: trunk/maven-jrst-plugin/src/site/en/apt/index.apt ___________________________________________________________________ Added: svn:mergeinfo + Modified: trunk/maven-jrst-plugin/src/site/site.xml =================================================================== --- trunk/maven-jrst-plugin/src/site/site.xml 2009-08-23 14:23:56 UTC (rev 400) +++ trunk/maven-jrst-plugin/src/site/site.xml 2009-08-23 14:24:15 UTC (rev 401) @@ -1,24 +1,11 @@ <?xml version="1.0" encoding="UTF-8"?> <project name="${project.name}"> - <publishDate format="dd/MM/yyyy"/> - - <skin> - <groupId>org.nuiton</groupId> - <artifactId>maven-nuiton-skin</artifactId> - <version>1.0.0</version> - </skin> - <bannerLeft> <name>${project.name}</name> <href>/</href> </bannerLeft> - <bannerRight> - <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> - <href>${project.organization.url}</href> - </bannerRight> - <body> <breadcrumbs> @@ -36,11 +23,11 @@ </menu> <menu name="Téléchargement"> - <item href="${repository.home.url}/org/nuiton/${project.artifactId}/${project.version}/${project.build.finalName}.jar" + <item href="${repository.home.url}/org/nuiton/jrst/${project.artifactId}/${project.version}/${project.build.finalName}.jar" name="Librairie (jar)"/> - <item href="${repository.home.url}/org/nuiton/${project.artifactId}/${project.version}/${project.build.finalName}-javadoc.jar" + <item href="${repository.home.url}/org/nuiton/jrst/${project.artifactId}/${project.version}/${project.build.finalName}-javadoc.jar" name="Javadoc (jar)"/> - <item href="${repository.home.url}/org/nuiton/${project.artifactId}/${project.version}/${project.build.finalName}-sources.jar" + <item href="${repository.home.url}/org/nuiton/jrst/${project.artifactId}/${project.version}/${project.build.finalName}-sources.jar" name="Sources (jar)"/> </menu> Modified: trunk/maven-jrst-plugin/src/site/site_en.xml =================================================================== --- trunk/maven-jrst-plugin/src/site/site_en.xml 2009-08-23 14:23:56 UTC (rev 400) +++ trunk/maven-jrst-plugin/src/site/site_en.xml 2009-08-23 14:24:15 UTC (rev 401) @@ -1,22 +1,11 @@ <?xml version="1.0" encoding="UTF-8"?> <project name="${project.name}"> - <skin> - <groupId>org.nuiton</groupId> - <artifactId>maven-nuiton-skin</artifactId> - <version>1.0.0</version> - </skin> - <bannerLeft> <name>${project.name}</name> - <href>/</href> + <href>index.html</href> </bannerLeft> - <bannerRight> - <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> - <href>${project.organization.url}</href> - </bannerRight> - <body> <breadcrumbs> @@ -34,11 +23,11 @@ </menu> <menu name="Download"> - <item href="${repository.home.url}/org/nuiton/${project.artifactId}/${project.version}/${project.build.finalName}.jar" + <item href="${repository.home.url}/org/nuiton/jrst/${project.artifactId}/${project.version}/${project.build.finalName}.jar" name="Library (jar)"/> - <item href="${repository.home.url}/org/nuiton/${project.artifactId}/${project.version}/${project.build.finalName}-javadoc.jar" + <item href="${repository.home.url}/org/nuiton/jrst/${project.artifactId}/${project.version}/${project.build.finalName}-javadoc.jar" name="Javadoc (jar)"/> - <item href="${repository.home.url}/org/nuiton/${project.artifactId}/${project.version}/${project.build.finalName}-sources.jar" + <item href="${repository.home.url}/org/nuiton/jrst/${project.artifactId}/${project.version}/${project.build.finalName}-sources.jar" name="Sources (jar)"/> </menu>