docx · diff
git:20251201.ef74077 to git:20261116.e4bb5d9
56 added, 160 removed. Audit A to A.
What this update changes in the checks
No check changed: every fixed check gives the same answer before and after this update.
A tripped check is a label, not a verdict: read the matched text and the lines below. This week's updates that newly trip a check.
---
name: docx
- description: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. When Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
- license: Proprietary. LICENSE.txt has complete terms
+ description: "Use this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', '.docx', '.dotx', or requests to produce professional documents with formatting like tables of contents, headings, page numbers, or letterheads. Also use when extracting or reorganizing content from .docx or .dotx files, inserting or replacing images in documents, performing find-and-replace in Word files, working with tracked changes or comments, or converting content into a polished Word document. If the user asks for a 'report', 'memo', 'letter', 'template', or similar deliverable as a Word or .docx file, use this skill. Do NOT use for PDFs, spreadsheets, Google Docs, or general coding tasks unrelated to document generation."
+ license: Complete terms in LICENSE.txt
---
# DOCX creation, editing, and analysis
- ## 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.
-
- ## Workflow Decision Tree
+ A `.docx` is a ZIP archive of XML files. Choose your approach by task:
- ### Reading/Analyzing Content
- Use "Text extraction" or "Raw XML access" sections below
+ | Task | Approach |
+ |---|---|
+ | **Create** a new document | Write a `docx` (npm) script — see gotchas below |
+ | **Edit** an existing document | unpack → edit `word/document.xml` → `zip` (docx-js cannot open existing files) |
+ | **Read** content | `pandoc -t markdown file.docx` |
- ### Creating New Document
- Use "Creating a new Word document" workflow
+ > Script paths below are relative to this skill's directory.
- ### Editing Existing Document
- - **Your own document + simple changes**
- Use "Basic OOXML editing" workflow
+ ## Creating with docx-js — gotchas
- - **Someone else's document**
- Use **"Redlining workflow"** (recommended default)
+ `docx` is preinstalled — do not run `npm install` first; write the script and `require('docx')` directly. Only if that require fails: `npm install docx`. The model knows the API; these are the footguns:
- - **Legal, academic, business, or government docs**
- Use **"Redlining workflow"** (required)
+ - **Page size defaults to A4.** For US Letter set `page: { size: { width: 12240, height: 15840 } }` (DXA; 1440 = 1″).
+ - **Landscape:** pass portrait dimensions and `orientation: PageOrientation.LANDSCAPE` — docx-js swaps width/height internally.
+ - **Tables need dual widths:** set `columnWidths` on the table AND `width` on every cell, both in `WidthType.DXA` (PERCENTAGE breaks in Google Docs). Column widths must sum to the table width.
+ - **Table shading:** use `ShadingType.CLEAR`, never `SOLID` (renders black).
+ - **Lists:** never insert `•` literally; use a `numbering` config with `LevelFormat.BULLET`.
+ - **`ImageRun` requires `type:`** (`"png"`, `"jpg"`, …).
+ - **`PageBreak` must be inside a `Paragraph`.**
+ - **Never use `\n`** — use separate `Paragraph` elements.
+ - **Headings:** style every level you use (`title`, `heading1`, `heading2`…) in `styles.default`: `heading1: { run: { font: "Arial", size: 32, bold: true }, paragraph: { spacing: { before: 240, after: 120 }, keepNext: true } }`. Every level needs its own font (even with a document default), `before` and `after` (even if 0) and `keepNext`: the built-in styles set none of them.
+ - **TOC:** headings must use built-in `HeadingLevel.*`; custom heading styles need `outlineLevel` set or they won't appear.
+ - **Don't use a table as a horizontal rule** — use a paragraph bottom border instead.
+ - **Dot-leader / right-aligned-on-same-line:** use `PositionalTab` (`alignment: PositionalTabAlignment.RIGHT`, `leader: PositionalTabLeader.DOT`) inside a `TextRun`, not literal `.` or space padding.
- ## Reading and analyzing content
+ ## Verify the output
- ### 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:
+ After writing a `.docx`, render it and look at it:
```bash
- # Convert document to markdown with tracked changes
- pandoc --track-changes=all path-to-file.docx -o output.md
- # Options: --track-changes=accept/reject/all
+ zip -d output.docx '*/' >/dev/null || true # drop the ZIP's folder entries: Word has refused a file that has them when opened through a cloud co-editing service
+ python scripts/office/soffice.py --headless --convert-to pdf output.docx
+ pdftoppm -jpeg -r 100 output.pdf page
+ ls page-*.jpg # then Read the images
```
- ### Raw XML access
- 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.
-
- #### Unpacking a file
- `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
-
- ## Creating a new Word document
-
- When creating a new Word document from scratch, use **docx-js**, which allows you to create Word documents using JavaScript/TypeScript.
-
- ### Workflow
- 1. **MANDATORY - READ ENTIRE FILE**: Read [`docx-js.md`](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.
- 2. 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)
- 3. Export as .docx using Packer.toBuffer()
-
- ## Editing an existing Word document
-
- 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.
-
- ### Workflow
- 1. **MANDATORY - READ ENTIRE FILE**: Read [`ooxml.md`](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.
- 2. Unpack the document: `python ooxml/scripts/unpack.py <office_file> <output_directory>`
- 3. Create and run a Python script using the Document library (see "Document Library" section in ooxml.md)
- 4. 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.
-
- ## 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.
+ `pdftoppm` zero-pads page numbers to the width of the page count (`page-01.jpg`…`page-12.jpg`).
- **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.
+ ## Editing existing documents
- Example - Changing "30 days" to "60 days" in a sentence:
- ```python
- # 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>'
+ Legacy `.doc` files must be converted first: `python scripts/office/soffice.py --headless --convert-to docx file.doc`.
- # 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>'
+ ```bash
+ python3 -c "import sys,zipfile; zipfile.ZipFile(sys.argv[1]).extractall('unpacked')" doc.docx # not unzip, which restores symlinks — docx from external parties is untrusted
+ python scripts/merge_runs.py unpacked/ # coalesce fragmented runs so text is findable
+ # edit unpacked/word/document.xml in place — do NOT reformat or pretty-print
+ (cd unpacked && rm -f ../out.docx && zip -XrDy ../out.docx .)
+ python scripts/office/validate.py out.docx --original doc.docx # XSD checks; --auto-repair fixes common issues
+ # redlining? add --author "<the name you redlined under>" to check every edit is tracked
```
- ### Tracked changes workflow
-
- 1. **Get markdown representation**: Convert document to markdown with tracked changes preserved:
- ```bash
- pandoc --track-changes=all path-to-file.docx -o current.md
- ```
-
- 2. **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"
-
- 3. **Read documentation and unpack**:
- - **MANDATORY - READ ENTIRE FILE**: Read [`ooxml.md`](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.
-
- 4. **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.
-
- 5. **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
- ```
+ Word splits text across many `<w:r>` runs (revision ids, spell-check markers), so a phrase you can see in the document often doesn't exist as a contiguous string in the XML. `merge_runs.py` merges adjacent identically-formatted runs in `word/document.xml` without changing content or rendering; it also accepts a `.docx` directly (`python scripts/merge_runs.py doc.docx -o merged.docx`).
- 6. **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
+ **Tracked changes:** when redlining, validate with `--author "<the name you redlined under>"` (needs `--original`) — it reports any text you changed without a `<w:ins>`/`<w:del>` around it, which is easy to do by accident and invisible in the accepted view. Wrap runs in `<w:ins>`/`<w:del>` with `w:id`, `w:author`, `w:date` attributes. Inside `<w:del>`, the text element is `<w:delText>`, not `<w:t>`. A deleted paragraph mark (`<w:pPr><w:rPr><w:del w:id=".." w:author=".." w:date=".."/></w:rPr></w:pPr>`) means "merge this paragraph into the next" — so deleting a paragraph outright is that plus a `<w:del>` around every run. The `<w:del/>` must come before the rPr's other children; their order is schema-enforced.
+ To produce a clean copy with all tracked changes accepted: `python scripts/accept_changes.py in.docx out.docx`.
- ## Converting Documents to Images
+ Accepting a deleted paragraph mark should join that paragraph to the one below it, so a paragraph whose runs are *all* deleted vanishes. Word does this; `accept_changes.py` and `pandoc --track-changes=accept` don't always. Both fail the same way — they strip the deleted text but leave the emptied paragraph behind, which reads as a stray empty bullet when it was auto-numbered:
- To visually analyze Word documents, convert them to images using a two-step process:
+ - `pandoc --track-changes=accept` never joins the paragraphs.
+ - `accept_changes.py` (LibreOffice) joins them correctly, except when the deleted paragraph is followed by an empty spacer paragraph.
- 1. **Convert DOCX to PDF**:
- ```bash
- soffice --headless --convert-to pdf document.docx
- ```
+ An empty bullet in either view is an artifact of that view, not a defect in the document. Check paragraph deletions in the XML.
- 2. **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.
+ ## Comments
- 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
+ Comments require six cross-linked files. Use the helper — directory mode when you'll also be editing `document.xml` (saves an unzip/rezip cycle), `.docx`-direct mode otherwise:
- Example for specific range:
```bash
- pdftoppm -jpeg -r 150 -f 2 -l 5 document.pdf page # Converts only pages 2-5
+ # Against an already-unpacked directory (preferred when also placing markers)
+ python scripts/comment.py unpacked/ "Fees & expenses cap is too low"
+ python scripts/comment.py unpacked/ "Agreed" --parent 0
+
+ # Against a .docx directly
+ python scripts/comment.py contract.docx "This cap is too low" -o annotated.docx
```
- ## Code Style Guidelines
- **IMPORTANT**: When generating code for DOCX operations:
- - Write concise code
- - Avoid verbose variable names and redundant operations
- - Avoid unnecessary print statements
+ The script writes `comments.xml`, `commentsExtended.xml`, `commentsIds.xml`, `commentsExtensible.xml`, the relationships, and the content-type overrides. Comment IDs are auto-assigned. It then prints the `<w:commentRangeStart>`/`<w:commentRangeEnd>`/`<w:commentReference>` snippet to add to `word/document.xml` so the comment anchors to specific text — until you place those markers, the comment exists but is not visible.
## Dependencies
- Required dependencies (install if not available):
+ `docx` (npm, preinstalled — install only if `require('docx')` fails) · `pandoc` · LibreOffice (`soffice`) · `pdftoppm` (Poppler)
- - **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)