Updated the documentation to reflect the change I just made.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113002 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
kaz committed 2003-02-26 20:35:59 +00:00
1 parent dbff6d84c1
commit 31ab82a2c7
1 file changed
+22 -12
+22 -12
View File
@@ -9,12 +9,16 @@
<body>
<section name="Maven XDoc Plug-in">
<p>
This plug-in provides the primary mechanism that is used to produce
the Maven documentation.
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:
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>
@@ -25,20 +29,26 @@
</ul>
</p>
<p>
There is addition 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.<br/>
Here is an example : <br/>
<source><![CDATA[
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>
<br/>
The footer should be placed within the body element.
]]></source>
<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>
</section>
</body>