mirror of
https://github.com/anthropics/skills
synced 2026-07-05 19:56:54 +00:00
Compare commits
1 Commits
klazuka/pp
...
klazuka/ad
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
23859dfa72 |
@@ -15,10 +15,10 @@
|
|||||||
"source": "./",
|
"source": "./",
|
||||||
"strict": false,
|
"strict": false,
|
||||||
"skills": [
|
"skills": [
|
||||||
"./skills/xlsx",
|
"./document-skills/xlsx",
|
||||||
"./skills/docx",
|
"./document-skills/docx",
|
||||||
"./skills/pptx",
|
"./document-skills/pptx",
|
||||||
"./skills/pdf"
|
"./document-skills/pdf"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -27,18 +27,16 @@
|
|||||||
"source": "./",
|
"source": "./",
|
||||||
"strict": false,
|
"strict": false,
|
||||||
"skills": [
|
"skills": [
|
||||||
"./skills/algorithmic-art",
|
"./skill-creator",
|
||||||
"./skills/brand-guidelines",
|
"./mcp-builder",
|
||||||
"./skills/canvas-design",
|
"./canvas-design",
|
||||||
"./skills/doc-coauthoring",
|
"./algorithmic-art",
|
||||||
"./skills/frontend-design",
|
"./internal-comms",
|
||||||
"./skills/internal-comms",
|
"./webapp-testing",
|
||||||
"./skills/mcp-builder",
|
"./artifacts-builder",
|
||||||
"./skills/skill-creator",
|
"./slack-gif-creator",
|
||||||
"./skills/slack-gif-creator",
|
"./theme-factory",
|
||||||
"./skills/theme-factory",
|
"./brand-guidelines"
|
||||||
"./skills/web-artifacts-builder",
|
|
||||||
"./skills/webapp-testing"
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,5 +1,2 @@
|
|||||||
.DS_Store
|
.DS_Store
|
||||||
__pycache__/
|
|
||||||
.idea/
|
|
||||||
.vscode/
|
|
||||||
|
|
||||||
|
|||||||
76
README.md
76
README.md
@@ -1,5 +1,3 @@
|
|||||||
> **Note:** This repository contains Anthropic's implementation of skills for Claude. For information about the Agent Skills standard, see [agentskills.io](http://agentskills.io).
|
|
||||||
|
|
||||||
# Skills
|
# Skills
|
||||||
Skills are folders of instructions, scripts, and resources that Claude loads dynamically to improve performance on specialized tasks. Skills teach Claude how to complete specific tasks in a repeatable way, whether that's creating documents with your company's brand guidelines, analyzing data using your organization's specific workflows, or automating personal tasks.
|
Skills are folders of instructions, scripts, and resources that Claude loads dynamically to improve performance on specialized tasks. Skills teach Claude how to complete specific tasks in a repeatable way, whether that's creating documents with your company's brand guidelines, analyzing data using your organization's specific workflows, or automating personal tasks.
|
||||||
|
|
||||||
@@ -11,52 +9,58 @@ For more information, check out:
|
|||||||
|
|
||||||
# About This Repository
|
# About This Repository
|
||||||
|
|
||||||
This repository contains skills that demonstrate what's possible with Claude's skills system. These skills range from creative applications (art, music, design) to technical tasks (testing web apps, MCP server generation) to enterprise workflows (communications, branding, etc.).
|
This repository contains example skills that demonstrate what's possible with Claude's skills system. These examples range from creative applications (art, music, design) to technical tasks (testing web apps, MCP server generation) to enterprise workflows (communications, branding, etc.).
|
||||||
|
|
||||||
Each skill is self-contained in its own folder with a `SKILL.md` file containing the instructions and metadata that Claude uses. Browse through these skills to get inspiration for your own skills or to understand different patterns and approaches.
|
Each skill is self-contained in its own directory with a `SKILL.md` file containing the instructions and metadata that Claude uses. Browse through these examples to get inspiration for your own skills or to understand different patterns and approaches.
|
||||||
|
|
||||||
Many skills in this repo are open source (Apache 2.0). We've also included the document creation & editing skills that power [Claude's document capabilities](https://www.anthropic.com/news/create-files) under the hood in the [`skills/docx`](./skills/docx), [`skills/pdf`](./skills/pdf), [`skills/pptx`](./skills/pptx), and [`skills/xlsx`](./skills/xlsx) subfolders. These are source-available, not open source, but we wanted to share these with developers as a reference for more complex skills that are actively used in a production AI application.
|
**Note:** These are reference examples for inspiration and learning. They showcase general-purpose capabilities rather than organization-specific workflows or sensitive content.
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
**These skills are provided for demonstration and educational purposes only.** While some of these capabilities may be available in Claude, the implementations and behaviors you receive from Claude may differ from what is shown in these skills. These skills are meant to illustrate patterns and possibilities. Always test skills thoroughly in your own environment before relying on them for critical tasks.
|
**These skills are provided for demonstration and educational purposes only.** While some of these capabilities may be available in Claude, the implementations and behaviors you receive from Claude may differ from what is shown in these examples. These examples are meant to illustrate patterns and possibilities. Always test skills thoroughly in your own environment before relying on them for critical tasks.
|
||||||
|
|
||||||
# Skill Sets
|
# Example Skills
|
||||||
- [./skills](./skills): Skill examples for Creative & Design, Development & Technical, Enterprise & Communication, and Document Skills
|
|
||||||
- [./spec](./spec): The Agent Skills specification
|
|
||||||
- [./template](./template): Skill template
|
|
||||||
|
|
||||||
# Try in Claude Code, Claude.ai, and the API
|
This repository includes a diverse collection of example skills demonstrating different capabilities:
|
||||||
|
|
||||||
|
## Creative & Design
|
||||||
|
- **algorithmic-art** - Create generative art using p5.js with seeded randomness, flow fields, and particle systems
|
||||||
|
- **canvas-design** - Design beautiful visual art in .png and .pdf formats using design philosophies
|
||||||
|
- **slack-gif-creator** - Create animated GIFs optimized for Slack's size constraints
|
||||||
|
|
||||||
|
## Development & Technical
|
||||||
|
- **artifacts-builder** - Build complex claude.ai HTML artifacts using React, Tailwind CSS, and shadcn/ui components
|
||||||
|
- **mcp-server** - Guide for creating high-quality MCP servers to integrate external APIs and services
|
||||||
|
- **webapp-testing** - Test local web applications using Playwright for UI verification and debugging
|
||||||
|
|
||||||
|
## Enterprise & Communication
|
||||||
|
- **brand-guidelines** - Apply Anthropic's official brand colors and typography to artifacts
|
||||||
|
- **internal-comms** - Write internal communications like status reports, newsletters, and FAQs
|
||||||
|
- **theme-factory** - Style artifacts with 10 pre-set professional themes or generate custom themes on-the-fly
|
||||||
|
|
||||||
|
## Meta Skills
|
||||||
|
- **skill-creator** - Guide for creating effective skills that extend Claude's capabilities
|
||||||
|
- **template-skill** - A basic template to use as a starting point for new skills
|
||||||
|
|
||||||
|
# Document Skills
|
||||||
|
|
||||||
|
The `document-skills/` subdirectory contains skills that Anthropic developed to help Claude create various document file formats. These skills demonstrate advanced patterns for working with complex file formats and binary data:
|
||||||
|
|
||||||
|
- **docx** - Create, edit, and analyze Word documents with support for tracked changes, comments, formatting preservation, and text extraction
|
||||||
|
- **pdf** - Comprehensive PDF manipulation toolkit for extracting text and tables, creating new PDFs, merging/splitting documents, and handling forms
|
||||||
|
- **pptx** - Create, edit, and analyze PowerPoint presentations with support for layouts, templates, charts, and automated slide generation
|
||||||
|
- **xlsx** - Create, edit, and analyze Excel spreadsheets with support for formulas, formatting, data analysis, and visualization
|
||||||
|
|
||||||
|
**Important Disclaimer:** These document skills are point-in-time snapshots and are not actively maintained or updated. Versions of these skills ship pre-included with Claude. They are primarily intended as reference examples to illustrate how Anthropic approaches developing more complex skills that work with binary file formats and document structures.
|
||||||
|
|
||||||
|
# Try in Claude Code
|
||||||
|
|
||||||
## Claude Code
|
|
||||||
You can register this repository as a Claude Code Plugin marketplace by running the following command in Claude Code:
|
You can register this repository as a Claude Code Plugin marketplace by running the following command in Claude Code:
|
||||||
```
|
```
|
||||||
/plugin marketplace add anthropics/skills
|
/plugin marketplace add anthropics/skills
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, to install a specific set of skills:
|
After installing the plugin, you can use the skill by just mentioning it. For instance, if you install the document-skills plugin from the marketplace, you can ask Claude Code to do something like: "use the pdf skill to extract the form fields from path/to/some-file.pdf"
|
||||||
1. Select `Browse and install plugins`
|
|
||||||
2. Select `anthropic-agent-skills`
|
|
||||||
3. Select `document-skills` or `example-skills`
|
|
||||||
4. Select `Install now`
|
|
||||||
|
|
||||||
Alternatively, directly install either Plugin via:
|
|
||||||
```
|
|
||||||
/plugin install document-skills@anthropic-agent-skills
|
|
||||||
/plugin install example-skills@anthropic-agent-skills
|
|
||||||
```
|
|
||||||
|
|
||||||
After installing the plugin, you can use the skill by just mentioning it. For instance, if you install the `document-skills` plugin from the marketplace, you can ask Claude Code to do something like: "Use the PDF skill to extract the form fields from `path/to/some-file.pdf`"
|
|
||||||
|
|
||||||
## Claude.ai
|
|
||||||
|
|
||||||
These example skills are all already available to paid plans in Claude.ai.
|
|
||||||
|
|
||||||
To use any skill from this repository or upload custom skills, follow the instructions in [Using skills in Claude](https://support.claude.com/en/articles/12512180-using-skills-in-claude#h_a4222fa77b).
|
|
||||||
|
|
||||||
## Claude API
|
|
||||||
|
|
||||||
You can use Anthropic's pre-built skills, and upload custom skills, via the Claude API. See the [Skills API Quickstart](https://docs.claude.com/en/api/skills-guide#creating-a-skill) for more.
|
|
||||||
|
|
||||||
# Creating a Basic Skill
|
# Creating a Basic Skill
|
||||||
|
|
||||||
@@ -91,4 +95,4 @@ The markdown content below contains the instructions, examples, and guidelines t
|
|||||||
|
|
||||||
Skills are a great way to teach Claude how to get better at using specific pieces of software. As we see awesome example skills from partners, we may highlight some of them here:
|
Skills are a great way to teach Claude how to get better at using specific pieces of software. As we see awesome example skills from partners, we may highlight some of them here:
|
||||||
|
|
||||||
- **Notion** - [Notion Skills for Claude](https://www.notion.so/notiondevs/Notion-Skills-for-Claude-28da4445d27180c7af1df7d8615723d0)
|
- **Notion** - [Notion Skills for Claude](https://www.notion.so/notiondevs/Notion-Skills-for-Claude-28da4445d27180c7af1df7d8615723d0)
|
||||||
55
agent_skills_spec.md
Normal file
55
agent_skills_spec.md
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
# Agent Skills Spec
|
||||||
|
|
||||||
|
A skill is a folder of instructions, scripts, and resources that agents can discover and load dynamically to perform better at specific tasks. In order for the folder to be recognized as a skill, it must contain a `SKILL.md` file.
|
||||||
|
|
||||||
|
# Skill Folder Layout
|
||||||
|
|
||||||
|
A minimal skill folder looks like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
my-skill/
|
||||||
|
- SKILL.md
|
||||||
|
```
|
||||||
|
|
||||||
|
More complex skills can add additional directories and files as needed.
|
||||||
|
|
||||||
|
|
||||||
|
# The SKILL.md file
|
||||||
|
|
||||||
|
The skill's "entrypoint" is the `SKILL.md` file. It is the only file required to exist. The file must start with a YAML frontmatter followed by regular Markdown.
|
||||||
|
|
||||||
|
## YAML Frontmatter
|
||||||
|
|
||||||
|
The YAML frontmatter has 2 required properties:
|
||||||
|
|
||||||
|
- `name`
|
||||||
|
- The name of the skill in hyphen-case
|
||||||
|
- Restricted to lowercase Unicode alphanumeric + hyphen
|
||||||
|
- Must match the name of the directory containing the SKILL.md
|
||||||
|
- `description`
|
||||||
|
- Description of what the skill does and when Claude should use it
|
||||||
|
|
||||||
|
There are 3 optional properties:
|
||||||
|
|
||||||
|
- `license`
|
||||||
|
- The license applied to the skill
|
||||||
|
- We recommend keeping it short (either the name of a license or the name of a bundled license file)
|
||||||
|
- `allowed-tools`
|
||||||
|
- A list of tools that are pre-approved to run
|
||||||
|
- Currently only supported in Claude Code
|
||||||
|
- `metadata`
|
||||||
|
- A map from string keys to string values
|
||||||
|
- Clients can use this to store additional properties not defined by the Agent Skills Spec
|
||||||
|
- We recommend making your key names reasonably unique to avoid accidental conflicts
|
||||||
|
|
||||||
|
## Markdown Body
|
||||||
|
|
||||||
|
The Markdown body has no restrictions on it.
|
||||||
|
|
||||||
|
# Additional Information
|
||||||
|
|
||||||
|
For a minimal example, see the `template-skill` example.
|
||||||
|
|
||||||
|
# Version History
|
||||||
|
|
||||||
|
- 1.0 (2025-10-16) Public Launch
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
name: web-artifacts-builder
|
name: artifacts-builder
|
||||||
description: Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
|
description: Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
|
||||||
license: Complete terms in LICENSE.txt
|
license: Complete terms in LICENSE.txt
|
||||||
---
|
---
|
||||||
|
|
||||||
# Web Artifacts Builder
|
# Artifacts Builder
|
||||||
|
|
||||||
To build powerful frontend claude.ai artifacts, follow these steps:
|
To build powerful frontend claude.ai artifacts, follow these steps:
|
||||||
1. Initialize the frontend repo using `scripts/init-artifact.sh`
|
1. Initialize the frontend repo using `scripts/init-artifact.sh`
|
||||||
197
document-skills/docx/SKILL.md
Normal file
197
document-skills/docx/SKILL.md
Normal file
@@ -0,0 +1,197 @@
|
|||||||
|
---
|
||||||
|
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
|
||||||
|
---
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
### Reading/Analyzing Content
|
||||||
|
Use "Text extraction" or "Raw XML access" sections below
|
||||||
|
|
||||||
|
### Creating New Document
|
||||||
|
Use "Creating a new Word document" workflow
|
||||||
|
|
||||||
|
### 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)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
# Convert document to markdown with tracked changes
|
||||||
|
pandoc --track-changes=all path-to-file.docx -o output.md
|
||||||
|
# Options: --track-changes=accept/reject/all
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
**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
|
||||||
|
# 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>'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
## Converting Documents to Images
|
||||||
|
|
||||||
|
To visually analyze Word documents, convert them to images using a two-step process:
|
||||||
|
|
||||||
|
1. **Convert DOCX to PDF**:
|
||||||
|
```bash
|
||||||
|
soffice --headless --convert-to pdf document.docx
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
## Code Style Guidelines
|
||||||
|
**IMPORTANT**: When generating code for DOCX operations:
|
||||||
|
- Write concise code
|
||||||
|
- Avoid verbose variable names and redundant operations
|
||||||
|
- Avoid unnecessary print statements
|
||||||
|
|
||||||
|
## 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)
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user