Author: vsiveton
Date: Sat Aug 8 13:49:04 2009
New Revision: 802377
URL: http://svn.apache.org/viewvc?rev=802377&view=rev
Log:
o updated doc
o fixed ambiguous links
Modified:
maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/apt/index.apt
maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/site.xml
Modified: maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/apt/index.apt?rev=802377&r1=802376&r2=802377&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/apt/index.apt (original)
+++ maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/apt/index.apt Sat Aug
8 13:49:04 2009
@@ -4,6 +4,26 @@
Lukas Theussl
-----
+~~ 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/doxia/references/apt-format.html
+
Introduction
Doxia allows you to write books like user manuals and guides in any format
supported by Doxia. Combined with the
@@ -14,16 +34,32 @@
The Doxia Maven Plugin has one goal:
- * {{{render-books-mojo.html}doxia:render-books}} to create books in different
output formats.
-
-* Usage
+ * {{{./render-books-mojo.html}doxia:render-books}} to create books in
different output formats.
First you need a simple book descriptor which is used to specify the layout
of your book, i.e.
the ordering of the sections and the names for the chapters.
See {{{http://maven.apache.org/doxia/book/index.html}The Book Descriptor
Reference}}
for a reference to the descriptor.
- An example for configuring the Doxia Maven Plugin is found on the
{{{./usage.html}usage}} page.
+* Usage
+
+ General instructions on how to use the Doxia Maven Plugin can be found on
the {{{./usage.html}usage page}}. Some more
+ specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
+ additional examples, tips or errata to the
+ {{{http://docs.codehaus.org/display/MAVENUSER/PDF+Plugin}plugin's wiki
page}}.
+
+ In case you still have questions regarding the plugin's usage, please have a
look at the {{{./faq.html}FAQ}} and feel
+ free to contact the {{{./mail-lists.html}user mailing list}}. The posts to
the mailing list are archived and could
+ already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
+ the {{{./mail-lists.html}mail archive}}.
+
+ If you feel like the plugin is missing a feature or has a defect, you can
fill a feature request or bug report in our
+ {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please
provide a comprehensive description of your
+ concern. Especially for fixing bugs it is crucial that the developers can
reproduce your problem. For this reason,
+ entire debug logs, POMs or most preferably little demo projects attached to
the issue are very much appreciated.
+ Of course, patches are welcome, too. Contributors can check out the project
from our
+ {{{./source-repository.html}source repository}} and will find supplementary
information in the
+ {{{http://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
* Examples
Modified: maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/site.xml?rev=802377&r1=802376&r2=802377&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/site.xml (original)
+++ maven/doxia/doxia/trunk/doxia-maven-plugin/src/site/site.xml Sat Aug 8
13:49:04 2009
@@ -21,7 +21,10 @@
*/
-->
-<project name="Doxia">
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0
http://maven.apache.org/xsd/decoration-1.0.0.xsd";
+ name="Doxia Maven plugin">
<body>
