>>>>> mike witters writes:
mike> For instance, if I provide a 'User Guide' page for our project,
mike> how does that get added to the Maven-generated documentation as
mike> a link on the nav menu?
The contents of the navbar is controlled by the 'navigation.xml' file
located in your 'xdocs' directory. The format of this file is like
the following (here is the one used by Maven):
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven">
<title>Maven</title>
<body>
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Features" href="/features.html"/>
<item name="Download" href="/start/download.html"/>
<item name="News and Status" href="/status.html"/>
<item name="Getting Started" href="/start/index.html"/>
<item name="Reference" href="/reference/index.html"/>
<item name="FAQ" href="/faq.html"/>
<item name="Powered By" href="/powered.html"/>
</menu>
</body>
</project>
Basically, you just add <item/> to add a new link to a section of the
navbar. If you want to create a new section, add a new <menu/>, and
then add an <item/> in there. You can also nest <menu/> tags to
create "expanding" hierarchies.
As for the location of your user's guide, write an xdoc and place it
in the 'xdocs' directory. The xdoc format is pretty simple, just look
at one of the many docs in the maven xdocs directory for an example.
If you don't want to use xdoc, you can use the APT (almost plain text)
plugin which lets you write your documentation using 'wiki'-like
notation.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
