装饰

这是 Doxia Sitetools 中使用的站点装饰描述符的参考,也称为site.xml:它用于配置站点模板(又名皮肤)。

XSD 可在以下位置获得:

<project xmlns="http://maven.apache.org/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd"
  name=.. combine.self=.. >
  <bannerLeft>
    <name/>
    <src/>
    <alt/>
    <href/>
    <border/>
    <width/>
    <height/>
    <title/>
  </bannerLeft>
  <bannerRight>
    <name/>
    <src/>
    <alt/>
    <href/>
    <border/>
    <width/>
    <height/>
    <title/>
  </bannerRight>
  <googleAdSenseClient/>
  <googleAdSenseSlot/>
  <googleAnalyticsAccountId/>

  <publishDate position=.. format=.. />
  <version position=.. />
  <edit/>
  <poweredBy>
    <logo name=.. href=.. img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. />
  </poweredBy>

  <skin>
    <groupId/>
    <artifactId/>
    <version/>
  </skin>

  <body>
    <head/>
    <links>
      <item name=.. href=.. img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. />
    </links>
    <breadcrumbs>
      <item name=.. href=.. img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. />
    </breadcrumbs>

    <menu name=.. inherit=.. inheritAsRef=.. ref=.. img=.. alt=.. position=.. border=.. width=.. height=.. title=.. >
      <item collapse=.. ref=.. name=.. href=.. img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. >
        <description/>
        <item>...recursion...<item>
      </item>
    </menu>
    <footer/>
  </body>

  <custom/>
</project>

项目

<project>元素是站点装饰描述符的根。

属性 类型 自从 描述
姓名 细绳 项目的全名。
结合.self 细绳 1.6.0 是否从父项目站点描述符( 合并)继承配置( 覆盖)。
默认值为合并
元素 类型 自从 描述
横幅左 横幅 左侧网站标头上的横幅徽标。
横幅右 横幅 右侧网站标头上的横幅徽标。
谷歌AdSense客户端 细绳 1.3.0 您的 Google AdSense 客户 ID。
谷歌AdSenseSlot 细绳 1.3.0 您的 Google AdSense 广告位 ID。
googleAnalyticsAccountId 细绳 1.1.0 您的 Google Analytics(分析)帐户的 ID。
发布日期 发布日期 修改发布日期的显示属性。
版本 版本 修改版本发布的显示属性。
编辑 细绳 1.8.0 编辑 Doxia 文档源的基本 url。一般来说, ${project.scm.url}值应该可以完成这项工作。
供电/标志* 列表<徽标> (许多)由徽标列表提供支持。
皮肤 皮肤 包含站点皮肤的工件。
身体 身体 主要网站内容装饰。
风俗 DOM 用于自定义 Velocity 模板的自定义配置。来自此字段的数据可在 Velocity 模板中从 $decoration.custom变量作为 DOM 内容访问。示例: $decoration.custom.getChild('customElement').getValue()

横幅左

网站标头上的横幅徽标。

元素 类型 自从 描述
姓名 细绳 横幅的名称。
源代码 细绳 横幅图像的源位置。
alt 细绳 横幅图像的 alt 描述。
链接 细绳 用于横幅图像的链接的 href。
边境 细绳 1.0.1 用于横幅图像的边框。
宽度 细绳 1.0.1 用于横幅图像的宽度。
高度 细绳 1.0.1 用于横幅图像的高度。
标题 细绳 1.3.0 横幅图像的标题。

横幅右

网站标头上的横幅徽标。

元素 类型 自从 描述
姓名 细绳 横幅的名称。
源代码 细绳 横幅图像的源位置。
alt 细绳 横幅图像的 alt 描述。
链接 细绳 用于横幅图像的链接的 href。
边境 细绳 1.0.1 用于横幅图像的边框。
宽度 细绳 1.0.1 用于横幅图像的宽度。
高度 细绳 1.0.1 用于横幅图像的高度。
标题 细绳 1.3.0 横幅图像的标题。

发布日期

修改发布日期的显示属性。

属性 类型 自从 描述
位置 细绳 发布日期的位置(左、右、导航顶部、导航底部、底部)。
默认值为
格式 细绳 要使用的日期格式。
默认值为yyyy-MM-dd

版本

修改已发布版本的显示属性。

