Serialized Form (Doxia Sitetools 2.0.0-M19 API)

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 Object implements Serializable
  - Serialized Fields
    - head
```
String head
```
      Additional content (like JavaScript) to include in the HEAD block of the generated pages.
    - links
```
List<E> links
```
      Field links.
    - breadcrumbs
```
List<E> breadcrumbs
```
      Field breadcrumbs.
    - menus
```
List<E> menus
```
      Field menus.
    - footer
```
String footer
```
      If present, the contained text will be used instead of the generated copyright text.
- Class org.apache.maven.doxia.site.Image extends Object implements Serializable
  - Serialized Fields
    - src
```
String src
```
      The source location.
    - position
```
String position
```
      Where to place the image relative to the displayed name (left or right).
    - alt
```
String alt
```
      The alternative text to use.
    - width
```
String width
```
      The width to use.
    - height
```
String height
```
      The height to use.
    - style
```
String style
```
      The style to use.
- Class org.apache.maven.doxia.site.LinkItem extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name to display for the link.
    - href
```
String href
```
      The href to use for the link.
    - target
```
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.
    - image
```
Image image
```
      The image for the link.
- Class org.apache.maven.doxia.site.Logo extends LinkItem implements Serializable
- Class org.apache.maven.doxia.site.Menu extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name to display for the menu.
    - inherit
```
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 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.
    - ref
```
String ref
```
      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.
    - image
```
Image image
```
      The image for the menu.
    - items
```
List<E> items
```
      Field items.
- 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).
    - ref
```
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.
    - items
```
List<E> items
```
      Field items.
- Class org.apache.maven.doxia.site.PublishDate extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
      Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
    - format
```
String format
```
      Date format to use.
    - timezone
```
String timezone
```
      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.
- Class org.apache.maven.doxia.site.SiteModel extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The full name of the project site.
    - combineSelf
```
String combineSelf
```
      Whether to inherit configuration from a parent project site descriptor (merge) or not (override).
    - 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.
    - publishDate
```
PublishDate publishDate
```
      Modify the date published display properties.
    - version
```
Version version
```
      Modify the version published display properties.
    - edit
```
String edit
```
      The base url to edit Doxia document sources. In general, ${project.scm.url} value should do the job.
    - poweredBy
```
List<E> poweredBy
```
      Field poweredBy.
    - skin
```
Skin skin
```
      The artifact containing the skin for the site.
    - body
```
Body body
```
      The main site content.
    - custom
```
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()
    - lastModified
```
long lastModified
```
      Timestamp of the last modification of this site model.
    - modelEncoding
```
String modelEncoding
```
      Field modelEncoding.
    - menusByRef
```
Map<K,V> menusByRef
```
- Class org.apache.maven.doxia.site.Skin extends Object implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The skin group ID.
    - artifactId
```
String artifactId
```
      The skin artifact ID.
    - version
```
String version
```
      The skin version.
- Class org.apache.maven.doxia.site.Version extends Object implements Serializable
  - Serialized Fields
    - position
```
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 Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the banner.
    - src
```
String src
```
      The source location of an image for the banner.
    - alt
```
String alt
```
      The alt description for the banner image.
    - href
```
String href
```
      The href of a link to be used for the banner image.
    - border
```
String border
```
      The border to use for the banner image.
    - width
```
String width
```
      The width to use for the banner image.
    - height
```
String height
```
      The height to use for the banner image.
    - title
```
String title
```
      The title for the banner image.
- Class org.apache.maven.doxia.site.decoration.Body extends Object implements Serializable
  - Serialized Fields
    - head
```
String head
```
      Additional content (like JavaScript) to include in the HEAD block of the generated pages.
    - links
```
List<E> links
```
      Field links.
    - breadcrumbs
```
List<E> breadcrumbs
```
      Field breadcrumbs.
    - menus
```
List<E> menus
```
      Field menus.
    - footer
```
String footer
```
      If present, the contained text will be used instead of the generated copyright text.
- Class org.apache.maven.doxia.site.decoration.DecorationModel extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The full name of the project.
    - combineSelf
```
String combineSelf
```
      Whether to inherit configuration from a parent project site descriptor (merge) or not (override).
    - 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.
    - publishDate
```
PublishDate publishDate
```
      Modify the date published display properties.
    - version
```
Version version
```
      Modify the version published display properties.
    - edit
```
String edit
```
      The base url to edit Doxia document sources. In general, ${project.scm.url} value should do the job.
    - poweredBy
```
List<E> poweredBy
```
      Field poweredBy.
    - skin
```
Skin skin
```
      The artifact containing the skin for the site.
    - body
```
Body body
```
      The main site content decoration.
    - custom
```
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()
    - lastModified
```
long lastModified
```
      Timestamp of the last modification of this decoration model.
    - modelEncoding
