Serialized Form
-
Package org.apache.maven.doxia.site
-
Class org.apache.maven.doxia.site.Banner extends LinkItem implements Serializable
-
Class org.apache.maven.doxia.site.Body extends java.lang.Object implements Serializable
-
Serialized Fields
-
breadcrumbs
java.util.List<LinkItem> breadcrumbs
Field breadcrumbs. -
footer
java.lang.String footer
If present, the contained text will be used instead of the generated copyright text. -
head
java.lang.String head
Additional content (like JavaScript) to include in the HEAD block of the generated pages. -
links
java.util.List<LinkItem> links
Field links. -
menus
java.util.List<Menu> menus
Field menus.
-
-
-
Class org.apache.maven.doxia.site.Image extends java.lang.Object implements Serializable
-
Serialized Fields
-
alt
java.lang.String alt
The alternative text to use. -
height
java.lang.String height
The height to use. -
position
java.lang.String position
Where to place the image relative to the displayed name (left or right). -
src
java.lang.String src
The source location. -
style
java.lang.String style
The style to use. -
width
java.lang.String width
The width to use.
-
-
-
Class org.apache.maven.doxia.site.LinkItem extends java.lang.Object implements Serializable
-
Serialized Fields
-
href
java.lang.String href
The href to use for the link. -
image
Image image
The image for the link. -
name
java.lang.String name
The name to display for the link. -
target
java.lang.String target
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window.
-
-
-
Class org.apache.maven.doxia.site.Logo extends LinkItem implements Serializable
-
Class org.apache.maven.doxia.site.Menu extends java.lang.Object implements Serializable
-
Serialized Fields
-
image
Image image
The image for the menu. -
inherit
java.lang.String inherit
The way in which the menu is inherited. Can be one of :top
,bottom
. -
inheritAsRef
boolean inheritAsRef
If this is a reference, setting totrue
means that it will be populated in the site, whereas if it isfalse
, it is populated in the parent and then inherited. -
items
java.util.List<MenuItem> items
Field items. -
name
java.lang.String name
The name to display for the menu. -
ref
java.lang.String ref
Mark this menu as reference to a pre-defined menu:reports
,modules
orparent
. It will be populated at runtime with corresponding pre-defined content.
-
-
-
Class org.apache.maven.doxia.site.MenuItem extends LinkItem implements Serializable
-
Serialized Fields
-
collapse
boolean collapse
Whether to collapse children elements of an item menu (by default). -
items
java.util.List<MenuItem> items
Field items. -
ref
java.lang.String 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.
-
-
-
Class org.apache.maven.doxia.site.PublishDate extends java.lang.Object implements Serializable
-
Serialized Fields
-
format
java.lang.String format
Date format to use. -
position
java.lang.String position
Where to place the date published (left, right, navigation-top, navigation-bottom, bottom). -
timezone
java.lang.String timezone
The timezone to use. Usesystem
for the default locale for this instance of the Java Virtual Machine. Refer tojava.util.TimeZone
for details.
-
-
-
Class org.apache.maven.doxia.site.SiteModel extends java.lang.Object implements Serializable
-
Serialized Fields
-
bannerLeft
Banner bannerLeft
Banner logo on the masthead of the site to the left. -
bannerRight
Banner bannerRight
Banner logo on the masthead of the site to the right. -
body
Body body
The main site content. -
combineSelf
java.lang.String combineSelf
Whether to inherit configuration from a parent project site descriptor (merge
) or not (override
). -
custom
java.lang.Object custom
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()
-
edit
java.lang.String edit
The base url to edit Doxia document sources. In general,${project.scm.url}
value should do the job. -
lastModified
long lastModified
Timestamp of the last modification of this site model. -
menusByRef
java.util.Map<java.lang.String,Menu> menusByRef
-
modelEncoding
java.lang.String modelEncoding
Field modelEncoding. -
name
java.lang.String name
The full name of the project site. -
poweredBy
java.util.List<Logo> poweredBy
Field poweredBy. -
publishDate
PublishDate publishDate
Modify the date published display properties. -
requireParent
boolean requireParent
Whether this "site.xml" should inherit from a parent "site.xml". If set to "true" it fails the build in case a parent site descriptor cannot be retrieved. It does not necessarily need to be the direct parent but just a site descriptor anywhere in the parent hierarchy. -
skin
Skin skin
The artifact containing the skin for the site. -
version
Version version
Modify the version published display properties.
-
-
-
Class org.apache.maven.doxia.site.Skin extends java.lang.Object implements Serializable
-
Serialized Fields
-
artifactId
java.lang.String artifactId
The skin artifact ID. -
groupId
java.lang.String groupId
The skin group ID. -
version
java.lang.String version
The skin version.
-
-
-
Class org.apache.maven.doxia.site.Version extends java.lang.Object implements Serializable
-
Serialized Fields
-
position
java.lang.String position
Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
-
-
-
-
Package org.apache.maven.doxia.site.decoration
-
Class org.apache.maven.doxia.site.decoration.Banner extends java.lang.Object implements Serializable
-
Serialized Fields
-
alt
java.lang.String alt
The alt description for the banner image. -
border
java.lang.String border
The border to use for the banner image. -
height
java.lang.String height
The height to use for the banner image. -
href
java.lang.String href
The href of a link to be used for the banner image. -
name
java.lang.String name
The name of the banner. -
src
java.lang.String src
The source location of an image for the banner. -
title
java.lang.String title
The title for the banner image. -
width
java.lang.String width
The width to use for the banner image.
-
-
-
Class org.apache.maven.doxia.site.decoration.Body extends java.lang.Object implements Serializable
-
Serialized Fields
-
breadcrumbs
java.util.List<LinkItem> breadcrumbs
Field breadcrumbs. -
footer
java.lang.String footer
If present, the contained text will be used instead of the generated copyright text. -
head
java.lang.String head
Additional content (like JavaScript) to include in the HEAD block of the generated pages. -
links
java.util.List<LinkItem> links
Field links. -
menus
java.util.List<Menu> menus
Field menus.
-
-
-
Class org.apache.maven.doxia.site.decoration.DecorationModel extends java.lang.Object implements Serializable
-
Serialized Fields
-
bannerLeft
Banner bannerLeft
Banner logo on the masthead of the site to the left. -
bannerRight
Banner bannerRight
Banner logo on the masthead of the site to the right. -
body
Body body
The main site content decoration. -
combineSelf
java.lang.String combineSelf
Whether to inherit configuration from a parent project site descriptor (merge
) or not (override
). -
custom
java.lang.Object custom
Custom configuration for use with customized Velocity templates. Data from this field are accessible in Velocity template from$decoration.custom
variable as DOM content. Example:$decoration.custom.getChild( 'customElement' ).getValue()
-
edit
java.lang.String edit
The base url to edit Doxia document sources. In general,${project.scm.url}
value should do the job. -
lastModified
long lastModified
Timestamp of the last modification of this decoration model. -
menusByRef
java.util.Map<java.lang.String,Menu> menusByRef
-
modelEncoding
java.lang.String modelEncoding
Field modelEncoding. -
name
java.lang.String name
The full name of the project. -
poweredBy
java.util.List<Logo> poweredBy
Field poweredBy. -
publishDate
PublishDate publishDate
Modify the date published display properties. -
skin
Skin skin
The artifact containing the skin for the site. -
version
Version version
Modify the version published display properties.
-
-
-
Class org.apache.maven.doxia.site.decoration.LinkItem extends java.lang.Object implements Serializable
-
Serialized Fields
-
alt
java.lang.String alt
The alt to use for the image. -
border
java.lang.String border
The border to use for the image. -
height
java.lang.String height
The height to use for the image. -
href
java.lang.String href
The href to use for the link. -
img
java.lang.String img
The source location of an image. -
name
java.lang.String name
The name to display for the link. -
position
java.lang.String position
Where to place the image regarding the displayed name (left or right). -
target
java.lang.String target
Where the new document will be displayed when the user follows a link, i.e. _blank opens the new document in a new window. -
title
java.lang.String title
The title to use for the image. -
width
java.lang.String width
The width to use for the image.
-
-
-
Class org.apache.maven.doxia.site.decoration.Logo extends LinkItem implements Serializable
-
Class org.apache.maven.doxia.site.decoration.Menu extends java.lang.Object implements Serializable
-
Serialized Fields
-
alt
java.lang.String alt
The alt description for the image. -
border
java.lang.String border
The border to use for the menu image. -
height
java.lang.String height
The height to use for the menu image. -
img
java.lang.String img
The source location of an menu image. -
inherit
java.lang.String inherit
The way in which the menu is inherited. Can be one of :top
,bottom
. -
inheritAsRef
boolean inheritAsRef
If this is a reference, setting totrue
means that it will be populated in the project, whereas if it isfalse
, it is populated in the parent and then inherited. -
items
java.util.List<MenuItem> items
Field items. -
name
java.lang.String name
The name to display for the menu. -
position
java.lang.String position
Where to place the image regarding the displayed name (left or right). -
ref
java.lang.String ref
Mark this menu as reference to a pre-defined menu:reports
,modules
orparent
. It will be populated at runtime with corresponding pre-defined content. -
title
java.lang.String title
The title for the image. -
width
java.lang.String width
The width to use for the menu image.
-
-
-
Class org.apache.maven.doxia.site.decoration.MenuItem extends LinkItem implements Serializable
-
Serialized Fields
-
collapse
boolean collapse
Whether to collapse children elements of an item menu (by default). -
description
java.lang.String description
A description of the menu item. This is used on any summary pages for a menu. -
items
java.util.List<MenuItem> items
Field items. -
ref
java.lang.String 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.
-
-
-
Class org.apache.maven.doxia.site.decoration.PublishDate extends java.lang.Object implements Serializable
-
Serialized Fields
-
format
java.lang.String format
Date format to use. -
position
java.lang.String position
Where to place the date published (left, right, navigation-top, navigation-bottom, bottom). -
timezone
java.lang.String timezone
The timezone to use. Usesystem
for the default locale for this instance of the Java Virtual Machine. Refer tojava.util.TimeZone
for details.
-
-
-
Class org.apache.maven.doxia.site.decoration.Skin extends java.lang.Object implements Serializable
-
Serialized Fields
-
artifactId
java.lang.String artifactId
The skin artifact ID. -
groupId
java.lang.String groupId
The skin group ID. -
version
java.lang.String version
The skin version.
-
-
-
Class org.apache.maven.doxia.site.decoration.Version extends java.lang.Object implements Serializable
-
Serialized Fields
-
position
java.lang.String position
Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
-
-
-