1 自动生成目录

1.1 什么是目录？

目录是文档的重要组成部分，特别是在较长的文档中，它能够帮助读者快速找到所需的章节和内容。目录通常包括各级标题及其对应的页码，是文档的导航工具。目录的结构通常包括：

• 章节标题（如“第1章: 初识python-docx”）
• 子标题（如“1.1 什么是python-docx”）
• 页码（如“第7页”）

1.2 目录的基本类型

在Word文档中，目录主要有两种类型：

1. 静态目录：手动创建，不会自动更新，适用于结构简单、修改不频繁的文档。
2. 动态目录：自动生成并可以根据文档内容的变化进行更新，适用于复杂或结构多变的文档。

我们将使用python-docx库生成动态目录，这样当文档内容发生变化时，目录也能自动更新。

1.3 使用python-docx生成目录

要在Word文档中生成目录，python-docx库提供了灵活的方法。以下是如何使用python-docx生成目录的步骤和代码示例。

步骤1: 安装python-docx库
首先，确保你已经安装了python-docx库。如果还没有安装，可以通过以下命令进行安装：

pip install python-docx

步骤2: 创建文档并添加标题
我们需要在文档中添加一些标题，这些标题将用于生成目录。以下是创建文档并添加标题的示例代码：

from docx import Document
from docx.oxml.ns import qn
from docx.oxml import OxmlElement

# 创建一个新的文档
doc = Document()

# 添加一级标题
doc.add_heading('第1章: 初识python-docx', level=1)
doc.add_paragraph('在这一章中，我们将学习如何使用python-docx库创建Word文档。')

# 添加二级标题
doc.add_heading('1.1 什么是python-docx', level=2)
doc.add_paragraph('python-docx是一个用于操作Word文档的Python库。')

# 添加另一个一级标题
doc.add_heading('第2章: 文档的基础操作', level=1)
doc.add_paragraph('这一章将介绍如何打开、保存、创建和删除文档。')

# 保存文档
doc.save('example.docx')

步骤3: 插入目录
在创建了标题后，我们可以使用python-docx插入目录。以下代码展示了如何在文档中插入一个动态目录：

# 创建目录对象
toc = doc.add_paragraph()

# 使用FieldCode创建目录
fldChar = OxmlElement('w:fldChar')  # 创建一个字段字符元素
fldChar.set(qn('w:fldCharType'), 'begin')  # 设置字段类型为“开始”

instrText = OxmlElement('w:instrText')  # 创建指令文本元素
instrText.set(qn('xml:space'), 'preserve')  # 设置空间保存属性
instrText.text = 'TOC \\o "1-3" \\h \\z \\u'  # 目录字段代码

fldCharEnd = OxmlElement('w:fldChar')  # 创建字段字符结束元素
fldCharEnd.set(qn('w:fldCharType'), 'end')  # 设置字段类型为“结束”

# 将这些元素添加到目录段落
toc._element.append(fldChar)
toc._element.append(instrText)
toc._element.append(fldCharEnd)

# 保存带目录的文档
doc.save('example_with_toc.docx')

代码解释:

• fldChar和instrText元素用于创建Word中的“字段代码”，它控制着Word如何生成目录。
• TOC \\o "1-3" \\h \\z \\u 是Word的目录字段代码，表示目录应包含从一级到三级标题，并且包含超链接、页码对齐、以及隐藏的页码。

1.4 目录的高级选项

在生成目录后，你可以进一步自定义它的显示样式。例如，你可以选择只包括某些特定级别的标题，或者修改目录的显示格式。以下是一些高级选项：

• 仅包含特定级别的标题：你可以通过修改字段代码来选择显示哪些级别的标题，如仅显示一级和二级标题：

  instrText.text = 'TOC \\o "1-2" \\h \\z \\u'
  

• 自定义目录的样式：你可以设置目录的字体、颜色、行间距等属性，以符合文档的整体风格。

• 自动更新目录：当文档内容发生变化时，你可以通过重新生成目录来自动更新页码和标题信息。