站点:站点

全名

org.apache.maven.plugins:maven-site-plugin:3.1:site

说明

为单个项目生成站点。

请注意,多模块构建中的模块站点之间的链接将不起作用

属性

  • 需要执行一个 Maven 项目。
  • 需要对范围内的工件进行依赖解析:test

可选参数

姓名 类型 自从 描述
属性 地图 - 用于呈现站点的其他模板属性。请参阅Doxia 站点渲染器
生成项目信息 布尔值 2.3 是否生成项目报告的摘要页:project-info.html。
默认值为true
生成报告 布尔值 - 允许您禁用报告生成的便利参数。
默认值为true
生成站点地图 布尔值 2.1 生成站点地图。结果将是站点根目录中的“sitemap.html”文件。
默认值为false
生成的站点目录 文件 - 包含生成文档的目录。这用于获取可能在构建时生成的其他源文档。
默认值为${project.build.directory}/generated-site
输入编码 细绳 - 指定输入编码。
默认值为${project.build.sourceEncoding}
语言环境 细绳 - Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
模块排除 地图 - 模块类型排除映射例如:fml -> **/*-m1.fml(递归排除以 '-m1.fml' 结尾的 fml 文件)配置如下所示:
  <moduleExcludes>
    <moduleType>filename1.ext,**/*sample.ext</moduleType>
    <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
    <!-- The value is a comma separated list of           -->
    <!-- filenames or fileset patterns.                   -->
    <!-- Here's an example:                               -->
    <xdoc>changes.xml,navigation.xml</xdoc>
  </moduleExcludes>

输出目录 文件 - 将生成项目站点和报告分发的目录。
默认值为${project.reporting.outputDirectory}
输出编码 细绳 - 指定输出编码。
默认值为${project.reporting.outputEncoding}
相对化装饰链接 布尔值 2.3 在站点描述符中创建相对于项目 URL 的链接。默认情况下,出现在站点描述符中的任何绝对链接,例如横幅 href、面包屑、菜单链接等,都将相对于 project.url。如果设置为 false,或者项目没有定义 URL,则不会更改链接。
默认值为true
报告插件 报告插件[] 3.0-beta-1

Maven 3 内部使用的配置部分。

此处提供更多详细信息:http ://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats

注意:在 Maven 3 中使用此字段不是强制性的,因为 Maven 核心将通常的<reporting>部分注入此字段。


站点目录 文件 - 包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。
默认值为${basedir}/src/site
跳过 布尔值 3.0 将此设置为“true”以跳过站点生成。
默认值为false
模板 细绳 - 已弃用。改用 templateFile 或蒙皮
模板目录 文件 - 已弃用。使用 templateFile 或 skinning 代替
默认值是src/site
模板文件 文件 2.0-beta-5 要使用的 Velocity 模板文件的位置。使用时,皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。
证实 布尔值 2.1.1 是否验证 xml 输入文档。如果设置为 true, 所有xml 格式的输入文档(特别是 xdoc 和 fml)都将被验证,任何错误都将导致构建失败。
默认值为false
xdoc目录 文件 - 已弃用。使用标准 m2 目录布局
默认值为${basedir}/xdocs

参数详情

属性

用于呈现站点的其他模板属性。请参阅Doxia 站点渲染器
  • 类型java.util.Map
  • 要求

生成项目信息

是否生成项目报告的摘要页:project-info.html。
  • 类型布尔值
  • : 2.3
  • 要求
  • 表达式${generateProjectInfo}
  • 默认值

生成报告

允许您禁用报告生成的便利参数。
  • 类型布尔值
  • 要求
  • 表达式${generateReports}
  • 默认值

生成站点地图

生成站点地图。结果将是站点根目录中的“sitemap.html”文件。
  • 类型布尔值
  • : 2.1
  • 要求
  • 表达式${generateSitemap}
  • 默认值

生成站点目录

包含生成文档的目录。这用于获取可能在构建时生成的其他源文档。
  • 类型java.io.File
  • 要求
  • 默认${project.build.directory}/generated-site

输入编码

指定输入编码。
  • 类型java.lang.String
  • 要求
  • 表达式${编码}
  • 默认值${project.build.sourceEncoding}

语言环境

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
  • 类型java.lang.String
  • 要求
  • 表达式${locales}

模块排除

模块类型排除映射例如:fml -> **/*-m1.fml(递归排除以 '-m1.fml' 结尾的 fml 文件)配置如下所示:
  <moduleExcludes>
    <moduleType>filename1.ext,**/*sample.ext</moduleType>
    <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
    <!-- The value is a comma separated list of           -->
    <!-- filenames or fileset patterns.                   -->
    <!-- Here's an example:                               -->
    <xdoc>changes.xml,navigation.xml</xdoc>
  </moduleExcludes>
  • 类型java.util.Map
  • 要求

输出目录

将生成项目站点和报告分发的目录。
  • 类型java.io.File
  • 要求
  • 表达式${siteOutputDirectory}
  • 默认值${project.reporting.outputDirectory}

输出编码

指定输出编码。
  • 类型java.lang.String
  • 要求
  • 表达式${outputEncoding}
  • 默认值${project.reporting.outputEncoding}

相对化装饰链接

在站点描述符中创建相对于项目 URL 的链接。默认情况下,出现在站点描述符中的任何绝对链接,例如横幅 href、面包屑、菜单链接等,都将相对于 project.url。如果设置为 false,或者项目没有定义 URL,则不会更改链接。
  • 类型布尔值
  • : 2.3
  • 要求
  • 表达式${relativizeDecorationLinks}
  • 默认值

报告插件

Maven 3 内部使用的配置部分。

此处提供更多详细信息:http ://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats

注意:在 Maven 3 中使用此字段不是强制性的,因为 Maven 核心将通常的<reporting>部分注入此字段。

  • 类型org.apache.maven.reporting.exec.ReportPlugin[]
  • 3.0-beta-1
  • 要求

站点目录

包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。
  • 类型java.io.File
  • 要求
  • 默认${basedir}/src/site

跳过

将此设置为“true”以跳过站点生成。
  • 类型布尔值
  • : 3.0
  • 要求
  • 表达式${maven.site.skip}
  • 默认值

模板

已弃用。改用 templateFile 或蒙皮
默认模板页面。
  • 类型java.lang.String
  • 要求
  • 表达式${模板}

模板目录

已弃用。改用 templateFile 或蒙皮
包含模板页面的目录。
  • 类型java.io.File
  • 要求
  • 表达式${templateDirectory}
  • 默认源/站点

模板文件

要使用的 Velocity 模板文件的位置。使用时,皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。
  • 类型java.io.File
  • : 2.0-beta-5
  • 要求
  • 表达式${templateFile}

验证

是否验证 xml 输入文档。如果设置为 true, 所有xml 格式的输入文档(特别是 xdoc 和 fml)都将被验证,任何错误都将导致构建失败。
  • 类型布尔值
  • 2.1.1
  • 要求
  • 表达式${验证}
  • 默认值

xdoc目录

已弃用。使用标准 m2 目录布局
xdoc 源的替代目录,对 m1 到 m2 迁移很有用
  • 类型java.io.File
  • 要求
  • 默认值${basedir}/xdocs