[hibernate-commits] Hibernate SVN: r11704 - in trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin: src and 4 other directories.

Author: steve.ebersole(a)jboss.com Date: 2007-06-24 00:08:36 -0400 (Sun, 24 Jun 2007) New Revision: 11704 Added: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/DocBookSupportResourcesMojo.java trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/examples/ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/index.apt trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/usage.apt trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/site.xml Modified: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/pom.xml trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/GenerationMojo.java trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/PackageMojo.java trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/ResourceMojo.java trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/resources/META-INF/plexus/components.xml Log: prep move to codehaus Modified: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/pom.xml =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/pom.xml 2007-06-22 23:40:50 UTC (rev 11703) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/pom.xml 2007-06-24 04:08:36 UTC (rev 11704) @@ -1,18 +1,88 @@ <?xml version="1.0"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> - <modelVersion>4.0.0</modelVersion> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jboss-docbook-plugin</artifactId> + <parent> + <groupId>org.codehaus.mojo</groupId> + <artifactId>mojo</artifactId> + <version>15</version> + </parent> + + <groupId>org.codehaus.mojo</groupId> + <artifactId>docbook-maven-plugin</artifactId> + <packaging>maven-plugin</packaging> <version>2.0-SNAPSHOT</version> - <packaging>maven-plugin</packaging> + <name>Maven Docbook Plugin</name> + <description>This plugin adds support for Docbook transformations to Maven.</description> + <url>http://mojo.codehaus.org/maven-docbook-plugin</url> - <name>DocBook XML Transformations</name> - <description>Plugin for generating documentation from DocBook sources and either standard or custom XSL stylesheets.</description> + <developers> + <developer> + <name>Jose Gonzalez Gomez</name> + <email&gt;jgonzalez.openinput(a)gmail.com&lt;/email&gt; + <organization>OPEN input</organization> + <organizationUrl>http://www.openinput.com/</organizationUrl> + <timezone>+1</timezone> + </developer> + <developer> + <name>Steve Ebersole</name> + <email&gt;steve(a)hibernate.org&lt;/email&gt; + <organization>Hibernate</organization> + <organizationUrl>http://hibernate.org</organizationUrl> + <timezone>-5</timezone> + </developer> + </developers> + <licenses> + <license> + <name>GNU Lesser General Public License</name> + <url>http://www.gnu.org/copyleft/lesser.html</url> + <distribution>repo</distribution> + </license> + </licenses> + + <scm> + <connection>scm:svn:https://svn.codehaus.org/mojo/trunk/mojo/docbook-ma... + <developerConnection>scm:svn:https://svn.codehaus.org/mojo/trunk/mojo/d... + <url>https://svn.codehaus.org/mojo/trunk/mojo/docbook-maven-plugin</... + </scm> + + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <configuration> + <source>1.4</source> + <target>1.4</target> + <encoding>UTF-8</encoding> + </configuration> + </plugin> + </plugins> + </build> + + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <configuration> + <minmemory>128m</minmemory> + <maxmemory>512</maxmemory> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-jxr-plugin</artifactId> + </plugin> + </plugins> + </reporting> + <dependencies> + <!-- todo : can we remove this and rely on the user project defining which docbook to use? --> <dependency> <groupId>net.sf.docbook</groupId> <artifactId>docbook</artifactId> @@ -39,6 +109,11 @@ <version>1.0.1</version> </dependency> <dependency> + <groupId>org.codehaus.plexus</groupId> + <artifactId>plexus-archiver</artifactId> + <version>1.0-alpha-7</version> + </dependency> + <dependency> <groupId>avalon-framework</groupId> <artifactId>avalon-framework</artifactId> <version>4.1.5</version> @@ -100,7 +175,7 @@ <artifactId>saxon</artifactId> <version>6.5.3</version> </dependency> - + <!-- todo : upgrade this to 0.93 or later once the fox: extension element issues are fixed --> <dependency> <groupId>fop</groupId> @@ -125,16 +200,15 @@ <version>1.1.3</version> <scope>runtime</scope> </dependency> + + + <!-- dont think this is needed anymore --> <dependency> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-resources-plugin</artifactId> <version>2.2</version> </dependency> - <dependency> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-archiver</artifactId> - <version>1.0-alpha-7</version> - </dependency> + </dependencies> <properties> Added: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/DocBookSupportResourcesMojo.java =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/DocBookSupportResourcesMojo.java (rev 0) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/DocBookSupportResourcesMojo.java 2007-06-24 04:08:36 UTC (rev 11704) @@ -0,0 +1,103 @@ +/* + * Copyright © 2007 Red Hat Middleware, LLC. All rights reserved. + * + * This copyrighted material is made available to anyone wishing to use, modify, + * copy, or redistribute it subject to the terms and conditions of the GNU + * Lesser General Public License, v. 2.1. This program is distributed in the + * hope that it will be useful, but WITHOUT A WARRANTY; without even the implied + * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. You should have received a + * copy of the GNU Lesser General Public License, v.2.1 along with this + * distribution; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * Red Hat Author(s): Steve Ebersole + */ +package org.jboss.maven.plugin.docbook; + +import java.io.File; +import java.io.IOException; + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.codehaus.plexus.util.FileUtils; + +/** + * Defines resources-like processing for docbook-support files such + * as XSLT, fonts, resources (images/css/etc), moving them to specific locations + * within the output directory for inclusion in the final package. + * + * @goal support-resources + * @phase process-resources + * @requiresDependencyResolution + * + * @author Steve Ebersole + */ +public class DocBookSupportResourcesMojo extends AbstractMojo { + + /** + * The directory containing the XSLT sources. + * + * @parameter expression="${basedir}/src/main/styles" + */ + protected File xsltSourceDirectory; + + /** + * The directory containing fonts to be included in package. + * + * @parameter expression="${basedir}/src/main/fonts" + */ + protected File fontSourceDirectory; + + /** + * The directory containing images to be included in package. + * + * @parameter expression="${basedir}/src/main/images" + */ + protected File imagesSourceDirectory; + + /** + * The directory containing css to be included in package. + * + * @parameter expression="${basedir}/src/main/css" + */ + protected File cssSourceDirectory; + + /** + * The directory from which packaging is staged. + * + * @parameter expression="${project.build.outputDirectory}" + */ + protected File outputDirectory; + + public void execute() throws MojoExecutionException, MojoFailureException { + copySource( xsltSourceDirectory, new File( outputDirectory, "styles" ) ); + copySource( fontSourceDirectory, new File( outputDirectory, "fonts" ) ); + copySource( imagesSourceDirectory, new File( outputDirectory, "images" ) ); + copySource( cssSourceDirectory, new File( outputDirectory, "css" ) ); + } + + private void copySource(File sourceDirectory, File targetDirectory) + throws MojoExecutionException { + getLog().info( "attempting to copy directory : " + sourceDirectory.getAbsolutePath() ); + if ( !sourceDirectory.exists() ) { + return; + } + String[] list = sourceDirectory.list(); + if ( list == null || list.length == 0 ) { + return; + } + + if ( !targetDirectory.exists() ) { + targetDirectory.mkdirs(); + } + + try { + FileUtils.copyDirectoryStructure( sourceDirectory, targetDirectory ); + } + catch ( IOException e ) { + throw new MojoExecutionException( "unable to copy source directory [" + sourceDirectory.getAbsolutePath() + "]", e ); + } + } +} Modified: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/GenerationMojo.java =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/GenerationMojo.java 2007-06-22 23:40:50 UTC (rev 11703) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/GenerationMojo.java 2007-06-24 04:08:36 UTC (rev 11704) @@ -25,8 +25,9 @@ import org.apache.maven.artifact.Artifact; /** - * A DocBook plugin based on the excellent docbkx-maven-plugin, but which - * specifically handles language translations in a more transparent way. + * This mojo's responsibility within the plugin/packaging is actually performing + * the DocBook transformations. At the highest level, it takes the source and + * process it via the specified DocBook XSLT to produce output. * * @goal generate * @phase compile Modified: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/PackageMojo.java =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/PackageMojo.java 2007-06-22 23:40:50 UTC (rev 11703) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/PackageMojo.java 2007-06-24 04:08:36 UTC (rev 11704) @@ -22,8 +22,8 @@ import org.jboss.maven.plugin.docbook.gen.format.FormatHandlerFactory; /** - * This mojo's purpose within the plugin/packaging is to bundle the individual - * formats into deployable formats. Note that some formats (PDF, e.g.) are + * This mojo's responsibility within the plugin/packaging is to bundle the + * individual formats into deployable formats. The desicion Note that some formats (PDF, e.g.) are * already deployable. * <p/> * After bundling, each bundle is then attached to the project Modified: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/ResourceMojo.java =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/ResourceMojo.java 2007-06-22 23:40:50 UTC (rev 11703) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/java/org/jboss/maven/plugin/docbook/ResourceMojo.java 2007-06-24 04:08:36 UTC (rev 11704) @@ -31,10 +31,11 @@ import org.jboss.maven.plugin.docbook.gen.XSLTException; /** - * This mojo's purpose within the plugin/packaging is to process resources - * defined by various inputs, moving them into a *single* staging directory for - * use during XSLT processing; the DocBook XSLT only allow defining a single - * <tt>img.src.path</tt> value. + * This mojo's responsibility within the plugin/packaging is to process resources + * defined by various inputs, moving them into a staging directory for use + * during XSLT processing. This is needed because the DocBook XSLT only allow + * defining a single <tt>img.src.path</tt> value; FOP only allows a single + * <tt>fontBaseDir</tt> value; etc. * * @goal resources * @phase process-resources @@ -109,8 +110,6 @@ getLog().info( "unpacking dependency resource [" + file.getAbsolutePath() + "] to staging-dir [" + target.getAbsolutePath() + "]" ); try { target.mkdirs(); -// :( -// UnArchiver unArchiver = archiverManager.getUnArchiver( file ); UnArchiver unArchiver = archiverManager.getUnArchiver( "jar" ); unArchiver.setSourceFile( file ); unArchiver.setDestDirectory( target ); Modified: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/resources/META-INF/plexus/components.xml =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/resources/META-INF/plexus/components.xml 2007-06-22 23:40:50 UTC (rev 11703) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/main/resources/META-INF/plexus/components.xml 2007-06-24 04:08:36 UTC (rev 11704) @@ -2,12 +2,7 @@ <components> - <component> - <role>org.apache.maven.reporting.MavenReport</role> - <role-hint>diff</role-hint> - <implementation>org.jboss.maven.plugin.docbook.TranslationDiffReport</implementation> - <instantiation-strategy>per-lookup</instantiation-strategy> - </component> + <!-- Defines the lifecycle associated with the 'docbook' packaging --> <component> <role>org.apache.maven.lifecycle.mapping.LifecycleMapping</role> @@ -24,6 +19,47 @@ </configuration> </component> + <!-- Defines the lifecycle associated with the 'docbook-support' packaging --> + + <component> + <role>org.apache.maven.lifecycle.mapping.LifecycleMapping</role> + <role-hint>docbook-support</role-hint> + <implementation>org.apache.maven.lifecycle.mapping.DefaultLifecycleMapping</implementation> + <configuration> + <phases> + <process-resources>org.jboss.maven.plugins:maven-docbook-support-plugin:support-resources</process-resources> + <package>org.apache.maven.plugins:maven-jar-plugin:jar</package> + <install>org.apache.maven.plugins:maven-install-plugin:install</install> + <deploy>org.apache.maven.plugins:maven-deploy-plugin:deploy</deploy> + </phases> + </configuration> + </component> + + <!-- Defines the artifact handling associated with the 'docbook-support' packaging --> + + <component> + <role>org.apache.maven.artifact.handler.ArtifactHandler</role> + <role-hint>docbook-support</role-hint> + <implementation>org.apache.maven.artifact.handler.DefaultArtifactHandler</implementation> + <configuration> + <type>docbook-support</type> + <extension>jar</extension> + <packaging>jar</packaging> + <language>java</language> + <addedToClasspath>false</addedToClasspath> + <includesDependencies>true</includesDependencies> + </configuration> + </component> + + <!-- Defines the 'diff' reporting goal --> + + <component> + <role>org.apache.maven.reporting.MavenReport</role> + <role-hint>diff</role-hint> + <implementation>org.jboss.maven.plugin.docbook.TranslationDiffReport</implementation> + <instantiation-strategy>per-lookup</instantiation-strategy> + </component> + </components> </component-set> \ No newline at end of file Added: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/index.apt =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/index.apt (rev 0) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/index.apt 2007-06-24 04:08:36 UTC (rev 11704) @@ -0,0 +1,75 @@ + ------ + Introduction + ------ + Steve Ebersole + ------ + 22 June 2007 + ------ + +~~ Copyright © 2007 Red Hat Middleware, LLC. All rights reserved. +~~ +~~ This copyrighted material is made available to anyone wishing to use, modify, +~~ copy, or redistribute it subject to the terms and conditions of the GNU +~~ Lesser General Public License, v. 2.1. This program is distributed in the +~~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied +~~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +~~ Lesser General Public License for more details. You should have received a +~~ copy of the GNU Lesser General Public License, v.2.1 along with this +~~ distribution; if not, write to the Free Software Foundation, Inc., +~~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +~~ +~~ Red Hat Author(s): Steve Ebersole + +Maven Docbook Plugin + + DocBook is, in part, "an XML vocabulary that lets you create documents in a + presentation-neutral form that captures the logical structure of your + content". Another aspect of DocBook is the rendering of that content into + various formats using DocBook-supplied (or custom) XSLT stylesheets. + Basically, DocBook allows you to write and maintain a single source for + documentation, and to then render that single source into multiple formats + such as PDF or HTML. + + The purpose of this plugin is to allow these DocBook transformations to + occur as a natural part of the users Maven build. The main difficulty with + this was the fact that DocBook transformations are usually very closely + tied to the user's local environment. The goal with this plugin was to + utilize Maven's dependency mechanism to bring all the pieces together on + demand; these pieces include (a) the DocBook distribution itself, (b) custom + XSLT, (c) fonts, (d) images, (e) css. These are the ingredients that when + mixed with the source file(s) and stirred with an XSLT transformer produce + the desired output(s). + +~~ todo : need to discuss the docbook-support stuff... + +* Goals Overview + + The plugin defines a dedicated project packaging ("docbook"). That decision + was initially made because of the fact that a project of DocBook source would + not have an inherent "main artifact", just a bunch of "attached artifacts" + (one for each output format). The packaging is used to redefine a suitable + lifecycle with a series of mojos performing operations in stages. The + lifecycle/stages are as follows: + [process-resources] binds the {{{resources.html}docbook-maven-plugin:resources}} + goal which "stages" the resources need for the XSLT transformations such as + fonts, images and css. + [compile] binds the {{{generate.html}docbook-maven-plugin:generate}} goal + which performs the actual XSLT transformations. + [package] binds the {{{bundle.html}docbook-maven-plugin:bundle}} goal + which takes all the output formats, archives them as WARs and attaches the + WARs to the project with the format name as the artifact classifier. + [install] binds the standard install goal. + [deploy] binds the standard deploy goal. + +* Usage + + Instructions on how to use the Maven Docbook Plugin can be found {{{usage.html}here}}. + +* Examples + + To provide you with better understanding of some usages of the Plugin Name, + you can take a look into the following examples: + + * {{{examples/example-one.html}Example Description One}} + + * {{{examples/example-two.html}Example Description Two}} \ No newline at end of file Added: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/usage.apt =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/usage.apt (rev 0) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/apt/usage.apt 2007-06-24 04:08:36 UTC (rev 11704) @@ -0,0 +1,30 @@ + ------ + Usage + ------ + Steve Ebersole + ------ + 22 June 2007 + ------ + +~~ Copyright © 2007 Red Hat Middleware, LLC. All rights reserved. +~~ +~~ This copyrighted material is made available to anyone wishing to use, modify, +~~ copy, or redistribute it subject to the terms and conditions of the GNU +~~ Lesser General Public License, v. 2.1. This program is distributed in the +~~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied +~~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +~~ Lesser General Public License for more details. You should have received a +~~ copy of the GNU Lesser General Public License, v.2.1 along with this +~~ distribution; if not, write to the Free Software Foundation, Inc., +~~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +~~ +~~ Red Hat Author(s): Steve Ebersole + +Usage + + The Maven Docbook Plugin uses a combination of SAXON and DocBook XSLT + (plus some other stuff depending on the format) to produce the desired + outputs. The following sections describe the basic usage scenarios. + +* Minimal configuration + \ No newline at end of file Added: trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/site.xml =================================================================== --- trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/site.xml (rev 0) +++ trunk/sandbox/maven-poc/plugins/maven-jboss-docbook-plugin/src/site/site.xml 2007-06-24 04:08:36 UTC (rev 11704) @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="Maven"> + + <bannerLeft> + <name>Mojo</name> + <src>http://mojo.codehaus.org/images/mojo_logo.png</src> + <href>http://mojo.codehaus.org/</href> + </bannerLeft> + + <bannerRight> + <src>http://mojo.codehaus.org/images/codehaus-small.png</src> + </bannerRight> + + <body> + <links> + <item name="Mojo" href="http://mojo.codehaus.org/" /> + <item name="Maven" href="http://maven.apache.org/"/> + <item name="DocBook" href="http://docbook.sourceforge.net/"/> + </links> + + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Goals" href="plugin-info.html"/> + <item name="Usage" href="usage.html"/> + <item name="FAQ" href="faq.html"/> + </menu> + + <menu name="Examples"> + <item name="description1" href="examples/example-one.html"/> + <item name="description2" href="examples/example-two.html"/> + </menu> + + ${reports} + </body> + +</project>