...
- Inherited navigational elements
- Using submenus
- Ability to generate within the subproject, or at the top level and get the same results (with the exception of aggregated reports)
- No strict requirements on filesystem layout other than those that already exist for Maven projects
- Ability to aggregate reports (individual report technique out of scope here)
- Breadcrumbing
- Skinning
- Separation of user and developer documentation
- Separation of different releases in documentation
Proposed Solutions
Inherited Navigational Elements
...
We can add inherit="top|bottom|none"
to the menu
element, with true
none
as the default.
Code Block | ||||
---|---|---|---|---|
| ||||
<menu name="Commons Common"> <item ... /> </menu> <menu name="Commons Specifics" inherit="falsebottom"> <item ... /> </menu> |
Using Submenus
...
Skinning support will provided by a separate artifact that contains CSS, images and is unpakced over a site. It can optionally contain a replacement site.vm
velocity template for generating the final XHTML.
It is built as a normal JAR, using a custom packaging of "maven-skin". To configure the skin in the client, add it to the site plugin:
Code Block | ||||
---|---|---|---|---|
| ||||
<plugin> <artifactId>maven-site-plugin</artifactId> <configuration> <skinArtifact> <groupId>org.apache.maven</groupId> <artifactId>maven-site-skin</artifactId> <version>1.0-SNAPSHOT</version> </skinArtifact> </configuration> |
Separation of user and developer documentation
see http://jira.codehaus.org/browse/MNG-41