Skip to content

扫描版 PDF 的书签自动生成工具,可以根据 PDF 目录页内容,为 PDF 设置可跳转的书签。

License

Notifications You must be signed in to change notification settings

NatsUIJM/autoContents

Repository files navigation

autoContents 使用教程

更新提醒:如果你当前使用的程序是2025年3月18日之前下载的,强烈建议根据获取更新来更新程序,该版本集中处理了大量问题。

项目概述

autoContents 是一款专为扫描版 PDF 设计的书签全自动生成工具,能够基于目录页内容创建可跳转书签。如果想先看看该工具的实际表现情况,请点击这里

该工具支持单栏、双栏及混合排版的目录结构,适用于扫描质量合格(页面倾斜度 ≤2°,文字清晰度满足 OCR 识别要求)的 PDF 文档。适用的文档长度无理论上限,实测 500+ 页可稳定生成,更高的还未测试。

目录结构及适用范围说明

Step 1 下载程序

  • 如果你会用git clone命令,请将仓库克隆到本地:
git clone https://github.com/NatsUIJM/autoContents.git
  • 如果你不会git clone命令,请点击页面顶部的绿色按钮Code,然后点击Download ZIP以下载程序源码。

Step 2 配置环境

2.1 申请云服务 API-KEY

在 95% 以上的测试样本中,阿里云能够提供稳定且优质的服务,足以满足大多数需求。因此建议优先完成阿里云相关服务的申请。仅在生成结果质量严重低于预期时,再考虑使用 Azure 作为补充方案。点此查看全部教程

2.2 配置运行环境与 API-KEY

2.2.1 Windows 用户

  1. 右键点击setup_documents文件夹中的windows_install.bat,选择“以管理员身份运行”,等待脚本运行完成。
  2. 双击打开setup_documents文件夹中的windows_setup_api_keys.bat,并按要求配置。

2.2.2 macOS 用户

  1. 打开“终端”APP,输入chmod +x (注意最后面有空格;注意是+x不是-x),然后将setup_documents文件夹中的macos_install.shmacos_setup_api_keys.sh文件拖入终端窗口,按return
  2. macos_install.sh文件拖入终端窗口,按return,然后根据提示进行安装。
    • 如果未安装Xcode CLI Tools,会先安装该程序,安装完成后请重新运行该脚本,进行后续步骤。
    • 输入密码时,输入的内容并不会显示在屏幕上,输入完成后按return即可。
  3. 重新打开“终端”APP,输入sudo (注意最后面有空格),然后再将macos_install.sh文件拖入终端窗口,按return,等待脚本执行完成。
  4. 输入sudo zsh ,将macos_setup_api_keys.sh文件拖入终端窗口,按return,并按要求配置。

Step 3 使用方法

3.1 运行程序

  1. 双击根目录下的windows_start.batmacos_start.command来启动程序,浏览器界面会自动打开。
  2. 如果浏览器未打开,请在弹出的命令行窗口中找到http://127.0.0.1:5xxx,并复制到浏览器以打开。

3.2 上传 PDF 并处理

  1. 点击“选择PDF文件”,然后选择需要处理的 PDF 文件。
  2. 填写 PDF 数据:目录起始页指的是目录的第一页是 PDF 文件的第几页;目录结束页指的是目录的最后一页是 PDF 文件的第几页;正文偏移量是指 PDF 页码与实际页码的差值,比如书籍的第 10 页是 PDF 文件的第 20 页,那么该值为 20 - 10 = 10。
  3. 点击“开始执行”,等待进度条走完,浏览器会自动下载带有书签的 PDF 文件。

更多内容

编辑书签

该项目提供简易的书签编辑工具,可使用contents_editor中的脚本对 PDF 文件的书签进行编辑,使用方法如下:

  1. 将需要编辑的 PDF 文件放入contents_editor文件夹中;
  2. 运行windows_extract.batmacos_extract.command脚本,进行目录提取;
  3. 使用Microsoft ExcelNumbersVSCode或其他任何可编辑csv文件的软件编辑生成的csv文件:如果需要添加条目,那么插入一行;如果需要删除条目,那么删除对应行;如果只需要修改条目,那么修改对应行;
  4. 保存并关闭csv文件,然后再运行windows_merge.batmacos_merge.command脚本,将修改后的目录与 PDF 文件合并;
  5. 该目录下的*_edited.pdf文件即为处理后的 PDF 文件。

疑难解答

请阅读常见问题解答进行问题排查。

获取更新

  1. 点击页面顶部的绿色按钮Code,然后点击Download ZIP以下载程序源码;
  2. 将下载的autoContents-main文件夹中的全部内容覆盖到本地autoContents-main文件夹中;
  3. 重新运行2.2.1的第1步或2.2.21-3步。

Star History

Star History Chart

About

扫描版 PDF 的书签自动生成工具,可以根据 PDF 目录页内容,为 PDF 设置可跳转的书签。

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published