4e177daa2d
Submitted by: Vincent Siveton Reviewed by: Brett Porter, Arnaud Heritier Internationalization support for xdoc. Applied with changes git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@171222 13f79535-47bb-0310-9956-ffa450edef68
671 lines
23 KiB
XML
671 lines
23 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!--
|
|
/*
|
|
* 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>Xdoc Properties</title>
|
|
<author email="smor@apache.org">Stéphane MOR</author>
|
|
<author email="vmassol@apache.org">Vincent Massol</author>
|
|
<author email="vincent.siveton@gmail.com">Vincent Siveton</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Directory Layout Properties">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<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>${maven.build.dir}/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>${maven.build.dir}/generated-xdocs</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.xml.copy</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
A comma separated list of patterns to specify xml files to copy
|
|
from ${maven.docs.src} to ${maven.docs.dest} without
|
|
to perform a transformation to HTML.
|
|
The default value is empty (no xml files are copied).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.copy.excludes</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
A comma separated list of patterns to specify resources not to copy
|
|
in xdoc:copy-resources. By default it is all the images not used by
|
|
Maven.
|
|
Override this to get back some images you need in your site.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.copy.excludes.classic</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
A comma separated list of patterns to specify resources not to copy
|
|
in xdoc:copy-resources when using a theme other than classic.
|
|
Override this to get back some images you need in your site when
|
|
using a non-classic theme.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Localization Properties">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<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="I18n Properties">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
</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"). For details on the format, see
|
|
SimpleDateFormat in the jdk documentation.
|
|
</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.locale.default</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the default locale used for the translation. If null, it is
|
|
the default locale for this instance of the Java Virtual Machine
|
|
Defaults to "en", ie english, to ensure backward compatible.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.locale.supported</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
A comma separated of locales supported by the project, ie "fr,
|
|
en_CA"
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.bundle.src</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the location where user bundles are stored. The
|
|
default value is ${maven.docs.src}.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.bundle</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the name of the user bundles. The default value is
|
|
xdocs.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.ui.displayByDefault</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Boolean value to specify the display of the default language, ie
|
|
"English [By default]". The default value is false.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.ui.localeList.asSelect</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Boolean value to display the language list as an HTML
|
|
<select/> tag. The default value is false.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.ui.localeList.max</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
An integer value to specify the maximum number of locales
|
|
displayes without an HTML <select/> tag. The default value is 5.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Presentation Properties">
|
|
<table>
|
|
<tr>
|
|
<th>Property name</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.theme</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The documentation theme to use. The default is <code>theme</code>,
|
|
and valid values are <code>theme</code> (RC2+) or <code>classic</code>
|
|
(used in Maven RC1 and below).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.theme.url</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The documentation theme to use. The URL should point to a CSS file
|
|
that can be used in addition to maven-base.css.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.crumb.separator</td>
|
|
<td>Yes</td>
|
|
<td>The separator between links. Defaults to <code>|</code></td>
|
|
</tr>
|
|
<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).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.version</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The version number to show next to the date. This only works if you also set
|
|
<code>maven.xdoc.date</code> to either <code>left</code> or <code>right</code>.
|
|
A common way to use it is like this:
|
|
<code>maven.xdoc.version=${pom.currentVersion}</code>.
|
|
If <code>maven.xdoc.version</code> is left empty, no version is shown on the site (default).
|
|
</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://maven.apache.org/development-process.html">
|
|
http://maven.apache.org/development-process.html</a>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.legend</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Whether to display the legend in the left navigation. Default is <code>true</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.poweredby.image</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the name of the image to use (see images/logos).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.poweredby.title</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the title of the link for the powered
|
|
by logo. Defaults to "Powered by Maven"
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.poweredby.url</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the target of the link for the powered
|
|
by logo. Defaults to "http://maven.apache.org/"
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.jsl</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The JSL stylesheet used to convert xdocs to HTML. To override, specify as a
|
|
<code>file:</code> URL.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.distributionUrl</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Location where the artifacts are distributed. This property is
|
|
optional. If it is not defined, then the Download report will
|
|
not be added to the navigation menu. NOTE: In the future this
|
|
information will be described in the POM. Usage example:
|
|
<code>maven.xdoc.distributionUrl=http://www.ibiblio.org/maven/maven/plugins</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.xdoc.distributionType</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Type of the distributed artifact. Override this property if
|
|
your project is distributing artifacts of a type different
|
|
that the default. NOTE: In the future
|
|
this information will be described in the POM.
|
|
Default value: <code>maven.xdoc.distributionType=jar</code>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="UI Color Settings (Classic theme only)">
|
|
<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.navcol.width</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the width for the navigation column. The
|
|
default value is <code>20%</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>
|
|
</body>
|
|
</document>
|