Decoration

This is a reference for the site decoration descriptor used in Doxia, also known as site.xml.

An XSD is available at:

<project name=.. >
  <bannerLeft>
    <name/>
    <src/>
    <alt/>
    <href/>
  </bannerLeft>
  <bannerRight>
    <name/>
    <src/>
    <alt/>
    <href/>
  </bannerRight>

  <publishDate position=.. format=.. />
  <version position=.. />
  <poweredBy>
    <logo img=.. name=.. href=.. />
  </poweredBy>

  <skin>
    <groupId/>
    <artifactId/>
    <version/>
  </skin>

  <body>
    <head/>
    <links>
      <item name=.. href=.. />
    </links>
    <breadcrumbs>
      <item name=.. href=.. />
    </breadcrumbs>

    <menu name=.. inherit=.. inheritAsRef=.. ref=.. img=.. >
      <item collapse=.. ref=.. name=.. href=.. >
        <description/>
        <item collapse=.. ref=.. name=.. href=.. >
          <description/>
          <items/>
        </item>
      </item>
    </menu>
  </body>
  <custom/>
</project>

project

The <project> element is the root of the site decoration descriptor. The following table lists all of the possible child elements.

Element Description
bannerLeft Banner logo on the masthead of the site to the left.
bannerRight Banner logo on the masthead of the site to the right.
publishDate Modify the date published display properties.
version Modify the version published display properties.
poweredBy Powered by logos list.
skin The artifact containing the skin for the site.
body The main site content decoration.
custom Custom configuration for use with customised Velocity templates.
Attribute Description
name The full name of the project.

bannerLeft

Banner logo on the masthead of the site.

Element Description
name The name of the banner.
src The location of an image for the banner.
alt The alt description for the banner image.
href The href of a link to be used for the banner image.

bannerRight

Banner logo on the masthead of the site.

Element Description
name The name of the banner.
src The location of an image for the banner.
alt The alt description for the banner image.
href The href of a link to be used for the banner image.

publishDate

Modify display properties for date published.

Attribute Description
position Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
format Date format to use. The default is MM/dd/yyyy.

version

Modify display properties for version published.

Attribute Description
position Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).

logo

Power by logo on the navigation.

Attribute Description
img The href of a link to be used for the power by image.
name The name to display for the link.
href The href to use for the link.

skin

An skin artifact declaration.

Element Description
groupId The skin group ID.
artifactId The skin artifact ID.
version The skin version.

body

The main content decoration.

Element Description
head Additional content (like Javascript) to include in the HEAD block of the generated pages.
links A list of links to display in the navigation.
breadcrumbs A list of breadcrumbs to display in the navigation.
menus A list of menus to include in the navigation.

item

A link in the navigation.

Attribute Description
name The name to display for the link.
href The href to use for the link.

item

A link in the navigation.

Attribute Description
name The name to display for the link.
href The href to use for the link.

menu

A menu in the navigation.

Element Description
items A list of menu item.
Attribute Description
name The name to display for the menu.
inherit The way in which the menu is inherited. Can be one of : top, bottom.
inheritAsRef If this is a reference, setting true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited. The default value is false.
ref A reference to a pre-defined menu, such as a reports, modules or parentProject.
img The location of an image.

item

A menu item.

Element Description
description A description of the menu item. This is used on any summary pages for a menu.
items Menu item.
Attribute Description
collapse Whether to collapse children elements of an item menu (by default). The default value is false.
ref A reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.
name The name to display for the link.
href The href to use for the link.

item

A menu item.

Element Description
description A description of the menu item. This is used on any summary pages for a menu.
items Menu item.
Attribute Description
collapse Whether to collapse children elements of an item menu (by default). The default value is false.
ref A reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.
name The name to display for the link.
href The href to use for the link.