blob: 3deec0823a723f2eb9f5bf3ffb96aa090b26659b [file] [log] [blame]
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
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ 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:
Doxia allows you to write books like user manuals and guides in any format supported by Doxia. Combined with the
Doxia Book Maven Plugin, you are able to include the manuals directly in your generated site with links to the off-line
friendly formats like XDoc, PDF, RTF and LaTeX.
* Goals Overview
The Doxia Maven Plugin has one goal:
* {{{./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 {{{}The Book Descriptor Reference}}
for a reference to the descriptor.
* Usage
General instructions on how to use the Doxia Book 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
{{{}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 {{{./mailing-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 {{{./mailing-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-management.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
{{{./scm.html}source repository}} and will find supplementary information in the
{{{}guide to helping with Maven}}.
* Examples
An Xdoc output example which has been rendered into this site can be viewed {{{}here}}.