PDF表单填充工具技术文档

1. 安装指南

环境要求

• 安装 PDFTK 二进制文件。可以从 PDFTK 官网 下载安装包，或者在 Debian 或类似系统上运行 apt-get install pdftk。

安装方式

• 将 pdf-forms 添加到您的 Gemfile 中，或者手动安装该宝石。

对于使用 Java 版本的 PDFTK 用户，您可以按照以下步骤操作：

1. 创建一个小的 shell 脚本：

   #!/bin/sh
   MYSELF=`which "$0" 2>/dev/null`
   [ $? -gt 0 -a -f "$0" ] && MYSELF="./$0"
   java=java
   if test -n "$JAVA_HOME"; then
       java="$JAVA_HOME/bin/java"
   fi
   exec "$java" $java_args -jar $MYSELF "$@"
   exit 1
   

2. 将包装脚本和 Jar 文件连接起来，创建一个可执行的文件：

   cat stub.sh pdftk-all.jar > pdftk.run && chmod +x pdftk.run
   

2. 项目使用说明

FDF/XFdf 创建

使用以下 Ruby 代码创建 FDF 或 XFDF 数据：

require 'pdf_forms'
fdf = PdfForms::Fdf.new :key => 'value', :other_key => 'other value'
puts fdf.to_pdf_data
fdf.save_to 'path/to/file.fdf'

要生成 XFDF 而不是 FDF，请实例化 PdfForms::XFdf 而不是 PdfForms::Fdf。

查询表单字段和填充 PDF 表单

使用以下 Ruby 代码查询和填充 PDF 表单：

require 'pdf_forms'

pdftk = PdfForms.new('/usr/local/bin/pdftk')

pdftk.get_field_names 'path/to/form.pdf'
pdftk.fill_form '/path/to/form.pdf', 'myform.pdf', :foo => 'bar'

您还可以使用 :flatten、:encrypt、:encrypt_pw 和 :replacement_font 等选项来自定义表单的填充方式。

字段名中的 HTML 实体

如果表单字段名包含 HTML 实体（例如 Straße Hausnummer），请确保在使用前进行转义，例如使用 CGI.unescapeHTML(name)。

非ASCII字符（UTF8 等）在填充的 PDF 中显示不出来

首先，尝试使用 replacement_font 选项并指定未显示的字体。如果这不起作用，请检查输出 PDF 中的字段值是否已正确存储，使用 pdftk output.pdf dump_data_fields_utf8 进行检查。

如果值已存储但未显示，您的输入 PDF 缺少适当字体以显示此类字符。重新创建 PDF 并嵌入必要的字体。如果值未存储，则在填充表单时存在问题，要么是您的操作问题，要么是这个宝石的问题。

3. 项目 API 使用文档

pdf-forms Gem 提供了以下类和方法：

• PdfForms::Fdf: 用于创建 FDF 数据的类。

  • new: 初始化 FDF 对象。
  • to_pdf_data: 获取 FDF 数据。
  • save_to: 将 FDF 数据保存到文件。

• PdfForms: 用于处理 PDF 表单的类。

  • new: 初始化 PdfForms 对象，指定 PDFTK 路径。
  • get_field_names: 获取 PDF 表单中的字段名。
  • fill_form: 填充 PDF 表单。

4. 项目安装方式

请参考“安装指南”部分中的步骤进行项目安装。您可以通过 Gemfile 添加 pdf-forms，或者手动安装该宝石。如果您使用 Java 版本的 PDFTK，请按照提供的步骤创建一个可执行的脚本文件。