站点:jar

全名

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

说明

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

属性

  • 需要执行一个 Maven 项目。
  • 仅作为报告集(报告目标)执行。
  • 需要对范围内的工件进行依赖解析:test
  • 自版本:2.0-beta-6
  • 默认绑定到生命周期阶段

必需参数

姓名 类型 自从 描述
<最终名称> 细绳 2.0-beta-6 指定将用于生成的 jar 文件的文件名。请注意,“-site”将附加到文件名。
用户属性是project.build.finalName
<jar输出目录> 细绳 2.0-beta-6 指定将放置生成的 jar 文件的目录。
用户属性是project.build.directory

可选参数

姓名 类型 自从 描述
<存档> Maven存档配置 3.1 要使用的存档配置。请参阅Maven 存档器参考
<归档排除> 细绳[] 3.1 要排除的文件列表。指定为文件集模式,这些模式与将其内容打包到 JAR 中的输入目录相关。
<存档包括> 细绳[] 3.1 要包含的文件列表。指定为文件集模式,这些模式与将其内容打包到 JAR 中的输入目录相关。
<附加> 布尔值 2.0-beta-6 指定是否将生成的工件附加到项目中。
默认值为true
用户属性是site.attach
<属性> 地图 2.0-beta-6 用于呈现站点的其他模板属性。请参阅Doxia 站点渲染器
<生成项目信息> 布尔值 2.3 是否生成项目报告的摘要页:project-info.html。
默认值为true
用户属性是generateProjectInfo
<生成报告> 布尔值 2.0-beta-6 允许您禁用报告生成的便利参数。
默认值为true
用户属性是generateReports
<生成站点地图> 布尔值 2.1 生成站点地图。结果将是站点根目录中的“sitemap.html”文件。
默认值为false
用户属性是generateSitemap
<生成的站点目录> 文件 2.0-beta-6 包含源格式生成文档的目录(Doxia 支持的标记)。这用于获取可能在构建时生成的其他源文档(通过报告或任何其他构建时间的平均值)。该目录应该与siteDirectory具有相同的结构(即每个 Doxia 源支持的标记类型一个目录)。我们是否应该弃用直接使用 Doxia Sink API 的报告,而不使用 Doxia 源中间步骤?
默认值为${project.build.directory}/generated-site
别名是workingDirectory
<输入编码> 细绳 2.3 指定输入编码。
默认值为${project.build.sourceEncoding}
用户属性是编码
<语言环境> 细绳 2.3 要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。
默认值为en
用户属性是locales
<模块排除> 地图 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>

<输出目录> 文件 2.0-beta-6 将生成项目站点和报告分发的目录(如 html/css/...)。
默认值为${project.reporting.outputDirectory}
用户属性是siteOutputDirectory
<输出编码> 细绳 2.3 指定输出编码。
默认值为${project.reporting.outputEncoding}
用户属性是outputEncoding
<输出时间戳> 细绳 3.9.0 可重现输出存档条目的时间戳,格式为 ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX或表示自纪元以来秒数的 int(如SOURCE_DATE_EPOCH)。
默认值为${project.build.outputTimestamp}
<relativizeDecorationLinks> 布尔值 2.3 在站点描述符中创建相对于项目 URL 的链接。默认情况下,出现在站点描述符中的任何绝对链接,例如横幅 href、面包屑、菜单链接等,都将相对于 project.url。如果设置为 false,或者项目没有定义 URL,则不会更改链接。
默认值为true
用户属性是relativizeDecorationLinks
<保存处理内容> 布尔值 3.5 是否将 Velocity 处理的 Doxia 内容 ( *.<ext>.vm ) 保存到 ${generatedSiteDirectory}/processed
<站点目录> 文件 2.3 包含site.xml文件和手写文档源的目录(每个 Doxia 源支持的标记类型一个目录):请参阅Doxia 标记语言参考)。
默认值为${basedir}/src/site
<跳过> 布尔值 3.0 将此设置为“true”以跳过站点生成和登台。
默认值为false
用户属性是maven.site.skip
<模板文件> 文件 2.0-beta-5 要使用的 Velocity 模板文件的位置。使用时,皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。
用户属性是templateFile
<验证> 布尔值 2.1.1 是否验证 xml 输入文档。如果设置为 true, 所有xml 格式的输入文档(特别是 xdoc 和 fml)都将被验证,任何错误都将导致构建失败。
默认值为false
用户属性是验证
<xdoc目录> 文件 2.0-beta-6 已弃用。使用标准 m2 目录布局
默认值为${basedir}/xdocs

