c940fa00ad
its more descriptive. The docs are always generated, this property is just a little shortcut to have them not displayed in the navigation bar. I've also updated the documentation to reflect this change. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112834 13f79535-47bb-0310-9956-ffa450edef68
440 lines
15 KiB
XML
440 lines
15 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Xdoc Properties</title>
|
|
<author email="smor@apache.org">Stéphane MOR</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="UI Color Settings">
|
|
<table>
|
|
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
|
<tr>
|
|
<td>maven.ui.body.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used for the body of each
|
|
page. The default value is <code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.body.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the body of each
|
|
page. The default value is <code>#000</code> (black).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.section.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the primary (1st
|
|
level) section headers. The default value is
|
|
<code>#036</code> (dark blue).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.section.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the primary (1st
|
|
level) section headers. The default value is
|
|
<code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.subsection.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the secondary (2nd
|
|
level) subsection headers. The default value is
|
|
<code>#888</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.subsection.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the secondary (2nd
|
|
level) subsection headers. The default value is
|
|
<code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.table.header.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the table header row.
|
|
The default value is <code>#bbb</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.table.header.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the table header row.
|
|
The default value is <code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.table.row.odd.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the odd numbered
|
|
table rows. The default value is <code>#ddd</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.table.row.odd.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the odd numbered
|
|
table rows. The default value is <code>#000</code> (black).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.table.row.even.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the even numbered
|
|
table rows. The default value is <code>#ddd</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.table.row.even.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the even numbered
|
|
table rows. The default value is <code>#000</code> (black).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.banner.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the banner. The
|
|
default value is <code>#036</code> (dark blue).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.banner.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the banner. The
|
|
default value is <code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.banner.border.top</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the top-edge border of the
|
|
banner. The default value is <code>#369</code> (blue).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.banner.border.bottom</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the bottom-edge border of the
|
|
banner. The default value is <code>#003</code> (black).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.source.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used in the source regions.
|
|
The default value is <code>#036</code> (dark blue).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.source.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used in the source regions.
|
|
The default value is <code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.source.border.top</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the top-edge border of source
|
|
regions. The default value is <code>#888</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.source.border.bottom</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the bottom-edge border of
|
|
source regions. The default value is <code>#888</code>
|
|
(gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.source.border.right</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the right-edge border of
|
|
source regions. The default value is <code>#888</code>
|
|
(gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.source.border.left</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the left-edge border of
|
|
source regions. The default value is <code>#888</code>
|
|
(gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used for the navigation
|
|
column on the left-hand side of the page. The default value
|
|
is <code>#eee</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.background.ns4</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used for the navigation
|
|
column on the left-hand side of the page for Netscape 4.x.
|
|
The default value is <code>#fff</code>. Netscape 4.x does
|
|
not properly display the entire background using this color,
|
|
only the background of the text utilizes this color.
|
|
Therefore, it is recommended that this value is set to
|
|
white.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used for the navigation
|
|
column on the left-hand side of the page. The default value
|
|
is <code>#000</code> (black).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.foreground.ns4</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used for the navigation
|
|
column on the left-hand side of the page for Netscape 4.x.
|
|
The default value is <code>#555</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.border.top</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the top-edge border of the
|
|
navigation column. The default value is <code>#fff</code>
|
|
(white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.border.right</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the right-edge border of the
|
|
navigation column. The default value is <code>#aaa</code>
|
|
(gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.navcol.border.bottom</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the bottom-edge border of the
|
|
navigation column. The default value is <code>#aaa</code>
|
|
(gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.breadcrumbs.background</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the background color used for the horizontal
|
|
navigation bar located immediately under the banner (note:
|
|
this element is not displayed on the page if no links have
|
|
been specified). The default value is <code>#ddd</code>
|
|
(gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.breadcrumbs.foreground</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the foreground color used for the horizontal
|
|
navigation bar located immediately under the banner (note:
|
|
this element is not displayed on the page if no links have
|
|
been specified). The default value is <code>#000</code>
|
|
(black).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.breadcrumbs.border.top</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the top-edge border of the
|
|
horizontal navigation section. The default value is
|
|
<code>#fff</code> (white).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.breadcrumbs.border.bottom</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for the bottom-edge border of the
|
|
horizontal navigation section. The default value is
|
|
<code>#aaa</code> (gray).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.href.link</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for all links. The default value is
|
|
<code>blue</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.ui.href.link.active</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for all links that are active (i.e.
|
|
the color used when the mouse is currently over the link).
|
|
The default value is <code>#f30</code> (red).
|
|
</td>
|
|
</tr>
|
|
<!--
|
|
<tr>
|
|
<td>maven.ui.href.link.selfref</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the color used for all links that refer to
|
|
themselves. The default value is <code>#555</code> (gray).
|
|
</td>
|
|
</tr>
|
|
-->
|
|
</table>
|
|
</section>
|
|
<section name="Directory Layout Properties">
|
|
<table>
|
|
<tr>
|
|
<td>maven.docs.dest</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the location of the transformed xdocs. This is
|
|
used by the "xdoc" goal.
|
|
The default value is <code>${basedir}/docs</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.docs.src</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the location of the project's xdoc
|
|
documentation. This is used by the "xdoc" goal.
|
|
The default value is <code>${basedir}/xdocs</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.gen.docs</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the location where Maven-generated xdocs are
|
|
stored. The generated xdocs are then later transformed to
|
|
HTML. The default value is
|
|
<code>${basedir}/generated-xdocs</code>.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Localization Properties">
|
|
<table>
|
|
<tr>
|
|
<td>maven.docs.outputencoding</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the output encoding of the DVSL generated docs.
|
|
The default value is <code>ISO-8859-1</code>, an encoding supporting
|
|
english characters as well as most
|
|
<a href="http://www.w3.org/International/O-charset-lang.html">
|
|
european languages.</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Miscellaneous Properties">
|
|
<table>
|
|
<tr>
|
|
<td>maven.xdoc.date</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Allows the user to show the site generation date on the generated
|
|
website. One can place the date in 5 locations with "maven.xdoc.date":
|
|
<ul>
|
|
<li>left : on the left side of the breadcrumbs</li>
|
|
<li>right : on the right side of the breadcrumbs, before the links</li>
|
|
<li>navigation-top : above the user links, in the navigation menu</li>
|
|
<li>navigation-bottom : under Maven's links, in the navigation menu</li>
|
|
<li>bottom : after the organization name, in the footer</li>
|
|
</ul>
|
|
If "maven.xdoc.date" is left empty, no date is shown on the site (default).
|
|
The default "maven.xdoc.date.locale" is "en" (ie: english).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.date.format</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the format of the date to display.
|
|
Defaults to "dd MMMM yyyy" (eg: "14 August 2002").
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.date.locale</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the locale used for the date.
|
|
Defaults to "en", ie english.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.includeProjectDocumentation</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies if Maven should display the maven generated
|
|
project documentation on the site's navigation bar. By
|
|
default, Maven includes numerous reports and information
|
|
regarding a project. Set this value to 'no' to prevent the
|
|
inclusion on the navigation bar. Users building a
|
|
documentation site only (non-project related) will find this
|
|
value useful.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.developmentProcessUrl</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the url of development process page.
|
|
Defaults to <a href="http://jakarta.apache.org/turbine/maven/development-process.html">
|
|
http://jakarta.apache.org/turbine/maven/development-process.html</a>.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|