docx

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

DOCX creation, editing, and analysis

DOCX文档创建、编辑与分析

Overview

概述

A user may ask you to create, edit, or analyze the contents of a .docx file. A .docx file is essentially a ZIP archive containing XML files and other resources that you can read or edit. You have different tools and workflows available for different tasks.

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

Workflow Decision Tree

工作流决策树

Reading/Analyzing Content

读取/分析内容

Use "Text extraction" or "Raw XML access" sections below

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

Creating New Document

创建新文档

Use "Creating a new Word document" workflow

使用「创建新Word文档」工作流

Editing Existing Document

编辑现有文档

Your own document + simple changes Use "Basic OOXML editing" workflow
Someone else's document Use "Redlining workflow" (recommended default)
Legal, academic, business, or government docs Use "Redlining workflow" (required)

自有文档 + 简单修改 使用「基础OOXML编辑」工作流
他人文档 使用**「修订工作流」**（推荐默认选项）
法律、学术、商业或政府文档 必须使用**「修订工作流」**

Reading and analyzing content

读取与分析内容

Text extraction

文本提取

If you just need to read the text contents of a document, you should convert the document to markdown using pandoc. Pandoc provides excellent support for preserving document structure and can show tracked changes:

bash

undefined

如果你只需读取文档的文本内容，应该使用pandoc将文档转换为markdown格式。Pandoc在保留文档结构方面表现出色，并且可以显示修订跟踪内容：

bash

undefined

Convert document to markdown with tracked changes

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

Options: --track-changes=accept/reject/all

undefined

undefined

Raw XML access

原始XML访问

You need raw XML access for: comments, complex formatting, document structure, embedded media, and metadata. For any of these features, you'll need to unpack a document and read its raw XML contents.

当你需要处理评论、复杂格式、文档结构、嵌入媒体和元数据时，需要访问原始XML。对于这些功能，你需要解压文档并读取其原始XML内容。

Unpacking a file

解压文件

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

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

Key file structures

关键文件结构

```
word/document.xml
```
- Main document contents
```
word/comments.xml
```
- Comments referenced in document.xml
```
word/media/
```
- Embedded images and media files
Tracked changes use
```
<w:ins>
```
(insertions) and
```
<w:del>
```
(deletions) tags

```
word/document.xml
```
- 文档主要内容
```
word/comments.xml
```
- 文档中引用的评论
```
word/media/
```
- 嵌入的图片和媒体文件
修订跟踪使用
```
<w:ins>
```
（插入）和
```
<w:del>
```
（删除）标签

Creating a new Word document

创建新Word文档

When creating a new Word document from scratch, use docx-js, which allows you to create Word documents using JavaScript/TypeScript.

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

Workflow

工作流

MANDATORY - READ ENTIRE FILE: Read
```
docx-js.md
```
(~500 lines) completely from start to finish. NEVER set any range limits when reading this file. Read the full file content for detailed syntax, critical formatting rules, and best practices before proceeding with document creation.
Create a JavaScript/TypeScript file using Document, Paragraph, TextRun components (You can assume all dependencies are installed, but if not, refer to the dependencies section below)
Export as .docx using Packer.toBuffer()

必须操作 - 完整阅读文件：完整阅读
```
docx-js.md
```
（约500行）内容。阅读此文件时绝不能设置任何范围限制。在开始创建文档前，需通读全文以了解详细语法、关键格式规则和最佳实践。
使用Document、Paragraph、TextRun组件创建JavaScript/TypeScript文件（你可以假设所有依赖已安装，若未安装请参考下方依赖章节）
使用Packer.toBuffer()导出为.docx文件

Editing an existing Word document

编辑现有Word文档

When editing an existing Word document, use the Document library (a Python library for OOXML manipulation). The library automatically handles infrastructure setup and provides methods for document manipulation. For complex scenarios, you can access the underlying DOM directly through the library.

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

Workflow

工作流

MANDATORY - READ ENTIRE FILE: Read
```
ooxml.md
```
(~600 lines) completely from start to finish. NEVER set any range limits when reading this file. Read the full file content for the Document library API and XML patterns for directly editing document files.

Unpack the document:

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

Create and run a Python script using the Document library (see "Document Library" section in ooxml.md)

Pack the final document:

python ooxml/scripts/pack.py <input_directory> <office_file>

The Document library provides both high-level methods for common operations and direct DOM access for complex scenarios.

必须操作 - 完整阅读文件：完整阅读
```
ooxml.md
```
（约600行）内容。阅读此文件时绝不能设置任何范围限制。通读全文以了解Document库API和直接编辑文档文件的XML模式。

解压文档：

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

