Serialized Form

  • 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.
        • googleAdSenseClient
          String googleAdSenseClient
          Your Google AdSense client id.
        • googleAdSenseSlot
          String googleAdSenseSlot
          Your Google AdSense slot id.
        • googleAnalyticsAccountId
          String googleAnalyticsAccountId
          The id for your Google Analytics account.
        • 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 <inheritAsRef>true</inheritAsRef> 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).
    • 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).