LaTeX2e中的\AtBeginDocument与\AddToHook{begindocument}差异解析

前言

在LaTeX2e文档编写过程中，开发者经常需要在文档开始执行时添加特定代码。传统上我们使用\AtBeginDocument命令，而随着LaTeX3编程层的引入，又出现了\AddToHook{begindocument}这一替代方案。本文将详细分析这两个命令的区别和使用场景。

核心差异

\AtBeginDocument和\AddToHook{begindocument}虽然功能相似，但在使用时机上存在关键区别：

1. 执行时机限制：

   • \AtBeginDocument只能在导言区(preamble)使用，即\begin{document}之前
   • \AddToHook{begindocument}则可以在文档的任何位置使用，包括正文中

2. 错误处理：

   • 在\begin{document}之后使用\AtBeginDocument会直接报错："Can be used only in preamble"
   • \AddToHook{begindocument}在文档任何位置都能正常工作

技术背景

这种差异源于两个命令的不同实现机制：

• \AtBeginDocument是LaTeX2e的传统命令，设计初衷是在文档开始前收集所有初始化代码
• \AddToHook{begindocument}属于LaTeX3的钩子系统，采用更灵活的机制，允许后期添加代码

实际应用建议

1. 兼容性考虑：

   • 如果需要支持较旧的LaTeX系统，优先使用\AtBeginDocument
   • 如果确定使用较新版本(2020年以后)，可以考虑使用钩子系统

2. 代码组织：

   • 初始化代码尽量放在导言区，使用\AtBeginDocument
   • 动态生成的代码或模块化开发时，可考虑使用\AddToHook{begindocument}

3. 调试提示：

   • 遇到"Can be used only in preamble"错误时，检查是否有\AtBeginDocument被误用在正文中
   • 考虑是否可以用\AddToHook{begindocument}替代

示例对比

% 传统方式 - 只能在导言区使用
\AtBeginDocument{
  % 初始化代码
}

% 新方式 - 可在任何位置使用
\AddToHook{begindocument}{
  % 初始化代码
}

总结

理解\AtBeginDocument和\AddToHook{begindocument}的区别对于LaTeX开发非常重要。随着LaTeX3编程层的逐步普及，钩子系统提供了更灵活的代码组织方式，但传统方法在兼容性上仍有优势。开发者应根据具体项目需求选择合适的命令。