Xdoc Properties Stéphane MOR
PropertyOptional?Description
maven.ui.body.background Yes Specifies the background color used for the body of each page. The default value is #fff (white).
maven.ui.body.foreground Yes Specifies the foreground color used in the body of each page. The default value is #000 (black).
maven.ui.section.background Yes Specifies the background color used in the primary (1st level) section headers. The default value is #036 (dark blue).
maven.ui.section.foreground Yes Specifies the foreground color used in the primary (1st level) section headers. The default value is #fff (white).
maven.ui.subsection.background Yes Specifies the background color used in the secondary (2nd level) subsection headers. The default value is #888 (gray).
maven.ui.subsection.foreground Yes Specifies the foreground color used in the secondary (2nd level) subsection headers. The default value is #fff (white).
maven.ui.table.header.background Yes Specifies the background color used in the table header row. The default value is #bbb (gray).
maven.ui.table.header.foreground Yes Specifies the foreground color used in the table header row. The default value is #fff (white).
maven.ui.table.row.odd.background Yes Specifies the background color used in the odd numbered table rows. The default value is #ddd (gray).
maven.ui.table.row.odd.foreground Yes Specifies the foreground color used in the odd numbered table rows. The default value is #000 (black).
maven.ui.table.row.even.background Yes Specifies the background color used in the even numbered table rows. The default value is #ddd (gray).
maven.ui.table.row.even.foreground Yes Specifies the foreground color used in the even numbered table rows. The default value is #000 (black).
maven.ui.banner.background Yes Specifies the background color used in the banner. The default value is #036 (dark blue).
maven.ui.banner.foreground Yes Specifies the foreground color used in the banner. The default value is #fff (white).
maven.ui.banner.border.top Yes Specifies the color used for the top-edge border of the banner. The default value is #369 (blue).
maven.ui.banner.border.bottom Yes Specifies the color used for the bottom-edge border of the banner. The default value is #003 (black).
maven.ui.source.background Yes Specifies the background color used in the source regions. The default value is #036 (dark blue).
maven.ui.source.foreground Yes Specifies the foreground color used in the source regions. The default value is #fff (white).
maven.ui.source.border.top Yes Specifies the color used for the top-edge border of source regions. The default value is #888 (gray).
maven.ui.source.border.bottom Yes Specifies the color used for the bottom-edge border of source regions. The default value is #888 (gray).
maven.ui.source.border.right Yes Specifies the color used for the right-edge border of source regions. The default value is #888 (gray).
maven.ui.source.border.left Yes Specifies the color used for the left-edge border of source regions. The default value is #888 (gray).
maven.ui.navcol.background Yes Specifies the background color used for the navigation column on the left-hand side of the page. The default value is #eee (gray).
maven.ui.navcol.background.ns4 Yes 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 #fff. 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.
maven.ui.navcol.foreground Yes Specifies the foreground color used for the navigation column on the left-hand side of the page. The default value is #000 (black).
maven.ui.navcol.foreground.ns4 Yes 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 #555 (gray).
maven.ui.navcol.border.top Yes Specifies the color used for the top-edge border of the navigation column. The default value is #fff (white).
maven.ui.navcol.border.right Yes Specifies the color used for the right-edge border of the navigation column. The default value is #aaa (gray).
maven.ui.navcol.border.bottom Yes Specifies the color used for the bottom-edge border of the navigation column. The default value is #aaa (gray).
maven.ui.breadcrumbs.background Yes 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 #ddd (gray).
maven.ui.breadcrumbs.foreground Yes 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 #000 (black).
maven.ui.breadcrumbs.border.top Yes Specifies the color used for the top-edge border of the horizontal navigation section. The default value is #fff (white).
maven.ui.breadcrumbs.border.bottom Yes Specifies the color used for the bottom-edge border of the horizontal navigation section. The default value is #aaa (gray).
maven.ui.href.link Yes Specifies the color used for all links. The default value is blue.
maven.ui.href.link.active Yes 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 #f30 (red).
maven.docs.dest Yes Specifies the location of the transformed xdocs. This is used by the "xdoc" goal. The default value is ${basedir}/docs.
maven.docs.src Yes Specifies the location of the project's xdoc documentation. This is used by the "xdoc" goal. The default value is ${basedir}/xdocs.
maven.gen.docs Yes Specifies the location where Maven-generated xdocs are stored. The generated xdocs are then later transformed to HTML. The default value is ${basedir}/generated-xdocs.
maven.docs.outputencoding Yes Specifies the output encoding of the DVSL generated docs. The default value is ISO-8859-1, an encoding supporting english characters as well as most european languages.
maven.xdoc.date Yes 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":
  • left : on the left side of the breadcrumbs
  • right : on the right side of the breadcrumbs, before the links
  • navigation-top : above the user links, in the navigation menu
  • navigation-bottom : under Maven's links, in the navigation menu
  • bottom : after the organization name, in the footer
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).
maven.xdoc.date.format Yes Sets the format of the date to display. Defaults to "dd MMMM yyyy" (eg: "14 August 2002").
maven.xdoc.date.locale Yes Sets the locale used for the date. Defaults to "en", ie english.
maven.xdoc.includeProjectDocumentation Yes 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.
maven.xdoc.developmentProcessUrl Yes Sets the url of development process page. Defaults to http://jakarta.apache.org/turbine/maven/development-process.html.