--- name: docx description: "全面的文档创建、编辑和分析功能,支持修订追踪、批注、格式保留和文本提取。当 Claude 需要处理专业文档(.docx 文件)时使用:(1) 创建新文档,(2) 修改或编辑内容,(3) 处理修订追踪,(4) 添加批注,或其他任何文档任务" license: Proprietary. LICENSE.txt has complete terms --- # DOCX 创建、编辑和分析 ## 概述 用户可能会要求您创建、编辑或分析 .docx 文件的内容。.docx 文件本质上是一个包含 XML 文件和其他资源的 ZIP 压缩包,您可以读取或编辑这些内容。针对不同任务,您有不同的工具和工作流程可用。 ## 工作流程决策树 ### 读取/分析内容 使用下方的"文本提取"或"原始 XML 访问"章节 ### 创建新文档 使用"创建新 Word 文档"工作流程 ### 编辑现有文档 - **您自己的文档 + 简单修改** 使用"基础 OOXML 编辑"工作流程 - **他人的文档** 使用 **"红线批注工作流程"**(推荐默认) - **法律、学术、商业或政府文档** 使用 **"红线批注工作流程"**(必须) ## 读取和分析内容 ### 文本提取 如果您只需要读取文档的文本内容,应使用 pandoc 将文档转换为 markdown。Pandoc 能够很好地保留文档结构,并能显示修订追踪: ```bash # 将文档转换为 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 ` #### 关键文件结构 * `word/document.xml` - 主文档内容 * `word/comments.xml` - document.xml 中引用的批注 * `word/media/` - 嵌入的图片和媒体文件 * 修订追踪使用 ``(插入)和 ``(删除)标签 ## 创建新 Word 文档 从头创建新 Word 文档时,使用 **docx-js**,它允许您使用 JavaScript/TypeScript 创建 Word 文档。 ### 工作流程 1. **必须 - 完整阅读文件**:从头到尾完整阅读 [`docx-js.md`](docx-js.md)(约 500 行)。**读取此文件时切勿设置任何范围限制。** 在开始创建文档之前,完整阅读文件内容以了解详细语法、关键格式规则和最佳实践。 2. 使用 Document、Paragraph、TextRun 组件创建 JavaScript/TypeScript 文件(您可以假设所有依赖项已安装,如果没有,请参阅下方的依赖项章节) 3. 使用 Packer.toBuffer() 导出为 .docx ## 编辑现有 Word 文档 编辑现有 Word 文档时,使用 **Document 库**(用于 OOXML 操作的 Python 库)。该库自动处理基础设施设置,并提供文档操作方法。对于复杂场景,您可以通过该库直接访问底层 DOM。 ### 工作流程 1. **必须 - 完整阅读文件**:从头到尾完整阅读 [`ooxml.md`](ooxml.md)(约 600 行)。**读取此文件时切勿设置任何范围限制。** 完整阅读文件内容以了解 Document 库 API 和直接编辑文档文件的 XML 模式。 2. 解包文档:`python ooxml/scripts/unpack.py ` 3. 使用 Document 库创建并运行 Python 脚本(参见 ooxml.md 中的"Document 库"章节) 4. 打包最终文档:`python ooxml/scripts/pack.py ` Document 库提供用于常见操作的高级方法和用于复杂场景的直接 DOM 访问。 ## 文档审阅的红线批注工作流程 此工作流程允许您在使用 markdown 规划全面的修订追踪后,在 OOXML 中实现这些修改。**关键**:要实现完整的修订追踪,您必须系统地实现所有修改。 **批处理策略**:将相关修改分组为 3-10 个修改一批。这使调试更易管理,同时保持效率。在进入下一批之前测试每一批。 **原则:最小化、精确的编辑** 实现修订追踪时,只标记实际更改的文本。重复未更改的文本会使编辑更难审阅,看起来也不专业。将替换分解为:[未更改文本] + [删除] + [插入] + [未更改文本]。通过提取原始的 `` 元素并重用它,保留未更改文本的原始 RSID。 示例 - 将句子中的"30 days"改为"60 days": ```python # 错误 - 替换整个句子 'The term is 30 days.The term is 60 days.' # 正确 - 只标记更改的部分,保留原始 的未更改文本 'The term is 3060 days.' ``` ### 修订追踪工作流程 1. **获取 markdown 表示**:将文档转换为保留修订追踪的 markdown: ```bash pandoc --track-changes=all path-to-file.docx -o current.md ``` 2. **识别和分组修改**:审阅文档并识别所有需要的修改,将它们组织成逻辑批次: **定位方法**(用于在 XML 中查找修改): - 章节/标题编号(例如"Section 3.2"、"Article IV") - 段落标识符(如果有编号) - 使用唯一周围文本的 Grep 模式 - 文档结构(例如"第一段"、"签名区块") - **不要使用 markdown 行号** - 它们不对应 XML 结构 **批次组织**(每批分组 3-10 个相关修改): - 按章节:"批次 1:第 2 节修订"、"批次 2:第 5 节更新" - 按类型:"批次 1:日期更正"、"批次 2:当事人名称更改" - 按复杂度:从简单的文本替换开始,然后处理复杂的结构性更改 - 按顺序:"批次 1:第 1-3 页"、"批次 2:第 4-6 页" 3. **阅读文档并解包**: - **必须 - 完整阅读文件**:从头到尾完整阅读 [`ooxml.md`](ooxml.md)(约 600 行)。**读取此文件时切勿设置任何范围限制。** 特别注意"Document 库"和"修订追踪模式"章节。 - **解包文档**:`python ooxml/scripts/unpack.py ` - **注意建议的 RSID**:解包脚本会建议一个用于修订追踪的 RSID。复制此 RSID 用于步骤 4b。 4. **批量实现修改**:按逻辑分组修改(按章节、按类型或按相近位置),并在单个脚本中一起实现它们。这种方法: - 使调试更容易(较小的批次 = 更容易隔离错误) - 允许渐进式进展 - 保持效率(3-10 个修改的批次大小效果良好) **建议的批次分组:** - 按文档章节(例如"第 3 节修改"、"定义"、"终止条款") - 按修改类型(例如"日期修改"、"当事人名称更新"、"法律术语替换") - 按相近位置(例如"第 1-3 页的修改"、"文档前半部分的修改") 对于每批相关修改: **a. 将文本映射到 XML**:在 `word/document.xml` 中使用 Grep 验证文本如何跨 `` 元素分割。 **b. 创建并运行脚本**:使用 `get_node` 查找节点,实现修改,然后 `doc.save()`。参见 ooxml.md 中的 **"Document 库"** 章节的模式。 **注意**:在编写脚本之前,始终立即 grep `word/document.xml` 以获取当前行号并验证文本内容。每次脚本运行后行号都会改变。 5. **打包文档**:所有批次完成后,将解包的目录转换回 .docx: ```bash python ooxml/scripts/pack.py unpacked reviewed-document.docx ``` 6. **最终验证**:对完整文档进行全面检查: - 将最终文档转换为 markdown: ```bash pandoc --track-changes=all reviewed-document.docx -o verification.md ``` - 验证所有修改已正确应用: ```bash grep "original phrase" verification.md # 应该找不到 grep "replacement phrase" verification.md # 应该找到 ``` - 检查是否引入了意外的修改 ## 将文档转换为图片 要可视化分析 Word 文档,使用两步过程将其转换为图片: 1. **将 DOCX 转换为 PDF**: ```bash soffice --headless --convert-to pdf document.docx ``` 2. **将 PDF 页面转换为 JPEG 图片**: ```bash 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`:输出文件的前缀 指定范围的示例: ```bash 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 解析)