pdf:pdf

全名：

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

说明：

为项目生成 PDF 文档。

属性：

  • 需要执行 Maven 2.0 项目。

必需参数

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

可选参数

姓名 类型 自从 描述
总计的 boolean - 如果true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.
默认值为: true。
文档描述符 File - 包含要生成的 PDF 的 DocumentModel 的文件。
默认值为：src/site/pdf.xml。
生成TOC String 1.1 为文档描述符中 <toc/> 元素中定义的所有项目生成一个 TOC（目录）。
可能的值为：“无”、“开始”和“结束”。
默认值为：start。
包括报告 boolean 1.1 如果true, generate all Maven reports defined in ${project.reporting} 并将它们作为新条目附加到 TOC（目录）中。注意：包括报告生成可能会导致 PDF 生成失败或增加构建时间。
默认值为：true。
语言环境 String - Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
远程存储库 List 1.1 工件所在的远程存储库。

参数详情

聚合：

如果true, aggregate all source documents in one pdf, otherwise generate one pdf for each source document.
  • 类型：boolean
  • 必需：No
  • 表达式：${aggregate}
  • 默认：true

文档描述符：

包含要生成的 PDF 的 DocumentModel 的文件。
  • 类型：java.io.File
  • 必需：No
  • 默认：src/site/pdf.xml

生成目录：

为文档描述符中 <toc/> 元素中定义的所有项目生成一个 TOC（目录）。
可能的值为：“无”、“开始”和“结束”。
  • 类型：java.lang.String
  • 自：1.1
  • 必需：No
  • 表达式：${generateTOC}
  • 默认：start

生成站点目录：

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

实施：

标识用于生成 pdf 的框架：“fo”（默认）或“itext”。
  • 类型：java.lang.String
  • 必需：Yes
  • 表达式：${implementation}
  • 默认：fo

包括报告：

如果true, generate all Maven reports defined in ${project.reporting} 并将它们作为新条目附加到 TOC（目录）中。注意：包括报告生成可能会导致 PDF 生成失败或增加构建时间。
  • 类型：boolean
  • 自：1.1
  • 必需：No
  • 表达式：${includeReports}
  • 默认：true

语言环境：

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

输出目录：

应在其中创建 PDF 文件的输出目录。
  • 类型：java.io.File
  • 必需：Yes
  • 默认：${project.build.directory}/pdf

远程存储库：

工件所在的远程存储库。
  • 类型：java.util.List
  • 自：1.1
  • 必需：No
  • 表达式：${project.remoteArtifactRepositories}

站点目录：

目录包含 apt、fml 和 xdoc 文档的源代码。
  • 类型：java.io.File
  • 必需：Yes
  • 默认：${basedir}/src/site

工作目录：

临时文件/资源​​等工作文件的工作目录。
  • 类型：java.io.File
  • 必需：Yes
  • 默认：${project.build.directory}/pdf