docx

Files (1)

• SKILL.md

SKILL.md (first lines)

# DOCX creation, editing, and analysis

## Tool-First Workflow

Use the `Document` tool for ALL operations. Do NOT use Python scripts unless you need features the tool doesn't have.

### Available Document tool actions

| Task | Tool call |
|------|-----------|
| Inspect metadata | `Document { action: "inspect", file_path: "doc.docx" }` |
| Read text content | `Document { action: "read_text", file_path: "doc.docx" }` |
| Extract headings | `Document { action: "extract_headings", file_path: "doc.docx" }` |
| Extract HTML | `Document { action: "extract_html", file_path: "doc.docx" }` |
| Export as plain text | `Document { action: "export_text", file_path: "doc.docx", output_path: "out.txt" }` |
| **Create new document** | `Document { action: "create", output_path: "doc.docx", content: {...} }` |
| **Unpack for XML editing** | `Document { action: "unpack", file_path: "doc.docx", output_path: "unpacked/" }` |
| **Repack after editing** | `Document { action: "pack", file_path: "unpacked/", output_path: "output.docx" }` |

### Creating a new document

```
Document { action: "create", output_path: "report.docx", content: {
  "title": "Quarterly Report",
  "sections": [
    {
      "heading": "Executive Summary",
      "paragraphs": ["Revenue grew 15% YoY.", {"text": "Key highlight", "bold": true}]
    },
    {
      "heading": "Financial Data",
      "table": [["Metric", "Q1", "Q2"], ["Revenue", "100k", "115k"], ["Costs", "80k", "85k"]]
    }
  ]
}}
```

### Editing an existing document

```
Document { action: "unpack", file_path: "template.docx", output_path: "/tmp/unpacked/" }
# → Edit XML files in /tmp/unpacked/word/document.xml with the Edit tool
Document { action: "pack", file_path: "/tmp/unpacked/", output_path: "output.docx" }
```

### When to fall back to Python/Bash
- Converting legacy .doc → .docx (requires LibreOffice)
- Accepting tracked changes (requires LibreOffice macro)
- XML validation against OOXML schemas
- Adding comments with commentsExtended/commentsIds (complex XML)

## Overview

A .docx file is a ZIP archive containing XML files.

## Quick Reference (LEGACY — prefer Document tool above)

| Task | Approach |
|------|----------|
| Read/analyze content | `Document { action: "read_text" }` |
| Create new document | `Document { action: "create" }` |
| Edit existing document | `Document { action: "unpack" }` → Edit XML → `Document { action: "pack" }` |

### Converting .doc to .docx

Legacy `.doc` files must be converted before editing (requires LibreOffice):

```bash
python scripts/office/soffice.py --headless --convert-to docx document.doc
```

### Reading Content

```bash
# Text extraction with tracked changes
pandoc --track-changes=all document.docx -o output.md

# Raw XML access
python scripts/office/unpack.py document.docx unpacked/
```

### Converting to Images

```bash
python scripts/office/soffice.py --headless --convert-to pdf document.docx
pdftoppm -jpeg -r 150 document.pdf page
```

### Accepting Tracked Changes

To produce a clean document with all tracked changes accepted (requires LibreOffice):

```bash
python scripts/accept_changes.py input.docx output.docx
```

---

## Creating New Documents

Generate .docx files with JavaScript, then validate. Install: `npm install -g docx`

### Setup
```javascript
const { Document, Packer, Paragraph, TextRun, Table, TableRow, TableCell, ImageRun,
        Header, Footer, AlignmentType, PageOrientation, LevelFormat, ExternalHyperlink,
        InternalHyperlink, Bookmark, FootnoteReferenceRun, PositionalTab,
        PositionalTabAlignment, PositionalTabRelativeTo, PositionalTabLeader,
        TabStopType, TabStopPosition, Column, SectionType,
        TableOfContents, HeadingLevel, BorderStyle, WidthType, ShadingType,
        VerticalAlign, PageNumber, PageBreak } = require('docx');

const doc = new Document({ sections: [{ children: [/* content */] }] });
Packer.toBuffer(doc).then(buffer => fs.writeFileSync("doc.docx", buffer));
```

### Validation
After creating the file, validate it. If validation fails, unpack, fix the XML, and repack.
```bash

From SeifBenayed/cloclo, MIT.

More from SeifBenayed/cloclo