Maven 站点插件

站点：jar

全名：

org.apache.maven.plugins:maven-site-plugin:2.2:jar

说明：

将站点输出捆绑到 JAR 中，以便可以将其部署到存储库。

属性：

需要执行 Maven 2.0 项目。
需要范围内工件的依赖关系解析：test.
自版本：2.0-beta-6.
默认绑定到生命周期阶段：package.

必需参数

姓名	类型	自从	描述
最终名称	`String`	`2.0-beta-6`	指定将用于生成的 jar 文件的文件名。请注意，“-site”将附加到文件名。
生成的站点目录	`File`	`2.0-beta-6`	包含生成文档的目录。
jar输出目录	`String`	`2.0-beta-6`	指定将放置生成的 jar 文件的目录。
输出目录	`File`	`2.0-beta-6`	包含生成的项目站点和报告分发的目录。默认值为：`${project.reporting.outputDirectory}`。

可选参数

姓名	类型	自从	描述
附	`boolean`	`2.0-beta-6`	指定是否将生成的工件附加到项目中。默认值为：`true`。
属性	`Map`	`2.0-beta-6`	用于呈现站点的模板属性。
生成报告	`boolean`	`2.0-beta-6`	允许您禁用报告生成的便利参数。默认值为：`true`。
生成站点地图	`boolean`	`2.1`	生成站点地图。结果将是站点根目录中的“sitemap.html”文件。默认值为：`false`。
输入编码	`String`	`2.0-beta-6`	指定输入编码。默认值为：`${project.build.sourceEncoding}`。
本地存储库	`ArtifactRepository`	`2.0-beta-6`	本地存储库。默认值为：`${localRepository}`。
语言环境	`String`	`2.0-beta-6`	Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
模块排除	`Map`	`2.0-beta-6`	模块类型排除映射例如：（`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>
输出编码	`String`	`2.0-beta-6`	指定输出编码。默认值为：`${project.reporting.outputEncoding}`。
存储库	`List`	`2.0-beta-6`	用于项目的远程存储库。
站点目录	`File`	`2.0-beta-6`	包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。默认值为：`${basedir}/src/site`。
模板	`String`	`2.0-beta-6`	已弃用。改用 templateFile 或蒙皮
模板目录	`File`	`2.0-beta-6`	已弃用。改用 templateFile 或 skinning 默认值为: `src/site`。
模板文件	`File`	`2.0-beta-5`	要使用的 Velocity 模板文件的位置。使用时，皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。
证实	`boolean`	`2.1.1`	是否验证 xml 输入文档。如果设置为 true，所有xml 格式的输入文档（特别是 xdoc 和 fml）都将被验证，任何错误都将导致构建失败。默认值为：`false`。
xdoc目录	`File`	`2.0-beta-6`	已弃用。使用标准 m2 目录布局默认值为: `${basedir}/xdocs`.

参数详情

附上：

指定是否将生成的工件附加到项目中。

类型：boolean
自：2.0-beta-6
必需：No
表达式：${site.attach}
默认：true

属性：

用于呈现站点的模板属性。

类型：java.util.Map
自：2.0-beta-6
必需：No
表达式：${attributes}

最终名称：

指定将用于生成的 jar 文件的文件名。请注意，“-site”将附加到文件名。

类型：java.lang.String
自：2.0-beta-6
必需：Yes
表达式：${project.build.finalName}

生成报告：

允许您禁用报告生成的便利参数。

类型：boolean
自：2.0-beta-6
必需：No
表达式：${generateReports}
默认：true

生成站点地图：

生成站点地图。结果将是站点根目录中的“sitemap.html”文件。

类型：boolean
自：2.1
必需：No
表达式：${generateSitemap}
默认：false

生成站点目录：

包含生成文档的目录。

类型：java.io.File
自：2.0-beta-6
必需：Yes
表达式：${project.build.directory}/generated-site

输入编码：

指定输入编码。

类型：java.lang.String
自：2.0-beta-6
必需：No
表达式：${encoding}
默认：${project.build.sourceEncoding}

罐子输出目录：

指定将放置生成的 jar 文件的目录。

类型：java.lang.String
自：2.0-beta-6
必需：Yes
表达式：${project.build.directory}

本地存储库：

本地存储库。

类型：org.apache.maven.artifact.repository.ArtifactRepository
自：2.0-beta-6
必需：No
默认：${localRepository}

语言环境：

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。

类型：java.lang.String
自：2.0-beta-6
必需：No
表达式：${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>