pdf.tocgen 项目使用文档

1. 项目的目录结构及介绍

pdf.tocgen 是一个用于自动生成 PDF 文件目录（Table of Contents, ToC）的命令行工具集。项目的目录结构如下：

pdf.tocgen/
├── LICENSE
├── README.md
├── bin/
│   ├── pdfxmeta
│   ├── pdftocgen
│   └── pdftocio
├── recipes/
│   └── example.toml
├── requirements.txt
└── setup.py

• LICENSE：项目的许可证文件，采用 GNU GPLv3 许可证。
• README.md：项目的基本介绍和使用说明。
• bin/：包含项目的可执行文件，如 pdfxmeta、pdftocgen 和 pdftocio。
• recipes/：包含示例配置文件，如 example.toml。
• requirements.txt：项目依赖的 Python 包列表。
• setup.py：项目的安装脚本。

2. 项目的启动文件介绍

pdf.tocgen 项目包含三个主要的可执行文件，位于 bin/ 目录下：

• pdfxmeta：用于提取 PDF 文件的元数据（字体属性和位置）。
• pdftocgen：根据提取的元数据生成目录。
• pdftocio：将生成的目录导入到 PDF 文件中。

这些工具可以单独使用，也可以组合使用来完成整个目录生成流程。

3. 项目的配置文件介绍

pdf.tocgen 使用配置文件来定义目录的生成规则。配置文件通常采用 TOML 格式，并存储在 recipes/ 目录下。以下是一个示例配置文件 example.toml 的内容：

[[heading]]
level = 1
greedy = true
font_name = "Times-Bold"
font_size = 19.92530059814453

[[heading]]
level = 2
greedy = true
font_name = "Times-Bold"
font_size = 11.9552001953125

• [[heading]]：定义一个标题规则。
• level：标题的层级。
• greedy：是否贪婪匹配。
• font_name：字体名称。
• font_size：字体大小。

通过调整配置文件中的规则，可以自定义目录的生成方式。