LaTeX 项目构建系统 l3build 的启动与配置教程

LaTeX 项目构建系统 l3build 的启动与配置教程

l3build A testing and building system for LaTeX 项目地址: https://gitcode.com/gh_mirrors/l3/l3build

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

l3build 是一个为 LaTeX 项目提供构建和测试功能的系统。项目的目录结构如下：

l3build/
├── .github/              # GitHub 相关配置文件
├── examples/             # 示例文件
├── testfiles-context/    # 用于 Context 格式的测试文件
├── testfiles-pdf/        # 用于 PDF 输出的测试文件
├── testfiles-plain/      # 用于 Plain TeX 的测试文件
├── testfiles/            # 通用的测试文件
├── .gitignore            # Git 忽略文件列表
├── CHANGELOG.md          # 更改日志
├── LICENSE              # 许可证文件
├── README.md            # 项目自述文件
├── build.lua            # 主要构建脚本
├── config-context.lua   # Context 格式配置文件
├── config-pdf.lua       # PDF 输出配置文件
├── config-plain.lua      # Plain TeX 配置文件
├── l3build-*.lua        # l3build 功能模块文件
└── l3build.dtx          # 文档和源代码文件

每个目录和文件都有其特定的作用，例如 examples/ 目录包含了使用 l3build 的示例项目，而 testfiles-*/ 目录包含了不同 LaTeX 格式的测试文件。

2. 项目的启动文件介绍

项目的启动主要是通过 build.lua 脚本进行的。这个脚本是构建系统的核心，它负责调用其他辅助脚本和功能模块来执行构建任务。当你运行以下命令时：

lua build.lua

l3build 将根据配置文件和当前目录下的文件开始构建过程。

3. 项目的配置文件介绍

l3build 使用 Lua 脚本进行配置，主要的配置文件包括：

• config-context.lua：用于设置 Context 格式的构建选项。
• config-pdf.lua：用于设置生成 PDF 的构建选项。
• config-plain.lua：用于设置 Plain TeX 格式的构建选项。

这些配置文件可以修改以适应不同项目的需求。通常，你需要根据你的 LaTeX 项目类型选择合适的配置文件，并在其中设置相关的参数。

例如，在 config-pdf.lua 中，你可以设置 PDF 文档的基本信息，如作者、标题等：

-- 设置文档信息
document.config.author = "作者名"
document.config.title = "文档标题"

通过编辑这些配置文件，可以自定义构建过程以满足特定的项目需求。

l3build A testing and building system for LaTeX 项目地址: https://gitcode.com/gh_mirrors/l3/l3build