DOCX 创建、编辑和分析
概述
用户可能会要求您创建、编辑或分析 .docx 文件的内容。.docx 文件本质上是一个包含 XML 文件和其他资源的 ZIP 存档,您可以读取或编辑它。您可以根据不同的任务使用不同的工具和工作流程。
工作流决策树
阅读/分析内容
请使用下面的“文本提取”或“原始 XML 访问”部分。
创建新文档
请使用“创建新的 Word 文档”工作流。
编辑现有文档
-
自己的文档 + 简单修改 请使用“基本 OOXML 编辑”工作流。
-
他人的文档 请使用**“修订工作流”**(推荐默认选项)。
-
法律、学术、商业或政府文档 请使用**“修订工作流”**(必需)。
阅读和分析内容
文本提取
如果您只需要读取文档的文本内容,应使用 pandoc 将文档转换为 markdown。Pandoc 对保留文档结构提供了出色的支持,并且可以显示修订跟踪:
# 将文档转换为 markdown,并保留修订跟踪
pandoc --track-changes=all path-to-file.docx -o output.md
# 选项:--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 文档。
工作流
- 必须 - 读取整个文件:从头到尾完整阅读
docx-js.md(约 500 行)。阅读此文件时切勿设置任何范围限制。 在进行文档创建之前,请阅读完整的文件内容以了解详细的语法、关键格式规则和最佳实践。 - 创建一个 JavaScript/TypeScript 文件,使用 Document、Paragraph、TextRun 等组件(您可以假设所有依赖项都已安装,如果没有,请参考下面的依赖项部分)。
- 使用 Packer.toBuffer() 导出为 .docx。
编辑现有的 Word 文档
编辑现有的 Word 文档时,请使用 Document 库(一个用于 OOXML 操作的 Python 库)。该库会自动处理基础设施设置,并提供用于文档操作的方法。对于复杂场景,您可以通过该库直接访问底层 DOM。
工作流
- 必需 - 读取整个文件:从头到尾完整阅读
ooxml.md(约 600 行)。阅读此文件时切勿设置任何范围限制。 阅读完整的文件内容以了解 Document 库 API 和用于直接编辑文档文件的 XML 模式。 - 解包文档:
python ooxml/scripts/unpack.py <office_file> <output_directory> - 创建并运行一个使用 Document 库的 Python 脚本(参见 ooxml.md 中的“Document 库”部分)。
- 打包最终文档:
python ooxml/scripts/pack.py <input_directory> <office_file>
Document 库提供了用于常见操作的高级方法和用于复杂场景的直接 DOM 访问。
文档审阅的修订工作流
此工作流允许您在将更改实现到 OOXML 之前,使用 markdown 规划全面的修订跟踪。关键:对于完整的修订跟踪,您必须系统地执行所有更改。
批处理策略:将相关更改分组为批次,每批 3-10 个更改。这使得调试更容易管理,同时保持效率。在进入下一批之前测试每个批次。
原则:最小化、精确的编辑
在实现修订跟踪时,仅标记实际发生更改的文本。重复未更改的文本会使编辑难以审阅,并且显得不专业。将替换分解为:[未更改的文本] + [删除] + [插入] + [未更改的文本]。对于未更改的文本,通过从原始内容中提取 <w:r> 元素并重用它来保留原始运行的 RSID。
示例 - 将句子中的“30 days”更改为“60 days”:
# 错误 - 替换整个句子
'<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>'
# 正确 - 仅标记更改的内容,保留未更改文本的原始 <w:r>
'<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>'
修订跟踪工作流
-
获取 markdown 表示:将文档转换为 markdown,同时保留修订跟踪:
pandoc --track-changes=all path-to-file.docx -o current.md -
识别并分组更改:审阅文档并识别所有需要的更改,将它们组织成逻辑批次:
定位方法(用于在 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”
-
读取文档并解包:
- 必需 - 读取整个文件:从头到尾完整阅读
ooxml.md(约 600 行)。阅读此文件时切勿设置任何范围限制。 特别注意“Document 库”和“修订跟踪模式”部分。 - 解包文档:
python ooxml/scripts/unpack.py <file.docx> <dir> - 注意建议的 RSID:解包脚本会建议一个用于修订跟踪的 RSID。复制此 RSID 以在步骤 4b 中使用。
- 必需 - 读取整个文件:从头到尾完整阅读
-
分批实施更改:逻辑地分组更改(按章节、按类型或按邻近性)并在单个脚本中一起实施。这种方法:
- 使调试更容易(更小的批次 = 更容易隔离错误)
- 允许增量进展
- 保持效率(批次大小为 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 库” 部分。注意:在编写脚本之前,总是立即 Grep
word/document.xml以获取当前行号并验证文本内容。每次脚本运行后行号都会更改。 -
打包文档:在所有批次完成后,将解包的目录转换回 .docx:
python ooxml/scripts/pack.py unpacked reviewed-document.docx -
最终验证:对整个文档进行全面检查:
- 将最终文档转换为 markdown:
pandoc --track-changes=all reviewed-document.docx -o verification.md - 验证所有更改均已正确应用:
grep "original phrase" verification.md # 不应找到 grep "replacement phrase" verification.md # 应找到 - 检查是否引入了意外更改
- 将最终文档转换为 markdown:
将文档转换为图像
为了直观地分析 Word 文档,使用两步过程将其转换为图像:
-
将 DOCX 转换为 PDF:
soffice --headless --convert-to pdf document.docx -
将 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 # 仅转换第 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 解析)