站点:有效站点

全名:

org.apache.maven.plugins:maven-site-plugin:3.0:effective-site

说明:

在site.xml的继承和插值之后,将有效的站点描述符显示为此构建的 XML 。

属性:

  • 需要执行一个 Maven 项目。
  • 自版本:2.2。

可选参数

姓名 类型 自从 描述
属性 地图 2.2 用于呈现站点的模板属性。
生成项目信息 布尔值 2.3 是否生成项目报告的摘要页:project-info.html。
默认值为:true。
生成的站点目录 文件 2.2 包含生成文档的目录。这用于获取可能在构建时生成的其他源文档。
默认值为:${project.build.directory}/generated-site。
输入编码 细绳 2.2 指定输入编码。
默认值为:${project.build.sourceEncoding}。
语言环境 细绳 2.2 Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
模块排除 地图 2.2 模块类型排除映射例如: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>

输出 文件 2.2 可选参数,用于将此帮助的输出写入给定文件,而不是写入控制台。
注意:可能是相对路径。
输出编码 细绳 2.2 指定输出编码。
默认值为:${project.reporting.outputEncoding}。
相对化装饰链接 布尔值 2.3 在站点描述符中创建相对于项目 URL 的链接。默认情况下,出现在站点描述符中的任何绝对链接,例如横幅 href、面包屑、菜单链接等,都将相对于 project.url。如果设置为 false,或者项目没有定义 URL,则不会更改链接。
默认值为:true。
报告插件 报告插件[] 3.0-beta-1 报告插件(Maven 3)。
站点目录 文件 2.2 包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。
默认值为:${basedir}/src/site。
模板 细绳 2.2 已弃用。改用 templateFile 或蒙皮
模板目录 文件 2.2 已弃用。使用 templateFile 或 skinning 代替
默认值是:src/site。
模板文件 文件 2.0-beta-5 要使用的 Velocity 模板文件的位置。使用时,皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。
xdoc目录 文件 2.2 已弃用。使用标准 m2 目录布局
默认值为:${basedir}/xdocs。

参数详情

属性:

用于呈现站点的模板属性。
  • 类型:java.util.Map
  • 从: 2.2
  • 要求:否

生成项目信息:

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

生成站点目录:

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

输入编码:

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

语言环境:

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
  • 类型:java.lang.String
  • 从: 2.2
  • 要求:否
  • 表达式:${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
  • 从: 2.2
  • 要求:否

输出:

可选参数,用于将此帮助的输出写入给定文件,而不是写入控制台。
注意:可能是相对路径。
  • 类型:java.io.File
  • 从: 2.2
  • 要求:否
  • 表达式:${输出}

输出编码:

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

相对化装饰链接:

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

报告插件:

报告插件(Maven 3)。
  • 类型:org.apache.maven.reporting.exec.ReportPlugin[]
  • 自:3.0-beta-1
  • 要求:否

站点目录:

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

模板:

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

模板目录:

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

模板文件:

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

xdoc目录:

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