参数详情

<存档>

要使用的存档配置。请参阅Maven 存档器参考
  • 类型org.apache.maven.archiver.MavenArchiveConfiguration
  • : 3.1
  • 要求

<归档排除>

要排除的文件列表。指定为文件集模式,这些模式与将其内容打包到 JAR 中的输入目录相关。
  • 类型java.lang.String[]
  • : 3.1
  • 要求

<存档包括>

要包含的文件列表。指定为文件集模式,这些模式与将其内容打包到 JAR 中的输入目录相关。
  • 类型java.lang.String[]
  • : 3.1
  • 要求

<附加>

指定是否将生成的工件附加到项目中。
  • 类型布尔值
  • 2.0-beta-6
  • 要求
  • 用户属性site.attach
  • 默认值

<属性>

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

<最终名称>

指定将用于生成的 jar 文件的文件名。请注意,“-site”将附加到文件名。
  • 类型java.lang.String
  • 2.0-beta-6
  • 要求
  • 用户属性project.build.finalName

<生成项目信息>

是否生成项目报告的摘要页:project-info.html。
  • 类型布尔值
  • : 2.3
  • 要求
  • 用户属性generateProjectInfo
  • 默认值

<生成报告>

允许您禁用报告生成的便利参数。
  • 类型布尔值
  • 2.0-beta-6
  • 要求
  • 用户属性generateReports
  • 默认值

<生成站点地图>

生成站点地图。结果将是站点根目录中的“sitemap.html”文件。
  • 类型布尔值
  • : 2.1
  • 要求
  • 用户属性generateSitemap
  • 默认值

<生成的站点目录>

包含源格式生成文档的目录(Doxia 支持的标记)。这用于获取可能在构建时生成的其他源文档(通过报告或任何其他构建时间的平均值)。该目录应该与siteDirectory具有相同的结构(即每个 Doxia 源支持的标记类型一个目录)。我们是否应该弃用直接使用 Doxia Sink API 的报告,而不使用 Doxia 源中间步骤?
  • 类型java.io.File
  • 2.0-beta-6
  • 要求
  • 默认${project.build.directory}/generated-site
  • 别名工作目录

<输入编码>

指定输入编码。
  • 类型java.lang.String
  • : 2.3
  • 要求
  • 用户属性编码
  • 默认值${project.build.sourceEncoding}

<jar输出目录>

指定将放置生成的 jar 文件的目录。
  • 类型java.lang.String
  • 2.0-beta-6
  • 要求
  • 用户属性project.build.directory

<语言环境>

要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。
  • 类型java.lang.String
  • : 2.3
  • 要求
  • 用户属性语言环境
  • 默认值en

<模块排除>

模块类型排除映射例如: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.0-beta-6
  • 要求

<输出目录>

将生成项目站点和报告分发的目录(如 html/css/...)。
  • 类型java.io.File
  • 2.0-beta-6
  • 要求
  • 用户属性siteOutputDirectory
  • 默认值${project.reporting.outputDirectory}

<输出编码>

指定输出编码。
  • 类型java.lang.String
  • : 2.3
  • 要求
  • 用户属性输出编码
  • 默认值${project.reporting.outputEncoding}

<输出时间戳>

可重现输出存档条目的时间戳,格式为 ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX或表示自纪元以来秒数的 int(如SOURCE_DATE_EPOCH)。
  • 类型java.lang.String
  • 3.9.0
  • 要求
  • 默认值${project.build.outputTimestamp}

<relativizeDecorationLinks>

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

<保存处理内容>

是否将 Velocity 处理的 Doxia 内容 ( *.<ext>.vm ) 保存到 ${generatedSiteDirectory}/processed
  • 类型布尔值
  • : 3.5
  • 要求

<站点目录>

包含site.xml文件和手写文档源的目录(每个 Doxia 源支持的标记类型一个目录):请参阅Doxia 标记语言参考)。
  • 类型java.io.File
  • : 2.3
  • 要求
  • 默认${basedir}/src/site

<跳过>

将此设置为“true”以跳过站点生成和登台。
  • 类型布尔值
  • : 3.0
  • 要求
  • 用户属性maven.site.skip
  • 默认值

<模板文件>

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

<验证>

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

<xdoc目录>

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