[jboss-svn-commits] JBL Code SVN: r13282 - in labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin: src/main/java/org/jboss/maven/plugins/jdocbook and 3 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Mon Jul 9 20:11:39 EDT 2007
Author: steve.ebersole at jboss.com
Date: 2007-07-09 20:11:38 -0400 (Mon, 09 Jul 2007)
New Revision: 13282
Removed:
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/revdiff/IndexReportGenerator.java
Modified:
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/pom.xml
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/AbstractDocBookMojo.java
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/custom-xslt.apt
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/docbook-version.apt
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/jdocbook-style.apt
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/project-local-style.apt
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/index.apt
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt
labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt
Log:
prep for 2.0.0 release
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/pom.xml
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/pom.xml 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/pom.xml 2007-07-10 00:11:38 UTC (rev 13282)
@@ -20,6 +20,12 @@
<modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.jboss</groupId>
+ <artifactId>jboss-parent</artifactId>
+ <version>3</version>
+ </parent>
+
<groupId>org.jboss.maven.plugins</groupId>
<artifactId>maven-jdocbook-plugin</artifactId>
<packaging>maven-plugin</packaging>
@@ -43,6 +49,11 @@
</developer>
</developers>
+ <issueManagement>
+ <system>jira</system>
+ <url>http://jira.jboss.org/jira/browse/MPJDOCBOOK</url>
+ </issueManagement>
+
<licenses>
<license>
<name>GNU Lesser General Public License</name>
@@ -68,6 +79,12 @@
<encoding>UTF-8</encoding>
</configuration>
</plugin>
+ <plugin>
+ <artifactId>maven-release-plugin</artifactId>
+ <configuration>
+ <tagBase>https://svn.labs.jboss.org/labs/jbossbuild/maven-plugins/tags</tagBase>
+ </configuration>
+ </plugin>
</plugins>
</build>
@@ -93,13 +110,39 @@
</reporting>
<dependencies>
- <!-- todo : can we remove this and rely on the user project defining which docbook to use? -->
+ <!-- DocBook (this is the version used, unless user project imports one...) -->
<dependency>
<groupId>net.sf.docbook</groupId>
<artifactId>docbook</artifactId>
<version>1.72.0</version>
</dependency>
+
+ <!-- XML APIs -->
<dependency>
+ <groupId>xml-resolver</groupId>
+ <artifactId>xml-resolver</artifactId>
+ <version>1.1</version>
+ </dependency>
+ <dependency>
+ <groupId>xerces</groupId>
+ <artifactId>xercesImpl</artifactId>
+ <version>2.8.0</version>
+ <scope>runtime</scope>
+ </dependency>
+ <dependency>
+ <groupId>xerces</groupId>
+ <artifactId>xmlParserAPIs</artifactId>
+ <version>2.6.2</version>
+ <scope>runtime</scope>
+ </dependency>
+ <dependency>
+ <groupId>saxon</groupId>
+ <artifactId>saxon</artifactId>
+ <version>6.5.3</version>
+ </dependency>
+
+ <!-- Maven Plugin deps -->
+ <dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>2.0</version>
@@ -110,14 +153,9 @@
<version>2.0.4</version>
</dependency>
<dependency>
- <groupId>org.apache.maven.reporting</groupId>
- <artifactId>maven-reporting-impl</artifactId>
- <version>2.0.4</version>
- </dependency>
- <dependency>
- <groupId>plexus</groupId>
+ <groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
- <version>1.0.1</version>
+ <version>1.2</version>
</dependency>
<dependency>
<groupId>org.codehaus.plexus</groupId>
@@ -129,69 +167,9 @@
<artifactId>plexus-compiler-api</artifactId>
<version>1.5.3</version>
</dependency>
+
+ <!-- FOP, used for FO (PDF) processing -->
<dependency>
- <groupId>avalon-framework</groupId>
- <artifactId>avalon-framework</artifactId>
- <version>4.1.5</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven.doxia</groupId>
- <artifactId>doxia-core</artifactId>
- <version>${doxiaVersion}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.maven.doxia</groupId>
- <artifactId>doxia-decoration-model</artifactId>
- <version>${doxiaSiteVersion}</version>
- <exclusions>
- <exclusion>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-component-api</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-container-default</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>org.apache.maven.doxia</groupId>
- <artifactId>doxia-site-renderer</artifactId>
- <version>${doxiaSiteVersion}</version>
- <exclusions>
- <exclusion>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-component-api</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-container-default</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
- <dependency>
- <groupId>xml-resolver</groupId>
- <artifactId>xml-resolver</artifactId>
- <version>1.1</version>
- </dependency>
- <dependency>
- <groupId>xerces</groupId>
- <artifactId>xercesImpl</artifactId>
- <version>2.8.0</version>
- <scope>runtime</scope>
- </dependency>
- <dependency>
- <groupId>xerces</groupId>
- <artifactId>xmlParserAPIs</artifactId>
- <version>2.6.2</version>
- <scope>runtime</scope>
- </dependency>
- <dependency>
- <groupId>saxon</groupId>
- <artifactId>saxon</artifactId>
- <version>6.5.3</version>
- </dependency>
- <dependency>
<groupId>org.apache.xmlgraphics</groupId>
<artifactId>fop</artifactId>
<version>0.93</version>
@@ -240,8 +218,6 @@
</dependencies>
<properties>
- <doxiaVersion>1.0-alpha-8</doxiaVersion>
- <doxiaSiteVersion>1.0-alpha-8</doxiaSiteVersion>
<batikVersion>1.6</batikVersion>
</properties>
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/AbstractDocBookMojo.java
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/AbstractDocBookMojo.java 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/AbstractDocBookMojo.java 2007-07-10 00:11:38 UTC (rev 13282)
@@ -21,7 +21,6 @@
import java.util.List;
import java.util.Set;
-import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
@@ -82,15 +81,6 @@
protected ArchiverManager archiverManager;
/**
- * INTERNAL : used in the translation diff report
- *
- * @parameter expression="${component.org.apache.maven.doxia.siterenderer.Renderer}"
- * @required
- * @readonly
- */
- protected Renderer siteRenderer;
-
- /**
* INTERNAL : used during packaging to attach produced artifacts
*
* @parameter expression="${component.org.apache.maven.project.MavenProjectHelper}"
Deleted: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/revdiff/IndexReportGenerator.java
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/revdiff/IndexReportGenerator.java 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/main/java/org/jboss/maven/plugins/jdocbook/revdiff/IndexReportGenerator.java 2007-07-10 00:11:38 UTC (rev 13282)
@@ -1,84 +0,0 @@
-/*
- * 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.plugins.jdocbook.revdiff;
-
-import java.util.Locale;
-import java.util.List;
-import java.util.Iterator;
-import java.util.ResourceBundle;
-
-import org.apache.maven.doxia.sink.Sink;
-import org.apache.maven.plugin.logging.Log;
-import org.apache.maven.reporting.MavenReportException;
-
-/**
- *
- * @author Steve Ebersole
- */
-public class IndexReportGenerator {
- private final ResourceBundle bundle;
- private final Sink sink;
- private final Log log;
-
- public static class TranslationReportDescriptor {
- private final Locale translation;
- private final String reportPath;
-
- public TranslationReportDescriptor(Locale translation, String reportPath) {
- this.translation = translation;
- this.reportPath = reportPath;
- }
- }
-
- public IndexReportGenerator(ResourceBundle bundle, Sink sink, Log log) {
- this.bundle = bundle;
- this.sink = sink;
- this.log = log;
- }
-
- public void generate(List reportDescriptors) throws MavenReportException {
- log.debug( "writing index report via provided sink" );
- sink.head();
- sink.text( bundle.getString( "report.name" ) );
- sink.head_();
-
- sink.body();
- sink.sectionTitle1();
- sink.anchor( bundle.getString( "report.header" ) );
- sink.anchor_();
- sink.text( bundle.getString( "report.header" ) );
- sink.sectionTitle1_();
-
- sink.table();
- Iterator itr = reportDescriptors.iterator();
- while ( itr.hasNext() ) {
- final TranslationReportDescriptor descriptor = ( TranslationReportDescriptor ) itr.next();
- sink.tableRow();
- sink.tableCell();
- sink.link( descriptor.reportPath );
- sink.text( descriptor.translation.getDisplayName( Locale.ENGLISH ) + " (" + descriptor.translation.toString() + ")" );
- sink.link_();
- sink.tableCell_();
- sink.tableRow_();
- }
- sink.table_();
-
- sink.body_();
- sink.flush();
- sink.close();
- log.debug( "index report sink flushed and closed" );
- }
-}
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/custom-xslt.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/custom-xslt.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/custom-xslt.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -29,7 +29,7 @@
format. It is possible for a user to redefine how transformations occur
for a given format by specifying that a custom XSLT be used instead of the
standard DocBook XSLT for that particular format in the configuration.
- There are two main ways to define the custom xslt that shouold be used...
+ There are two main ways to define the custom xslt that should be used...
* file: URL
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/docbook-version.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/docbook-version.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/docbook-version.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -27,4 +27,22 @@
on the version of the <jDocBook Plugin> used.
It is however, possible to override that and say to use another version of
- DocBook instead, simply by defining the new version as a dependency.
\ No newline at end of file
+ DocBook instead, simply by defining the new version as a dependency.
+
++----+
+<plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifacId>maven-jdocbook-plugin</artifactId>
+ <extensions>true</extensions>
+ <dependencies>
+ <dependency>
+ <!-- This is the groupId/artifactId used for the repackaging of DocBook -->
+ <!-- This needs to match, or you will have two versions of DocBook accessible -->
+ <groupId>net.sf.docbook</groupId>
+ <artifactId>docbook</artifactId>
+ <!-- Whichever version you wanted to use instead -->
+ <version>latest.and.greatest</version>
+ </dependency>
+ </dependencies>
+</plugin>
++----+
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/jdocbook-style.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/jdocbook-style.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/jdocbook-style.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -32,7 +32,7 @@
Since an example, is worth (probably more than) a thousand words for most
of us, lets take a look at an example of the approach of combining these
two plugins. As I mentioned before, the venerable Acme Corporation produces a
- <jdocbook-style> bundle for all their product manulas. As the person in charge
+ <jdocbook-style> bundle for all their product manuals. As the person in charge
of Acme's latest product, WhizBang, you'll need to utilize that style bundle in producing
your manual.
@@ -70,8 +70,8 @@
....
+----+
- <See the documentation of the maven-jdocbook-style-plugin> project for more
- details. The above was a very brief overview.>
+ See the documentation of the maven-jdocbook-style-plugin project for more
+ details. The above was a very brief overview.
* The WhizBang manual project
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/project-local-style.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/project-local-style.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/examples/project-local-style.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -22,7 +22,7 @@
Project Local Style
- As disucssed {{{../style.html}here}}, a jdocbook project may provide custom
+ As discussed {{{../style.html}here}}, a jdocbook project may provide custom
style elements. Currently this is limited to images and css. These are
controlled by the <<imageResource>> and <<cssResource>> parameters. For example,
a common approach to developing DocBook-based documentation is to keep the
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/index.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/index.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/index.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -56,7 +56,7 @@
maven-jdocbook-style-plugin for more information about the ability to
develop styles separately from the source documents. In fact a hope with
creating the jdocbook-style plugin in the first place is creation of
- shareable styles reusable across many projects. {{{jdocbook-style.html}Here}}
+ shareable styles reusable across many projects. {{{style.html}Here}}
is a discussion of using jdocbook-style bundles within jdobcook projects.
Currently, only SAXON is supported as the transformer factory. I have
@@ -99,7 +99,7 @@
* {{{examples/project-local-style.html}Using custom project-local images/css}}
- * {{{examples/arbitrary-styles.html}Using arbutrary style images/css}}
+ * {{{examples/arbitrary-styles.html}Using arbitrary style images/css}}
* {{{examples/custom-xslt.html}Using custom XSLT}}
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/style.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -69,7 +69,7 @@
[[2]] Given the {{{staging.html}staging}} approach taken by this plugin
for dealing with with resources (css, fonts and images) it automatically
stages any css, font or image resources found inside a dependency of
- type <jdocbook-style>. See {{{examples/resource-staging.html}example}}.
+ type <jdocbook-style>.
[]
@@ -80,4 +80,4 @@
<todo : this section need writing... ;)>
- See {{staging.html}staging}}.
+ See {{{staging.html}staging}}.
Modified: labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt 2007-07-10 00:03:27 UTC (rev 13281)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jdocbook-plugin/src/site/apt/usage.apt 2007-07-10 00:11:38 UTC (rev 13282)
@@ -32,11 +32,11 @@
[]
If you want to use local style elements, it is also a good idea to understand
- {{staging.html}staging}} as well.
+ {{{staging.html}staging}} as well.
* Minimal configuration
- The most basic cofiguration of the <jDocBook Plugin> is to simply tell it:
+ The most basic configuration of the <jDocBook Plugin> is to simply tell it:
[[1]] The DocBook soure file to be transformed
More information about the jboss-svn-commits
mailing list