```
String modelEncoding
```
      Field modelEncoding.
    - menusByRef
```
Map<K,V> menusByRef
```
- Class org.apache.maven.doxia.site.decoration.LinkItem extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name to display for the link.
    - href
```
String href
```
      The href to use for the link.
    - img
```
String img
```
      The source location of an image.
    - position
```
String position
```
      Where to place the image regarding the displayed name (left or right).
    - alt
```
String alt
```
      The alt to use for the image.
    - border
```
String border
```
      The border to use for the image.
    - width
```
String width
```
      The width to use for the image.
    - height
```
String height
```
      The height to use for the image.
    - target
```
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
```
String title
```
      The title 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 Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name to display for the menu.
    - inherit
```
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 to true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
    - ref
```
String ref
```
      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.
    - img
```
String img
```
      The source location of an menu image.
    - alt
```
String alt
```
      The alt description for the image.
    - position
```
String position
```
      Where to place the image regarding the displayed name (left or right).
    - border
```
String border
```
      The border to use for the menu image.
    - width
```
String width
```
      The width to use for the menu image.
    - height
```
String height
```
      The height to use for the menu image.
    - title
```
String title
```
      The title for the image.
    - items
```
List<E> items
```
      Field items.
- Class org.apache.maven.doxia.site.decoration.MenuItem extends LinkItem implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description of the menu item. This is used on any summary pages for a menu.
    - collapse
```
boolean collapse
```
      Whether to collapse children elements of an item menu (by default).
    - ref
```
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.
    - items
```
List<E> items
```
      Field items.
- Class org.apache.maven.doxia.site.decoration.PublishDate extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
      Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
    - format
```
String format
```
      Date format to use.
    - timezone
```
String timezone
```
      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.
- Class org.apache.maven.doxia.site.decoration.Skin extends Object implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The skin group ID.
    - artifactId
```
String artifactId
```
      The skin artifact ID.
    - version
```
String version
```
      The skin version.
- Class org.apache.maven.doxia.site.decoration.Version extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
      Where to place the version published (left, right, navigation-top, navigation-bottom, bottom).
Package org.apache.maven.doxia.site.skin
- Class org.apache.maven.doxia.site.skin.Prerequisites extends Object implements Serializable
  - Serialized Fields
    - doxiaSitetools
```
String doxiaSitetools
```
      The minimum version of Doxia Sitetools required to use the resulting skin.
- Class org.apache.maven.doxia.site.skin.SkinModel extends Object implements Serializable
  - Serialized Fields
    - prerequisites
```
Prerequisites prerequisites
```
      Describes the prerequisites in the build environment for using this skin.
    - encoding
```
String encoding
```
      Encoding of text content, like the Velocity template itself.
    - modelEncoding
```
String modelEncoding
```
      Field modelEncoding.
Package org.apache.maven.doxia.siterenderer
- Class org.apache.maven.doxia.siterenderer.RendererException extends Exception implements Serializable
  
  serialVersionUID:
  
  3141592653589793238L
Package org.apache.maven.doxia.tools
- Class org.apache.maven.doxia.tools.SiteToolException extends Exception implements Serializable
  
  serialVersionUID:
  
  2331441332996055959L

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 Object implements Serializable

Serialized Fields

head

links

breadcrumbs

menus

footer

Class org.apache.maven.doxia.site.Image extends Object implements Serializable

Serialized Fields

src

position

alt

width

height

style

Class org.apache.maven.doxia.site.LinkItem extends Object implements Serializable

Serialized Fields

name

href

target

image

Class org.apache.maven.doxia.site.Logo extends LinkItem implements Serializable

Class org.apache.maven.doxia.site.Menu extends Object implements Serializable

Serialized Fields

name

inherit

inheritAsRef

ref

image

items

Class org.apache.maven.doxia.site.MenuItem extends LinkItem implements Serializable

Serialized Fields

collapse

ref

items

Class org.apache.maven.doxia.site.PublishDate extends Object implements Serializable

Serialized Fields

position

format

timezone

Class org.apache.maven.doxia.site.SiteModel extends Object implements Serializable

Serialized Fields

name

combineSelf

bannerLeft

bannerRight

publishDate

version

edit

poweredBy

skin

body

custom

lastModified

modelEncoding

menusByRef

Class org.apache.maven.doxia.site.Skin extends Object implements Serializable

Serialized Fields

groupId

artifactId

version

Class org.apache.maven.doxia.site.Version extends Object implements Serializable

Serialized Fields

position

Package org.apache.maven.doxia.site.decoration

Class org.apache.maven.doxia.site.decoration.Banner extends Object implements Serializable

Serialized Fields

name

src

alt

href

border

width

height

title

Class org.apache.maven.doxia.site.decoration.Body extends Object implements Serializable

Serialized Fields