MPPDF-9 : Allow the pdf plugin to be added as a project's report.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@232685 13f79535-47bb-0310-9956-ffa450edef68
2005-08-15 01:44:00 +00:00
1 parent 2fa365b59e
commit 6ab9fc0fd4
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 -->
-
 <project xmlns:j="jelly:core">
-    <postGoal name="site">
-        <attainGoal name="pdf"/>
-    </postGoal>
+
 </project>
@@ -16,7 +16,22 @@
 * limitations under the License.
 */
 -->
-<project xmlns:j="jelly:core" xmlns:u="jelly:util" xmlns:ant="jelly:ant" xmlns:maven="jelly:maven">
+<project xmlns:j="jelly:core" xmlns:u="jelly:util" xmlns:ant="jelly:ant" xmlns:maven="jelly:maven" xmlns:doc="doc">
+  <goal name="maven-pdf-plugin:register" description="Register the pdf generation during site goal.">
+    <doc:registerReport name="PDF" pluginName="maven-pdf-plugin" target="_blank" description="Documentation in PDF format."/>
+  </goal>
+  <goal name="maven-pdf-plugin:deregister" description="Deregister the pdf generation.">
+    <doc:deregisterReport name="PDF"/>
+  </goal>
+  <goal name="maven-pdf-plugin:report" description="Called by xdoc to execute the pdf goal.">
+    <!--
+        using a postgoal so that maven generated reports are on place
+        (xdoc:generate-from-pom is called after report generation)
+      -->
+    <postGoal name="site">
+      <attainGoal name="pdf"/>
+    </postGoal>
+  </goal>
  <goal name="pdf:init" prereqs="xdoc:init">
    <!-- xdoc plugin properties -->
    <maven:get var="maven.xdoc.src" plugin="maven-xdoc-plugin" property="maven.docs.src"/>
@@ -167,7 +182,7 @@ internal_pdf_workingDir         = [${internal_pdf_workingDir}]
    <fop>
      <ant:setProperty name="basedir" value="${internal_pdf_workingDir}"/>
      <ant:setProperty name="userconfig" value="${internal_pdf_workingDir}/userconfig.xml"/>
-      <ant:setProperty name="messagelevel" value="info" />
+      <ant:setProperty name="messagelevel" value="info"/>
      <if test="${maven.pdf.debug}">
        <ant:setProperty name="messagelevel" value="debug"/>
      </if>
@@ -119,4 +119,20 @@
      <url>http://avalon.apache.org/framework/</url>
    </dependency>
  </dependencies>
+  <reports>
+    <report>maven-changes-plugin</report>
+    <report>maven-changelog-plugin</report>
+    <report>maven-file-activity-plugin</report>
+    <report>maven-developer-activity-plugin</report>
+    <report>maven-tasklist-plugin</report>
+    <report>maven-javadoc-plugin</report>
+    <report>maven-jxr-plugin</report>
+    <report>maven-jdepend-plugin</report>
+    <report>maven-checkstyle-plugin</report>
+    <report>maven-junit-report-plugin</report>
+    <report>maven-pdf-plugin</report>
+    <report>maven-pmd-plugin</report>
+    <report>maven-simian-plugin</report>
+    <report>maven-faq-plugin</report>
+  </reports>
 </project>
@@ -41,7 +41,6 @@
        </ant:fileset>
      </ant:copy>
    </j:forEach>
-    <attainGoal name="pdf"/>
    <assert:assertFileExists file="${maven.docs.dest}/${pom.artifactId}.pdf"/>
  </goal>
 </project>
@@ -33,7 +33,8 @@
      <action dev="aheritier" type="fix" issue="MPPDF-32" due-to="Lukas Theussl">Cannot use SVG images. batik: java.lang.NoSuchMethodError.</action>
      <action dev="aheritier" type="fix" issue="MPPDF-31" due-to="Lukas Theussl">Can't insert the logo image described in the POM if its path begins with a slash (as it works for the xdoc plugin).</action>
      <action dev="aheritier" type="fix" issue="MPPDF-22" due-to="Lukas Theussl">Allow copy and paste from pdf to text editor.</action>
