e94e7aaae6
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@379968 13f79535-47bb-0310-9956-ffa450edef68
68 lines
3.0 KiB
XML
68 lines
3.0 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
<document>
|
|
<properties>
|
|
<title>Maven PDF Plug-in</title>
|
|
<author email="jason@zenplex.com">Jason van Zyl</author>
|
|
<author email="dion@apache.org">dIon Gillard</author>
|
|
<author email="aheritier@apache.org">Arnaud Heritier</author>
|
|
</properties>
|
|
<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>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><i>The links to the pdf file in the reports page and in the reports menu are correct only if the xdoc plugin 1.10 or above is used.</i></p>
|
|
<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>
|
|
<li>
|
|
There is a known problem with the PDF generation tool (Apache's FOP) in that it doesn't allow for table structures with automatic column widths to be generated. Widths are uniformly distributed.
|
|
</li>
|
|
<li>
|
|
Due to several problems, it is actually impossible to reference the same file in different items in navigation.xml. You must define another navigation file (using the property <a href="properties.html">"maven.pdf.navigationFile"</a>) which you'll use only with the PDF plug-in. This navigation cannot define several items with the same href.
|
|
</li>
|
|
<li>
|
|
Identical <code>id</code> attributes within one document will lead to a build failure.
|
|
</li>
|
|
<li>
|
|
Contrary to the xdoc plugin, the pdf plugin does not generate
|
|
anchors from section or subsection names. If you want to reference
|
|
a section or subsection you have to use the optional
|
|
<code>id</code> tag.
|
|
</li>
|
|
<li>
|
|
Other issues are available in <a href="http://jira.codehaus.org/secure/IssueNavigator.jspa?reset=true&pid=10356&statusIds=1" target="_blank">Jira</a>.
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</body>
|
|
</document>
|