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.ExternalJs extends java.lang.Object implements Serializable
  - Serialized Fields
    - integrity
      
      java.lang.String integrity
      
      The integrity hash to use for the external JS file emitted in the "script" element's "integrity" attribute. Its semantics are described in https://www.w3.org/TR/sri-2/ and its usage is strongly recommended. Some example tools for calculating the value are outlined in https://developer.mozilla.org/en-US/docs/Web/Security/Defenses/Subresource_Integrity#tools_for_generating_sri_hashes.
    - otherAttributes
      
      java.lang.String otherAttributes
      
      Other attributes to include in the "script" element for this external JS file, in the form of a whitespace separated list of key=value pairs. The keys and values will be included as-is in the generated "script" element, without any validation.
    - referrerpolicy
      
      java.lang.String referrerpolicy
      
      The referrerpolicy attribute to use when requesting the external JS file. Its semantics are described in https://www.w3.org/TR/referrer-policy/ and setting it to "no-referrer" prevents sharing unnecessary information with 3rd parties.
    - URL
      
      java.lang.String URL
      
      The URL to include via "script" element with its "src" attribute in the HTML.
- 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. Ends up in the "img alt" attribute (https://html.spec.whatwg.org/#alt).(.
    - height
      
      java.lang.String height
      
      The height to use. Added to the generated "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) prefixed by "height: ".
    - 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. Ends up in the "img src" attribute (https://html.spec.whatwg.org/#attr-img-src).
    - style
      
      java.lang.String style
      
      The style to use. Ends up in the "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) as is.
    - width
      
      java.lang.String width
      
      The width to use. Added to the generated "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) prefixed by "width: ".
- 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 or empty. If empty the menu is not inherited (i.e. won't be exposed in sub projects) which is the default behavior. Value bottom means it appears below sub project's defined menus, top means it appears above sub project's defined menus.
    - 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.
    - 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 or parent. 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.MermaidConfiguration extends java.lang.Object implements Serializable
  - Serialized Fields
    - config
      
      java.lang.String config
      
      The Mermaid configuration in JSON format as described in https://mermaid.ai/open-source/config/setup/mermaid/interfaces/MermaidConfig.html.
    - externalJs
      
      ExternalJs externalJs
      
      The URL from which to request the javascript used for rendering the diagrams. If not set an embedded version of Mermaid is used (which is automatically deployed to the site)
    - useTiny
      
      boolean useTiny
      
      If Tiny Mermaid (https://github.com/mermaid-js/mermaid/tree/develop/packages/tiny#tiny-mermaid) should be used. Only considered if "externalJsUrl" is not set
- Class org.apache.maven.doxia.site.PublishDate extends java.lang.Object implements Serializable
  - Serialized Fields
    - fallbackPrefix
      
      java.lang.String fallbackPrefix
      
      The prefix to emit in front of the fallback date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.
    - fallbackValue
      
      java.lang.String fallbackValue
      
      The Velocity context key to use as source for the date. Used as fallback when the context given in "value" is not available. Must have a value of type java.util.Date. This is useful when the context given in "value" is only available for Doxia source documents (but not for reports).
    - 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" or "none" to hide it).
    - prefix
      
      java.lang.String prefix
      
      The prefix to emit in front of the date. When starting with template. it is assumed to reference a key from the site-renderer.properties, otherwise it is a literal value.
    - timezone
      
      java.lang.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.
    - value
      
      java.lang.String value
      
      The Velocity context key to use as source for the date. Usually one of "publishDate" or "scmLastModified". Must have a value of type java.util.Date.
- 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
    - mermaid
      
      MermaidConfiguration mermaid
      
      The configuration used for rendering Mermaid diagrams (https://mermaid.ai/open-source/) on client-side. If the element does not exist, no Mermaid specific scripts will be included in the generated site. If it exists but the "config" field is not set, a default configuration will be used.
    - 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" or "none" to hide it).
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 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.
    - 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 or parent. 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. 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 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).

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

footer

head

links

menus

Class org.apache.maven.doxia.site.ExternalJs extends java.lang.Object implements Serializable

Serialized Fields

integrity

otherAttributes

referrerpolicy

URL

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

Serialized Fields

alt

height

position

src

style

width

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

Serialized Fields

href

image

name

target

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

inherit

inheritAsRef

items

name

ref

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

Serialized Fields

collapse

items

ref

Class org.apache.maven.doxia.site.MermaidConfiguration extends java.lang.Object implements Serializable

Serialized Fields

config

externalJs

useTiny

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

Serialized Fields

fallbackPrefix

fallbackValue

format

position

prefix

timezone

value

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

Serialized Fields

bannerLeft

bannerRight

body

combineSelf

custom

edit

lastModified

menusByRef

mermaid

modelEncoding

name

poweredBy

publishDate

requireParent

skin

version

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

Serialized Fields

artifactId

groupId