-      <action dev="aheritier" type="fix" issue="MPPDF-8" due-to="Fábio Franco Uechi">Add support for external imaging libraries like jimi and jai to use PNG images in generated pdf files.</action>
+      <action dev="aheritier" type="add" issue="MPPDF-9" due-to="Fabrizio Giustina">Allow the pdf plugin to be added as a project's report.</action>
+      <action dev="aheritier" type="fix" issue="MPPDF-8" due-to="Fabio Franco Uechi">Add support for external imaging libraries like jimi and jai to use PNG images in generated pdf files.</action>
    </release>
    <release version="2.3" date="2005-06-16">
      <action dev="aheritier" type="update" issue="MPPDF-38">Use the ant task for the xsl transformation and remove xerces and xalan dependencies. People using java 5 will have to use this release with maven 1.1 or maven 1.0 with at the most the PDF plugin 2.2.X.</action>
@@ -165,13 +165,4 @@ maven.jar.jaicodec=${maven.repo.local}/jai/jars/jai_codec-X.Y.Z.jar</source>
      </answer>
    </faq>
  </part>
-  <part id="technical">
-    <title>Technical questions</title>
-    <faq id="no-report">
-      <question>Why isn't there a pdf report ?</question>
-      <answer>
-        <p>Because reports are generated before the site copies resources like images and the order of reports depends of several parameters. We need that images and generated files are created before we launch the pdf creation. Thus it is not possible to create a pdf report because we can't call it at the end of the site generation process.</p>
-      </answer>
-    </faq>
-  </part>
 </faqs>
@@ -31,32 +31,31 @@
        </tr>
        <tr>
          <td>fo</td>
-          <td>
-            This simply pre-requisites the <code>fo:fo</code> goal.
-          </td>
+          <td>This simply pre-requisites the <code>fo:fo</code> goal.</td>
        </tr>
        <tr>
          <td>fo:fo</td>
-          <td>
-            Generates an fo xml document from the <code>navigation.xml</code>
-            file supplied as part of the documentation. Please note that as
-            yet, no sanity check is done to make sure this file exists.
-          </td>
+          <td>Generates an fo xml document from the <code>navigation.xml</code> file supplied as part of the documentation. Please note that as yet, no sanity check is done to make sure this file exists.</td>
        </tr>
        <tr>
          <td>pdf</td>
-          <td>
-            This is the default goal of the plugin and simply pre-requisites
-            the <code>pdf:pdf</code> goal.
-          </td>
+          <td>This is the default goal of the plugin and simply pre-requisites the <code>pdf:pdf</code> goal.</td>
        </tr>
        <tr>
          <td>pdf:pdf</td>
-          <td>
-            Generates a PDF document containing all project documentation.
-            The PDF is generated from the .fo file generated in the <code>fo:fo</code>
-            goal.
-          </td>
+          <td>Generates a PDF document containing all project documentation. The PDF is generated from the .fo file generated in the <code>fo:fo</code> goal.</td>
+        </tr>
+        <tr>
+          <td>maven-pdf-plugin:register</td>
+          <td>Register the pdf generation after the site goal.</td>
+        </tr>
+        <tr>
+          <td>maven-pdf-plugin:deregister</td>
+          <td>Deregister the pdf generation.</td>
+        </tr>
+        <tr>
+          <td>maven-pdf-plugin:report</td>
+          <td>Called by xdoc to execute the pdf goal.</td>
        </tr>
      </table>
    </section>
@@ -26,7 +26,19 @@
  <body>
    <section name="Maven PDF Plug-in">
      <p>This plug-in allows you to generate a PDF version of your project's documentation.</p>
-      <p>Take a look at <a href="goals.html">goals</a>, the <a href="properties.html">properties</a> and the <a href="faq.html">FAQ</a> to see how to use it.</p>
+      <p>To enable PDF generation add the following to your maven.xml</p>
+      <source><![CDATA[
+<postGoal name="site">
+  <attainGoal name="pdf"/>
+</postGoal>
+]]></source>
+      <p>You can also add the PDF generation to your project.xml like this : </p>
+      <source><![CDATA[
+<reports>
+  <report>maven-pdf-plugin</report>
+<reports>
+]]></source>
+      <p>Take a look at <a href="goals.html">goals</a>, <a href="properties.html">properties</a> and the <a href="faq.html">FAQ</a> to see how to customize it.</p>
    </section>
    <section name="Known issues">
      <ul>