Serialized Form

  • Package org.apache.maven.doxia.site

    • Class org.apache.maven.doxia.site.Banner

      class Banner extends LinkItem implements Serializable

    • Class org.apache.maven.doxia.site.Body

      class Body extends Object implements Serializable

      • Serialized Fields

        • breadcrumbs
          List<LinkItem> breadcrumbs
          Field breadcrumbs.
        • footer
          String footer
          If present, the contained text will be used instead of the generated copyright text.
        • head
          String head
          Additional content (like JavaScript) to include in the HEAD block of the generated pages.
        • links
          List<LinkItem> links
          Field links.
        • menus
          List<Menu> menus
          Field menus.

    • Class org.apache.maven.doxia.site.ExternalJs

      class ExternalJs extends Object implements Serializable

      • Serialized Fields

        • integrity
          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
          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
          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
          String URL
          The URL to include via "script" element with its "src" attribute in the HTML.

    • Class org.apache.maven.doxia.site.Image

      class Image extends Object implements Serializable

      • Serialized Fields

        • alt
          String alt
          The alternative text to use. Ends up in the "img alt" attribute (https://html.spec.whatwg.org/#alt).(.
        • height
          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
          String position
          Where to place the image relative to the displayed name (left or right).
        • src
          String src
          The source location. Ends up in the "img src" attribute (https://html.spec.whatwg.org/#attr-img-src).
        • style
          String style
          The style to use. Ends up in the "img style" attribute (https://html.spec.whatwg.org/#the-style-attribute) as is.
        • width
          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

      class LinkItem extends Object implements Serializable

      • Serialized Fields

        • href
          String href
          The href to use for the link.
        • image
          Image image
          The image for the link.
        • name
          String name
          The name to display 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.

    • Class org.apache.maven.doxia.site.Menu

      class Menu extends Object implements Serializable

      • Serialized Fields

        • image
          Image image
          The image for the menu.
        • inherit
          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
          List<MenuItem> items
          Field items.
        • name
          String name
          The name to display for the menu.
        • 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.

    • Class org.apache.maven.doxia.site.MenuItem

      class MenuItem extends LinkItem implements Serializable

      • Serialized Fields

        • collapse
          boolean collapse
          Whether to collapse children elements of an item menu (by default).
        • items
          List<MenuItem> items
          Field items.
        • 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.

    • Class org.apache.maven.doxia.site.MermaidConfiguration

      class MermaidConfiguration extends Object implements Serializable

      • Serialized Fields

        • config
          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

      class PublishDate extends Object implements Serializable

      • Serialized Fields

        • fallbackPrefix
          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
          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
          String format
          Date format to use.
        • position
          String position
          Where to place the date published ("left", "right", "navigation-top", "navigation-bottom", "bottom" or "none" to hide it).
        • prefix
          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
          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
          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

      class SiteModel extends 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
          String combineSelf
          Whether to inherit configuration from a parent project site descriptor (merge) or not (override).
        • 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()
        • edit
          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
          Map<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
          String modelEncoding
          Field modelEncoding.
        • name
          String name
          The full name of the project site.
        • poweredBy
          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

      class Skin extends Object implements Serializable

      • Serialized Fields

        • artifactId
          String artifactId
          The skin artifact ID.
        • groupId
          String groupId
          The skin group ID.
        • version
          String version
          The skin version.

    • Class org.apache.maven.doxia.site.Version

      class Version extends Object implements Serializable

      • Serialized Fields

        • position
          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

      class Banner extends Object implements Serializable

      • Serialized Fields

        • alt
          String alt
          The alt description for the banner image.
        • border
          String border
          The border to use for the banner image.
        • height
          String height
          The height to use for the banner image.
        • href
          String href
          The href of a link to be used for the banner image.
        • name
          String name
          The name of the banner.
        • src
          String src
          The source location of an image for the banner.
        • title
          String title
          The title for the banner image.
        • width
          String width
          The width to use for the banner image.

    • Class org.apache.maven.doxia.site.decoration.Body

      class Body extends Object implements Serializable

      • Serialized Fields

        • breadcrumbs
          List<LinkItem> breadcrumbs
          Field breadcrumbs.
        • footer
          String footer
          If present, the contained text will be used instead of the generated copyright text.
        • head
          String head
          Additional content (like JavaScript) to include in the HEAD block of the generated pages.
        • links
          List<LinkItem> links
          Field links.
        • menus
          List<Menu> menus
          Field menus.

    • Class org.apache.maven.doxia.site.decoration.DecorationModel

      class DecorationModel extends 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
          String combineSelf
          Whether to inherit configuration from a parent project site descriptor (merge) or not (override).
        • 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()
        • edit
          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
          Map<String,Menu> menusByRef
        • modelEncoding
          String modelEncoding
          Field modelEncoding.
        • name
          String name
          The full name of the project.
        • poweredBy
          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

      class LinkItem extends Object implements Serializable

      • Serialized Fields

        • alt
          String alt
          The alt to use for the image.
        • border
          String border
          The border to use for the image.
        • height
          String height
          The height to use for the image.
        • href
          String href
          The href to use for the link.
        • img
          String img
          The source location of an image.
        • name
          String name
          The name to display for the link.
        • position
          String position
          Where to place the image regarding the displayed name (left or right).
        • 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.
        • width
          String width
          The width to use for the image.

    • Class org.apache.maven.doxia.site.decoration.Menu

      class Menu extends Object implements Serializable

      • Serialized Fields

        • alt
          String alt
          The alt description for the image.
        • border
          String border
          The border to use for the menu image.
        • height
          String height
          The height to use for the menu image.
        • img
          String img
          The source location of an menu image.
        • 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.
        • items
          List<MenuItem> items
          Field items.
        • name
          String name
          The name to display for the menu.
        • position
          String position
          Where to place the image regarding the displayed name (left or right).
        • 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.
        • title
          String title
          The title for the image.
        • width
          String width
          The width to use for the menu image.

    • Class org.apache.maven.doxia.site.decoration.MenuItem

      class MenuItem extends LinkItem implements Serializable

      • Serialized Fields

        • collapse
          boolean collapse
          Whether to collapse children elements of an item menu (by default).
        • description
          String description
          A description of the menu item. This is used on any summary pages for a menu.
        • items
          List<MenuItem> items
          Field items.
        • 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.

    • Class org.apache.maven.doxia.site.decoration.PublishDate

      class PublishDate extends Object implements Serializable

      • Serialized Fields

        • format
          String format
          Date format to use.
        • position
          String position
          Where to place the date published (left, right, navigation-top, navigation-bottom, bottom).
        • 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

      class Skin extends Object implements Serializable

      • Serialized Fields

        • artifactId
          String artifactId
          The skin artifact ID.
        • groupId
          String groupId
          The skin group ID.
        • version
          String version
          The skin version.

    • Class org.apache.maven.doxia.site.decoration.Version

      class Version extends Object implements Serializable

      • Serialized Fields

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