使用Document库创建并运行Python脚本（参考ooxml.md中的「Document Library」章节）

打包最终文档：

python ooxml/scripts/pack.py <input_directory> <office_file>

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

Redlining workflow for document review

文档审阅的修订工作流

This workflow allows you to plan comprehensive tracked changes using markdown before implementing them in OOXML. CRITICAL: For complete tracked changes, you must implement ALL changes systematically.

Batching Strategy: Group related changes into batches of 3-10 changes. This makes debugging manageable while maintaining efficiency. Test each batch before moving to the next.

Principle: Minimal, Precise Edits When implementing tracked changes, only mark text that actually changes. Repeating unchanged text makes edits harder to review and appears unprofessional. Break replacements into: [unchanged text] + [deletion] + [insertion] + [unchanged text]. Preserve the original run's RSID for unchanged text by extracting the

<w:r>

element from the original and reusing it.

Example - Changing "30 days" to "60 days" in a sentence:

python

undefined

此工作流允许你在OOXML中实现修订前，先使用markdown规划所有修订内容。重要提示：要实现完整的修订跟踪，你必须系统地完成所有更改。

批量处理策略：将相关更改分组为3-10个一组的批次。这样可以简化调试，同时保持效率。在进行下一批次前，请测试当前批次的更改。

原则：最小化、精准编辑 实现修订跟踪时，仅标记实际更改的文本。重复未更改的文本会使编辑内容更难审阅，且显得不专业。将替换内容拆分为：[未更改文本] + [删除内容] + [插入内容] + [未更改文本]。通过从原始内容中提取

<w:r>

元素并复用，保留未更改文本的原始RSID。

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

python

undefined

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>'

undefined

'<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>'

undefined

Tracked changes workflow

修订跟踪工作流

Get markdown representation: Convert document to markdown with tracked changes preserved:
bash
```
pandoc --track-changes=all path-to-file.docx -o current.md
```
Identify and group changes: Review the document and identify ALL changes needed, organizing them into logical batches:

Location methods (for finding changes in XML):
- Section/heading numbers (e.g., "Section 3.2", "Article IV")
- Paragraph identifiers if numbered
- Grep patterns with unique surrounding text
- Document structure (e.g., "first paragraph", "signature block")
- DO NOT use markdown line numbers - they don't map to XML structure
Batch organization (group 3-10 related changes per batch):
- By section: "Batch 1: Section 2 amendments", "Batch 2: Section 5 updates"
- By type: "Batch 1: Date corrections", "Batch 2: Party name changes"
- By complexity: Start with simple text replacements, then tackle complex structural changes
- Sequential: "Batch 1: Pages 1-3", "Batch 2: Pages 4-6"
Read documentation and unpack:
- MANDATORY - READ ENTIRE FILE: Read
```
ooxml.md
```
  (~600 lines) completely from start to finish. NEVER set any range limits when reading this file. Pay special attention to the "Document Library" and "Tracked Change Patterns" sections.
- Unpack the document:
```
python ooxml/scripts/unpack.py <file.docx> <dir>
```
- Note the suggested RSID: The unpack script will suggest an RSID to use for your tracked changes. Copy this RSID for use in step 4b.
Implement changes in batches: Group changes logically (by section, by type, or by proximity) and implement them together in a single script. This approach:
- Makes debugging easier (smaller batch = easier to isolate errors)
- Allows incremental progress
- Maintains efficiency (batch size of 3-10 changes works well)
Suggested batch groupings:
- By document section (e.g., "Section 3 changes", "Definitions", "Termination clause")
- By change type (e.g., "Date changes", "Party name updates", "Legal term replacements")
- By proximity (e.g., "Changes on pages 1-3", "Changes in first half of document")
For each batch of related changes:
a. Map text to XML: Grep for text in
```
word/document.xml
```
to verify how text is split across
```
<w:r>
```
elements.
b. Create and run script: Use
```
get_node
```
to find nodes, implement changes, then
```
doc.save()
```
. See "Document Library" section in ooxml.md for patterns.
Note: Always grep
```
word/document.xml
```
immediately before writing a script to get current line numbers and verify text content. Line numbers change after each script run.
Pack the document: After all batches are complete, convert the unpacked directory back to .docx:
bash
```
python ooxml/scripts/pack.py unpacked reviewed-document.docx
```
Final verification: Do a comprehensive check of the complete document:
- Convert final document to markdown:
  bash
```
pandoc --track-changes=all reviewed-document.docx -o verification.md
```
- Verify ALL changes were applied correctly:
  bash
```
grep "original phrase" verification.md  # Should NOT find it
grep "replacement phrase" verification.md  # Should find it
```
- Check that no unintended changes were introduced

