docx

DOCX 创建、编辑与分析

概述

用户可能会要求你创建、编辑或分析 .docx 文件的内容。.docx 文件本质上是一个 ZIP 压缩包，其中包含 XML 文件和其他资源，你可以读取或编辑它们。针对不同的任务，你有不同的工具和工作流可用。

工作流决策树

读取/分析内容

使用下方的“文本提取”或“原始 XML 访问”章节

创建新文档

使用“创建新的 Word 文档”工作流

编辑现有文档

• 你自己的文档 + 简单修改 使用“基础 OOXML 编辑”工作流

• 他人的文档 使用 “红线修订工作流”（推荐的默认选项）

• 法律、学术、商业或政府文档 使用 “红线修订工作流”（必需）

读取和分析内容

文本提取

如果你只需要读取文档的文本内容，应使用 pandoc 将文档转换为 Markdown。Pandoc 对保留文档结构提供了出色的支持，并且可以显示修订记录：

# Convert document to markdown with tracked changes
pandoc --track-changes=all path-to-file.docx -o output.md
# Options: --track-changes=accept/reject/all

原始 XML 访问

以下情况需要原始 XML 访问：批注、复杂格式、文档结构、嵌入媒体和元数据。对于其中任何一项功能，你都需要解压文档并读取其原始 XML 内容。

解压文件

python ooxml/scripts/unpack.py <office_file> <output_directory>

关键文件结构

• word/document.xml - 主文档内容
• word/comments.xml - 在 document.xml 中引用的批注
• word/media/ - 嵌入的图像和媒体文件
• 修订记录使用 <w:ins>（插入）和 <w:del>（删除）标签

创建新的 Word 文档

从头创建新的 Word 文档时，使用 docx-js，它允许你使用 JavaScript/TypeScript 创建 Word 文档。

工作流

1. 强制要求 - 阅读整个文件：从头到尾完整阅读 docx-js.md（约 500 行）。阅读此文件时切勿设置任何范围限制。 在继续创建文档之前，阅读完整文件内容以了解详细语法、关键格式规则和最佳实践。
2. 使用 Document、Paragraph、TextRun 组件创建 JavaScript/TypeScript 文件（你可以假定所有依赖项均已安装，如果未安装，请参阅下方的依赖项章节）
3. 使用 Packer.toBuffer() 导出为 .docx

编辑现有的 Word 文档

编辑现有的 Word 文档时，使用 Document 库（一个用于 OOXML 操作的 Python 库）。该库会自动处理基础设施设置，并提供文档操作方法。对于复杂场景，你可以通过该库直接访问底层 DOM。

工作流

1. 强制要求 - 阅读整个文件：从头到尾完整阅读 ooxml.md（约 600 行）。阅读此文件时切勿设置任何范围限制。 阅读完整文件内容以了解 Document 库 API 和直接编辑文档文件的 XML 模式。
2. 解压文档：python ooxml/scripts/unpack.py <office_file> <output_directory>
3. 使用 Document 库创建并运行 Python 脚本（参见 ooxml.md 中的“Document 库”章节）
4. 打包最终文档：python ooxml/scripts/pack.py <input_directory> <office_file>

Document 库既提供用于常见操作的高层方法，也提供用于复杂场景的直接 DOM 访问。

文档审阅的修订工作流

借助此工作流，你可以先用 markdown 规划全面的修订内容，再在 OOXML 中实施。关键：若要完成完整的修订，你必须系统地实施所有更改。

分批策略：将相关更改分成每批 3-10 处更改。这样既能便于调试，又能保持效率。在继续下一批之前，先测试每一批。

原则：最小、精确的编辑 实施修订时，只标记实际发生变化的文本。重复未更改的文本会让修订更难审阅，也显得不专业。将替换拆分为：[未更改文本] + [删除] + [插入] + [未更改文本]。对于未更改文本，通过从原文中提取 <w:r> 元素并复用它，来保留原始 run 的 RSID。

示例 - 将句子中的 “30 days” 改为 “60 days”：

# BAD - Replaces entire sentence
'<w:del><w:r><w:delText>The term is 30 days.</w:delText></w:r></w:del><w:ins><w:r><w:t>The term is 60 days.</w:t></w:r></w:ins>'

# GOOD - Only marks what changed, preserves original <w:r> for unchanged text
'<w:r w:rsidR="00AB12CD"><w:t>The term is </w:t></w:r><w:del><w:r><w:delText>30</w:delText></w:r></w:del><w:ins><w:r><w:t>60</w:t></w:r></w:ins><w:r w:rsidR="00AB12CD"><w:t> days.</w:t></w:r>'

修订跟踪工作流