属性 类型 自从 描述
位置 细绳 发布版本的放置位置(左、右、导航顶部、导航底部、底部)。
默认值为

商标

通过导航上的徽标供电。

属性 类型 自从 描述
姓名 细绳 为链接显示的名称。
链接 细绳 用于链接的 href。
图像 细绳 图像的源位置。
位置 细绳 1.0.1 关于显示名称(左或右)的图像放置位置。
默认值为
alt 细绳 1.0.1 用于图像的 alt。
边境 细绳 1.0.1 用于图像的边框。
宽度 细绳 1.0.1 用于图像的宽度。
高度 细绳 1.0.1 用于图像的高度。
目标 细绳 1.0.1 当用户点击链接时,新文档将显示在哪里,即 _blank 在新窗口中打开新文档。
标题 细绳 1.3.0 用于图像的标题。

皮肤

皮肤神器声明。

元素 类型 自从 描述
组 ID 细绳 皮肤组 ID。
工件 ID 细绳 皮肤工件 ID。
版本 细绳 皮肤版。

身体

主要内容装饰。

元素 类型 自从 描述
细绳 1.7.0 要包含在生成页面的 HEAD 块中的其他内容(如 JavaScript)。
链接/项目* 列表<链接项> (许多)要在导航中显示的链接列表。
面包屑/项目* 列表<链接项> (许多)要在导航中显示的面包屑列表。
菜单* 列表<菜单> (许多)要包含在导航中的菜单列表。
页脚 细绳 1.7.0 如果存在,将使用包含的文本而不是生成的版权文本。

物品

导航中的链接。

属性 类型 自从 描述
姓名 细绳 为链接显示的名称。
链接 细绳 用于链接的 href。
图像 细绳 图像的源位置。
位置 细绳 1.0.1 关于显示名称(左或右)的图像放置位置。
默认值为
alt 细绳 1.0.1 用于图像的 alt。
边境 细绳 1.0.1 用于图像的边框。
宽度 细绳 1.0.1 用于图像的宽度。
高度 细绳 1.0.1 用于图像的高度。
目标 细绳 1.0.1 当用户点击链接时,新文档将显示在哪里,即 _blank 在新窗口中打开新文档。
标题 细绳 1.3.0 用于图像的标题。

菜单

导航中的菜单。

属性 类型 自从 描述
姓名 细绳 为菜单显示的名称。
继承 细绳 菜单的继承方式。可以是以下之一: 顶部底部
继承AsRef 布尔值 如果这是一个引用,设置为 true意味着它将被填充到项目中,而如果它是 false,它将被填充到父级中然后继承。
默认值为false
参考 细绳 将此菜单标记为对预定义菜单的引用: reportsmodulesparent。它将在运行时使用相应的预定义内容填充。
图像 细绳 菜单图像的源位置。
alt 细绳 1.0.1 图像的 alt 描述。
位置 细绳 1.0.1 关于显示名称(左或右)的图像放置位置。
默认值为
边境 细绳 1.0.1 用于菜单图像的边框。
宽度 细绳 1.0.1 用于菜单图像的宽度。
高度 细绳 1.0.1 用于菜单图像的高度。
标题 细绳 1.3.0 图片的标题。
元素 类型 自从 描述
项目* 列表<菜单项> (许多)菜单项列表。

物品

一个菜单项。

属性 类型 自从 描述
坍塌 布尔值 是否折叠项目菜单的子元素(默认情况下)。
默认值为false
参考 细绳 对预定义菜单项的引用,例如报告(由报告目标名称指定)。任何显式给出的元素都会覆盖预定义参考中的元素。
姓名 细绳 为链接显示的名称。
链接 细绳 用于链接的 href。
图像 细绳 图像的源位置。
位置 细绳 1.0.1 关于显示名称(左或右)的图像放置位置。
默认值为
alt 细绳 1.0.1 用于图像的 alt。
边境 细绳 1.0.1 用于图像的边框。
宽度 细绳 1.0.1 用于图像的宽度。
高度 细绳 1.0.1 用于图像的高度。
目标 细绳 1.0.1 当用户点击链接时,新文档将显示在哪里,即 _blank 在新窗口中打开新文档。
标题 细绳 1.3.0 用于图像的标题。
元素 类型 自从 描述
描述 细绳 菜单项的描述。这用于菜单的任何摘要页面。
项目* 列表<菜单项> (许多)菜单项列表。