获取markdown格式内容：将文档转换为保留修订跟踪的markdown格式：
bash
```
pandoc --track-changes=all path-to-file.docx -o current.md
```
识别并分组更改：审阅文档并确定所有需要的更改，将它们组织为逻辑批次：

定位方法（用于在XML中查找更改位置）：
- 章节/标题编号（例如：“Section 3.2”、“Article IV”）
- 段落编号（如果有编号的话）
- 包含唯一上下文文本的Grep模式
- 文档结构（例如：“第一段”、“签名栏”）
- 请勿使用markdown行号 - 它们与XML结构不对应
批次组织（每批分组3-10个相关更改）：
- 按章节：“批次1：第2章修订”、“批次2：第5章更新”
- 按类型：“批次1：日期修正”、“批次2：参与方名称更改”
- 按复杂度：先处理简单文本替换，再处理复杂结构更改
- 按顺序：“批次1：第1-3页”、“批次2：第4-6页”
阅读文档并解压：
- 必须操作 - 完整阅读文件：完整阅读
```
ooxml.md
```
  （约600行）内容。阅读此文件时绝不能设置任何范围限制。请特别注意「Document Library」和「Tracked Change Patterns」章节。
- 解压文档：
```
python ooxml/scripts/unpack.py <file.docx> <dir>
```
- 记录建议的RSID：解压脚本会建议一个用于修订跟踪的RSID。请复制此RSID以便在步骤4b中使用。
批量实现更改：将更改按逻辑分组（按章节、类型或位置），并在单个脚本中一起实现。此方法：
- 简化调试（批次越小，越容易定位错误）
- 允许逐步推进工作
- 保持效率（3-10个更改的批次大小效果最佳）
建议的批次分组方式：
- 按文档章节（例如：“第3章更改”、“定义部分”、“终止条款”）
- 按更改类型（例如：“日期更改”、“参与方名称更新”、“法律术语替换”）
- 按位置（例如：“第1-3页的更改”、“文档前半部分的更改”）
对于每一组相关更改：
a. 映射文本到XML：在
```
word/document.xml
```
中使用Grep查找文本，以验证文本如何拆分到
```
<w:r>
```
元素中。
b. 创建并运行脚本：使用
```
get_node
```
查找节点，实现更改，然后执行
```
doc.save()
```
。请参考ooxml.md中的**「Document Library」**章节获取示例模式。
注意：在编写脚本前，请立即使用Grep查找
```
word/document.xml
```
以获取当前行号并验证文本内容。每次运行脚本后，行号都会发生变化。
打包文档：所有批次完成后，将解压后的目录转换回.docx格式：
bash
```
python ooxml/scripts/pack.py unpacked reviewed-document.docx
```

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

将最终文档转换为markdown：

bash

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

验证所有更改是否正确应用：

bash

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

检查是否引入了意外更改

Converting Documents to Images

文档转图片

To visually analyze Word documents, convert them to images using a two-step process:

Convert DOCX to PDF:

bash

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

Convert PDF pages to JPEG images:
bash
```
pdftoppm -jpeg -r 150 document.pdf page
```
This creates files like
```
page-1.jpg
```
,
```
page-2.jpg
```
, etc.

Options:

```
-r 150
```
: Sets resolution to 150 DPI (adjust for quality/size balance)
```
-jpeg
```
: Output JPEG format (use
```
-png
```
for PNG if preferred)
```
-f N
```
: First page to convert (e.g.,
```
-f 2
```
starts from page 2)
```
-l N
```
: Last page to convert (e.g.,
```
-l 5
```
stops at page 5)
```
page
```
: Prefix for output files

Example for specific range:

bash

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

要可视化分析Word文档，请通过两步流程将其转换为图片：

将DOCX转换为PDF：

bash

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

将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  # Converts only pages 2-5

Code Style Guidelines

代码风格指南

IMPORTANT: When generating code for DOCX operations:

Write concise code
Avoid verbose variable names and redundant operations
Avoid unnecessary print statements

重要提示：生成DOCX操作相关代码时：

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

Dependencies

依赖项

Required dependencies (install if not available):

pandoc:
```
sudo apt-get install pandoc
```
(for text extraction)
docx:
```
npm install -g docx
```
(for creating new documents)
LibreOffice:
```
sudo apt-get install libreoffice
```
(for PDF conversion)
Poppler:
```
sudo apt-get install poppler-utils
```
(for pdftoppm to convert PDF to images)
defusedxml:
```
pip install defusedxml
```
(for secure XML parsing)

所需依赖项（若未安装请执行安装）：

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解析）