1. 获取 markdown 表示：将文档转换为 markdown，并保留修订跟踪：

   pandoc --track-changes=all path-to-file.docx -o current.md
   

2. 识别并分组更改：审阅文档并识别所有需要的更改，将它们组织为逻辑批次：

   定位方法（用于在 XML 中查找更改）：

   • 章节/标题编号（例如 "Section 3.2"、"Article IV"）
   • 段落标识符（如果已编号）
   • 使用唯一周围文本的 Grep 模式
   • 文档结构（例如 "first paragraph"、"signature block"）
   • 不要使用 markdown 行号 - 它们不会映射到 XML 结构

   批次组织（每批分组 3-10 个相关更改）：

   • 按章节："Batch 1: Section 2 amendments"、"Batch 2: Section 5 updates"
   • 按类型："Batch 1: Date corrections"、"Batch 2: Party name changes"
   • 按复杂度：先从简单的文本替换开始，再处理复杂的结构性更改
   • 按顺序："Batch 1: Pages 1-3"、"Batch 2: Pages 4-6"

3. 阅读文档并解包：

   • 强制要求 - 阅读整个文件：从头到尾完整阅读 ooxml.md（约 600 行）。阅读此文件时绝不要设置任何范围限制。 特别注意 "Document Library" 和 "Tracked Change Patterns" 部分。
   • 解包文档：python ooxml/scripts/unpack.py <file.docx> <dir>
   • 记下建议的 RSID：解包脚本会为你的修订跟踪建议一个 RSID。复制此 RSID 以便在第 4b 步中使用。

4. 分批实现更改：按逻辑对更改进行分组（按章节、按类型或按邻近程度），并在单个脚本中一起实现。这种方法：

   • 使调试更容易（批次越小 = 越容易隔离错误）
   • 允许增量进展
   • 保持效率（3-10 个更改的批次大小效果良好）

   建议的批次分组：

   • 按文档章节（例如 "Section 3 changes"、"Definitions"、"Termination clause"）
   • 按更改类型（例如 "Date changes"、"Party name updates"、"Legal term replacements"）
   • 按邻近程度（例如 "Changes on pages 1-3"、"Changes in first half of document"）

   对于每一批相关更改：

   a. 将文本映射到 XML：在 word/document.xml 中 Grep 文本，以验证文本如何在 <w:r> 元素之间拆分。

   b. 创建并运行脚本：使用 get_node 查找节点，实现更改，然后 doc.save()。有关模式，请参阅 ooxml.md 中的 "Document Library" 部分。

   注意：在编写脚本之前，始终立即 grep word/document.xml，以获取当前行号并验证文本内容。每次脚本运行后行号都会变化。

5. 打包文档：所有批次完成后，将解包目录转换回 .docx：

   python ooxml/scripts/pack.py unpacked reviewed-document.docx
   

6. 最终验证：对完整文档进行全面检查：

   • 将最终文档转换为 markdown：

     pandoc --track-changes=all reviewed-document.docx -o verification.md
     

   • 验证所有更改都已正确应用：

     grep "original phrase" verification.md  # Should NOT find it
     grep "replacement phrase" verification.md  # Should find it
     

   • 检查是否引入了任何非预期的更改

将文档转换为图像

要直观地分析 Word 文档，请使用两步流程将它们转换为图像：

1. 将 DOCX 转换为 PDF：

   soffice --headless --convert-to pdf document.docx
   

2. 将 PDF 页面转换为 JPEG 图像：

   pdftoppm -jpeg -r 150 document.pdf page
   

   这会创建诸如 page-1.jpg、page-2.jpg 等文件。

选项：

• -r 150：将分辨率设置为 150 DPI（根据质量/大小平衡进行调整）
• -jpeg：输出 JPEG 格式（如果偏好 PNG，可使用 -png）
• -f N：要转换的第一页（例如 -f 2 从第 2 页开始）
• -l N：要转换的最后一页（例如 -l 5 在第 5 页停止）
• page：输出文件的前缀

特定范围的示例：

pdftoppm -jpeg -r 150 -f 2 -l 5 document.pdf page  # Converts only pages 2-5

代码风格指南

重要：为 DOCX 操作生成代码时：

• 编写简洁的代码
• 避免冗长的变量名和多余的操作
• 避免不必要的 print 语句

依赖项

所需依赖项（如不可用请安装）：

• pandoc：sudo apt-get install pandoc（用于文本提取）
• docx：npm install -g docx（用于创建新文档）
• LibreOffice：sudo apt-get install libreoffice（用于 PDF 转换）
• Poppler：sudo apt-get install poppler-utils（用于通过 pdftoppm 将 PDF 转换为图像）
• defusedxml：pip install defusedxml（用于安全的 XML 解析）