Author: ltheussl Date: Fri Sep 14 05:13:00 2007 New Revision: 575651 URL: http://svn.apache.org/viewvc?rev=575651&view=rev Log: Add notes about current limitations
Added: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt (with props) Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/pdf.xml maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/site.xml Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt?rev=575651&r1=575650&r2=575651&view=diff ============================================================================== --- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt (original) +++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt Fri Sep 14 05:13:00 2007 @@ -35,7 +35,7 @@ The PDF Plugin only has one goal. - * {{{pdf-mojo.html}pdf:pdf}} Generates a PDF document containing + * {{{./pdf-mojo.html}pdf:pdf}} Generates a PDF document containing all project documentation. * Usage Added: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt?rev=575651&view=auto ============================================================================== --- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt (added) +++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt Fri Sep 14 05:13:00 2007 @@ -0,0 +1,60 @@ + ------ + Known Bugs and Limitations + ------ + Lukas Theussl + ------ + 14 September 2007 + ------ + +~~ Licensed to the Apache Software Foundation (ASF) under one +~~ or more contributor license agreements. See the NOTICE file +~~ distributed with this work for additional information +~~ regarding copyright ownership. The ASF licenses this file +~~ to you 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. + +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Known Bugs and Limitations + + Just a brief selection... + +* Current limitations + + * FML parsing doesn't work due to {{{http://jira.codehaus.org/browse/DOXIA-148}DOXIA-148}}. + + * Xdoc tables don't work due to a bug in the xdoc parser. + + * Maven generated pages (reports) are ignored. + + * Links to other source documents have to start with "./" or "../". + + * Table widths are always uniformly distributed (Apache FOP issue). + + * Identical id attributes (eg anchors) within one document will lead to a build failure. + +* Missing features + + * Page numbering + + * Table of contents + + * Page headers and footers + + * Different graphics formats (currently a FO sink limitation) + + +* Known bugs + + None. Propchange: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt ------------------------------------------------------------------------------ svn:keywords = "Author Date Id Revision" Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/pdf.xml URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/pdf.xml?rev=575651&r1=575650&r2=575651&view=diff ============================================================================== --- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/pdf.xml (original) +++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/pdf.xml Fri Sep 14 05:13:00 2007 @@ -29,8 +29,9 @@ </meta> <toc name="Table of Contents"> - <item name="Introduction" ref="index.html"/> - <item name="Usage" ref="usage.html"/> + <item name="Introduction" ref="index.apt"/> + <item name="Usage" ref="usage.apt"/> + <item name="Limitations" ref="limitations.apt"/> </toc> </document> Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/site.xml?rev=575651&r1=575650&r2=575651&view=diff ============================================================================== --- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/site.xml (original) +++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/site.xml Fri Sep 14 05:13:00 2007 @@ -29,6 +29,7 @@ <item name="Introduction" href="index.html"/> <item name="Goals" href="pdf-mojo.html"/> <item name="Usage" href="usage.html"/> + <item name="Limitations" href="limitations.html"/> </menu> </body>