由 Maven 构建

pdf:pdf

全名：

org.apache.maven.plugins:maven-pdf-plugin:1.5.1:pdf

说明：

为通常作为网站发布的项目文档生成 PDF 文档（使用 maven-site-plugin）。

属性：

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

必需参数

姓名 类型 自从 描述
<生成的站点目录> 文件 1.1 包含 apt、fml 和 xdoc 文档的生成源的目录。
默认值为：${project.build.directory}/generated-site。
<实施> 细绳 1.5 标识用于生成 pdf 的框架：“fo”（默认）或“itext”。
默认值为：fo。
用户属性是：实现。
<输出目录> 文件 1.5 应在其中创建 PDF 文件的输出目录。
默认值为：${project.build.directory}/pdf。
<站点目录> 文件 1.5 目录包含 apt、fml 和 xdoc 文档的源代码。
默认值为：${basedir}/src/site。
<工作目录> 文件 1.5 临时文件/资源​​等工作文件的工作目录。
默认值为：${project.build.directory}/pdf。

可选参数

姓名 类型 自从 描述
<聚合> 布尔值 1.5 如果为真，则将所有源文档聚合到一个 pdf 中，否则为每个源文档生成一个 pdf。
默认值为：true。
用户属性是：聚合。
<文档描述符> 文件 1.5 包含要生成的 PDF 的 DocumentModel 的文件。
默认值为：src/site/pdf.xml。
<生成目录> 细绳 1.1 为文档描述符中 <toc/> 元素中定义的所有项目生成一个 TOC（目录）。
可能的值为：“无”、“开始”和“结束”。
默认值为：开始。
用户属性是：generateTOC。
<包括报告> 布尔值 1.1 如果为true，则生成在 ${project.reporting} 中定义的所有 Maven 报告 ，并将它们作为新条目附加到 TOC（目录）中。注意：包括报告生成可能会导致 PDF 生成失败或增加构建时间。
默认值为：true。
用户属性是：includeReports。
<语言环境> 细绳 1.5 Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
用户属性是：locales。
<远程存储库> 列表 1.1 工件所在的远程存储库。
默认值为：${project.remoteArtifactRepositories}。
<验证> 布尔值 1.2 是否验证 xml 输入文档。如果设置为 true， 所有xml 格式的输入文档（特别是 xdoc 和 fml）都将被验证，任何错误都将导致构建失败。
默认值为：false。
用户属性是：验证。

参数详情

<聚合>

如果为真，则将所有源文档聚合到一个 pdf 中，否则为每个源文档生成一个 pdf。
  • 类型：布尔值
  • 从: 1.5
  • 要求：否
  • 用户属性：聚合
  • 默认值：真

<文档描述符>

包含要生成的 PDF 的 DocumentModel 的文件。
  • 类型：java.io.File
  • 从: 1.5
  • 要求：否
  • 默认：src/site/pdf.xml

<生成目录>

为文档描述符中 <toc/> 元素中定义的所有项目生成一个 TOC（目录）。
可能的值为：“无”、“开始”和“结束”。
  • 类型：java.lang.String
  • 从: 1.1
  • 要求：否
  • 用户属性：generateTOC
  • 默认值：开始

<生成的站点目录>

包含 apt、fml 和 xdoc 文档的生成源的目录。
  • 类型：java.io.File
  • 从: 1.1
  • 要求：是
  • 默认：${project.build.directory}/generated-site

<实施>

标识用于生成 pdf 的框架：“fo”（默认）或“itext”。
  • 类型：java.lang.String
  • 从: 1.5
  • 要求：是
  • 用户属性：实现
  • 默认值：fo

<包括报告>

如果为true，则生成在 ${project.reporting} 中定义的所有 Maven 报告 ，并将它们作为新条目附加到 TOC（目录）中。注意：包括报告生成可能会导致 PDF 生成失败或增加构建时间。
  • 类型：布尔值
  • 从: 1.1
  • 要求：否
  • 用户属性：includeReports
  • 默认值：真

<语言环境>

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
  • 类型：java.lang.String
  • 从: 1.5
  • 要求：否
  • 用户属性：语言环境

<输出目录>

应在其中创建 PDF 文件的输出目录。
  • 类型：java.io.File
  • 从: 1.5
  • 要求：是
  • 默认值：${project.build.directory}/pdf

<远程存储库>

工件所在的远程存储库。
  • 类型：java.util.List
  • 从: 1.1
  • 要求：否
  • 默认值：${project.remoteArtifactRepositories}

<站点目录>

目录包含 apt、fml 和 xdoc 文档的源代码。
  • 类型：java.io.File
  • 从: 1.5
  • 要求：是
  • 默认：${basedir}/src/site

<验证>

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

<工作目录>

临时文件/资源​​等工作文件的工作目录。
  • 类型：java.io.File
  • 从: 1.5
  • 要求：是
  • 默认值：${project.build.directory}/pdf