Site
This is a reference for the site descriptor used in Doxia Sitetools, also known as site.xml
: it is used to configure a site template (aka skin).
An XSD is available at:
<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd" name=.. combine.self=.. > <bannerLeft name=.. href=.. target=.. > <image src=.. position=.. alt=.. width=.. height=.. style=.. /> </bannerLeft> <bannerRight name=.. href=.. target=.. > <image src=.. position=.. alt=.. width=.. height=.. style=.. /> </bannerRight> <publishDate position=.. format=.. timezone=.. /> <version position=.. /> <edit/> <poweredBy> <logo name=.. href=.. target=.. > <image src=.. position=.. alt=.. width=.. height=.. style=.. /> </logo> </poweredBy> <skin> <groupId/> <artifactId/> <version/> </skin> <body> <head/> <links> <item name=.. href=.. target=.. > <image src=.. position=.. alt=.. width=.. height=.. style=.. /> </item> </links> <breadcrumbs> <item name=.. href=.. target=.. > <image src=.. position=.. alt=.. width=.. height=.. style=.. /> </item> </breadcrumbs> <menu name=.. inherit=.. inheritAsRef=.. ref=.. > <image src=.. position=.. alt=.. width=.. height=.. style=.. /> <item collapse=.. ref=.. name=.. href=.. target=.. > <item>...recursion...<item> <image src=.. position=.. alt=.. width=.. height=.. style=.. /> </item> </menu> <footer/> </body> <custom/> </site>
site
The <site>
element is the root of the site decoration descriptor.
Attribute | Type | Since | Description |
---|---|---|---|
name
|
String
|
The full name of the project site. | |
combine.self
|
String
|
1.6.0 | Whether to inherit configuration from a parent project site descriptor (merge ) or not (override ).
Default value: |
Element | Type | Since | Description |
---|---|---|---|
bannerLeft
|
Banner
|
Banner logo on the masthead of the site to the left. | |
bannerRight
|
Banner
|
Banner logo on the masthead of the site to the right. | |
publishDate
|
PublishDate
|
Modify the date published display properties. | |
version
|
Version
|
Modify the version published display properties. | |
edit
|
String
|
1.8.0 | The base url to edit Doxia document sources. In general, ${project.scm.url} value should do the job. |
poweredBy/logo*
|
List<Logo>
|
(Many) Powered by logos list. | |
skin
|
Skin
|
The artifact containing the skin for the site. | |
body
|
Body
|
The main site content. | |
custom
|
DOM
|
Custom configuration for use with customized Velocity templates. Data from this field are accessible in Velocity template from $site.custom variable as DOM content. Example: $site.custom.getChild( 'customElement' ).getValue() |
bannerLeft
Banner logo on the masthead of the site.
Attribute | Type | Since | Description |
---|---|---|---|
name
|
String
|
The name to display for the link. | |
href
|
String
|
The href to use for the link. | |
target
|
String
|
1.0.1 | Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. |
Element | Type | Since | Description |
---|---|---|---|
image
|
Image
|
2.0.0 | The image for the link. |
image
An image.
Attribute | Type | Since | Description |
---|---|---|---|
src
|
String
|
2.0.0 | The source location. |
position
|
String
|
2.0.0 | Where to place the image relative to the displayed name (left or right).
Default value: |
alt
|
String
|
2.0.0 | The alternative text to use. |
width
|
String
|
2.0.0 | The width to use. |
height
|
String
|
2.0.0 | The height to use. |
style
|
String
|
2.0.0 | The style to use. |
bannerRight
Banner logo on the masthead of the site.
Attribute | Type | Since | Description |
---|---|---|---|
name
|
String
|
The name to display for the link. | |
href
|
String
|
The href to use for the link. | |
target
|
String
|
1.0.1 | Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. |
Element | Type | Since | Description |
---|---|---|---|
image
|
Image
|
2.0.0 | The image for the link. |
publishDate
Modify display properties for date published.
Attribute | Type | Since | Description |
---|---|---|---|
position
|
String
|
Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
Default value: |
|
format
|
String
|
Date format to use.
Default value: |
|
timezone
|
String
|
1.8.1 | The timezone to use. Use system for the default locale for this instance of the Java Virtual Machine. Refer to java.util.TimeZone for details.
Default value: |
version
Modify display properties for version published.
Attribute | Type | Since | Description |
---|---|---|---|
position
|
String
|
Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
Default value: |
logo
Power by logo on the navigation.
Attribute | Type | Since | Description |
---|---|---|---|
name
|
String
|
The name to display for the link. | |
href
|
String
|
The href to use for the link. | |
target
|
String
|
1.0.1 | Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. |
Element | Type | Since | Description |
---|---|---|---|
image
|
Image
|
2.0.0 | The image for the link. |
skin
A skin artifact declaration.
Element | Type | Since | Description |
---|---|---|---|
groupId
|
String
|
The skin group ID. | |
artifactId
|
String
|
The skin artifact ID. | |
version
|
String
|
The skin version. |
body
The main content.
Element | Type | Since | Description |
---|---|---|---|
head
|
String
|
1.7.0 | Additional content (like JavaScript) to include in the HEAD block of the generated pages. |
links/item*
|
List<LinkItem>
|
(Many) A list of links to display in the navigation. | |
breadcrumbs/item*
|
List<LinkItem>
|
(Many) A list of breadcrumbs to display in the navigation. | |
menu*
|
List<Menu>
|
(Many) A list of menus to include in the navigation. | |
footer
|
String
|
1.7.0 | If present, the contained text will be used instead of the generated copyright text. |
item
A link in the navigation.
Attribute | Type | Since | Description |
---|---|---|---|
name
|
String
|
The name to display for the link. | |
href
|
String
|
The href to use for the link. | |
target
|
String
|
1.0.1 | Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. |
Element | Type | Since | Description |
---|---|---|---|
image
|
Image
|
2.0.0 | The image for the link. |
menu
A menu in the navigation.
Attribute | Type | Since | Description |
---|---|---|---|
name
|
String
|
The name to display for the menu. | |
inherit
|
String
|
The way in which the menu is inherited. Can be one of : top , bottom . |
|
inheritAsRef
|
boolean
|
If this is a reference, setting to true means that it will be populated in the site, whereas if it is false , it is populated in the parent and then inherited.
Default value: |
|
ref
|
String
|
Mark this menu as reference to a pre-defined menu: reports , modules or parent . It will be populated at runtime with corresponding pre-defined content. |
Element | Type | Since | Description |
---|---|---|---|
image
|
Image
|
2.0.0 | The image for the menu. |
item*
|
List<MenuItem>
|
(Many) A list of menu item. |
item
A menu item.
Attribute | Type | Since | Description |
---|---|---|---|
collapse
|
boolean
|
Whether to collapse children elements of an item menu (by default).
Default value: |
|
ref
|
String
|
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
|
String
|
The name to display for the link. | |
href
|
String
|
The href to use for the link. | |
target
|
String
|
1.0.1 | Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. |
Element | Type | Since | Description |
---|---|---|---|
item*
|
List<MenuItem>
|
(Many) A list of menu item. | |
image
|
Image
|
2.0.0 | The image for the link. |