85df922d35
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114795 13f79535-47bb-0310-9956-ffa450edef68
85 lines
3.2 KiB
XML
85 lines
3.2 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 XDoc Plug-in</title>
|
|
<author email="jason@zenplex.com">Jason van Zyl</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven XDoc Plug-in">
|
|
<p>
|
|
The Xdoc plugin is the primary mechanism used to produce the
|
|
Maven-generated documentation as well as any user supplied
|
|
"xdocs". An xdoc is an XML document conforming to a small and
|
|
simple set of tags. Maven uses this format extensively. All
|
|
Maven-generated reports are first generated as an xdoc, which
|
|
is then transformed to HTML via this plugin.
|
|
</p>
|
|
<p>
|
|
The documentation is mainly in <code>Anakia</code> format. More
|
|
information along with samples, can be found at:
|
|
<ul>
|
|
<li>
|
|
<a href="http://jakarta.apache.org/site/jakarta-site-tags.html">the tags defined</a>
|
|
</li>
|
|
<li>
|
|
<a href="http://jakarta.apache.org/site/jakarta-site-tags-example.html">examples of the tags</a>
|
|
</li>
|
|
</ul>
|
|
</p>
|
|
<p>
|
|
There are a few additions to the anakia format. You can use the
|
|
<code>footer</code> tag for including text or images just below
|
|
the navigation menu and above the copyright notice. This tag is
|
|
only usefull in the navigation.xml file and should be placed
|
|
within the body element. For example:
|
|
</p>
|
|
<source><![CDATA[
|
|
<!-- footer will be placed above the (c) -->
|
|
<footer>
|
|
<A href="http://sourceforge.net/projects/ctecl">
|
|
<IMG src="http://sourceforge.net/sflogo.php?group_id=72748" border="0" alt="sf logo"/>
|
|
</A>
|
|
</footer>
|
|
]]></source>
|
|
<p>
|
|
If a <code>search</code> element is found in the <code>navigation.xml</code> body, a search navigation
|
|
menu is generated that uses <a href="http://www.google.com">google</a>
|
|
</p>
|
|
<p>
|
|
In addition to xdocs, users may wish to include other types of
|
|
files such as images, their own HTML files, PDFs, etc. By
|
|
default, this plugin will copy all files located in the
|
|
<code>maven.docs.src</code> directory (<code>xdocs</code> by
|
|
default) to the final generated site.
|
|
</p>
|
|
|
|
<p>
|
|
If you create a <code>style/project.css</code> stylesheet under <code>maven.docs.src</code>,
|
|
it will be copied to the resulting document tree and imported into each page (via
|
|
<code>@import</code>. This allows you to easily add and modify
|
|
the styles that are provided by Maven.
|
|
</p>
|
|
</section>
|
|
</body>
|
|
</document>
|