PPTX creation, editing, and analysis
Overview
Create, edit, or analyze the contents of .pptx files when requested. A .pptx file is essentially a ZIP archive containing XML files and other resources. Different tools and workflows are available for different tasks.
CRITICAL: Read All Documentation First
Before starting any presentation task, read ALL relevant documentation files completely to understand the full workflow:
- For creating new presentations: Read
html2pptx.md and css.md in their entirety
- For editing existing presentations: Read
ooxml.md in its entirety
- For template-based creation: Read the relevant sections of this file plus
css.md
NEVER set any range limits when reading these files. Understanding the complete workflow, constraints, and best practices before starting is essential for producing high-quality presentations. Partial knowledge leads to errors, inconsistent styling, and visual defects that require rework.
Reading and analyzing content
Text extraction
To read just the text content of a presentation, convert the document to markdown:
# Convert document to markdown
python -m markitdown path-to-file.pptx
Raw XML access
Use raw XML access for: comments, speaker notes, slide layouts, animations, design elements, and complex formatting. To access these features, unpack a presentation and read its raw XML contents.
Unpacking a file
python ooxml/scripts/unpack.py <office_file> <output_dir>
Note: The unpack.py script is located at skills/public/pptx/ooxml/scripts/unpack.py relative to the project root. If the script doesn't exist at this path, use find . -name "unpack.py" to locate it.
Key file structures
ppt/presentation.xml - Main presentation metadata and slide references
ppt/slides/slide{N}.xml - Individual slide contents (slide1.xml, slide2.xml, etc.)
ppt/notesSlides/notesSlide{N}.xml - Speaker notes for each slide
ppt/comments/modernComment_*.xml - Comments for specific slides
ppt/slideLayouts/ - Layout templates for slides
ppt/slideMasters/ - Master slide templates
ppt/theme/ - Theme and styling information
ppt/media/ - Images and other media files
Typography and color extraction
To emulate example designs, analyze the presentation's typography and colors first using the methods below:
- Read theme file: Check
ppt/theme/theme1.xml for colors (<a:clrScheme>) and fonts (<a:fontScheme>)
- Sample slide content: Examine
ppt/slides/slide1.xml for actual font usage (<a:rPr>) and colors
- Search for patterns: Use grep to find color (
<a:solidFill>, <a:srgbClr>) and font references across all XML files
Creating a new PowerPoint presentation without a template
When creating a new PowerPoint presentation from scratch, use the html2pptx workflow to convert HTML slides to PowerPoint with accurate positioning.
Workflow
Read documentation: Read html2pptx.md and css.md completely (see "CRITICAL: Read All Documentation First" section above)
PREREQUISITE - Extract html2pptx library:
- Extract the library next to your script:
mkdir -p html2pptx && tar -xzf skills/public/pptx/html2pptx.tgz -C html2pptx
- This creates a
html2pptx/ directory with the library files and CLI binaries
Plan the presentation: Follow html2pptx.md "Design Philosophy" section for:
- Aesthetic direction and bold design choices
- Color palette selection (see "Creating your color palette")
- Typography strategy
- Write DETAILED outline with slide layouts and presenter notes (1-3 sentences per slide)
Set CSS variables: Override CSS variables in a shared .css file for colors, typography, and spacing (see css.md "Design System Variables")
Create HTML slides (960px × 540px for 16:9): Follow html2pptx.md for:
- Slide layout zones (title, content, footnote)
- Critical text rules (proper HTML tags)
- Supported elements and styling
Create and run a JavaScript file using the html2pptx library to convert HTML slides to PowerPoint and save the presentation
Run with: NODE_PATH="$(npm root -g)" node your-script.js 2>&1
Use the html2pptx function to process each HTML file
Add charts and tables to placeholder areas using PptxGenJS API
Save the presentation using pptx.writeFile()
⚠️ CRITICAL: Your script MUST follow this example structure. Think aloud before writing the script to make sure that you correctly use the APIs. Do NOT call pptx.addSlide.
const pptxgen = require("pptxgenjs");
const { html2pptx } = require("./html2pptx");
// Create a new pptx presentation
const pptx = new pptxgen();
pptx.layout = "LAYOUT_16x9"; // Must match HTML body dimensions
// Add an HTML-only slide
await html2pptx("slide1.html", pptx);
// Add a HTML slide with chart placeholders
const { slide: slide2, placeholders } = await html2pptx("slide2.html", pptx);
slide.addChart(pptx.charts.LINE, chartData, placeholders[0]);
// Save the presentation
await pptx.writeFile("output.pptx");
Visual validation: Convert to images and inspect for layout issues
- Convert PPTX to PDF first:
soffice --headless --convert-to pdf output.pptx
- Then convert PDF to images:
pdftoppm -jpeg -r 150 output.pdf slide
- This creates files like
slide-1.jpg, slide-2.jpg, etc.
- Read each generated image file and carefully examine for:
- Text cutoff: Text being cut off by header bars, shapes, or slide edges
- Text overlap: Text overlapping with other text or shapes
- Positioning issues: Content too close to slide boundaries or other elements
- Contrast issues: Insufficient contrast between text and backgrounds
- Alignment problems: Elements not properly aligned with each other
- Visual hierarchy: Important content properly emphasized
- CRITICAL: All slides MUST pass these validation checks before delivering to the user. Do not skip this step or deliver presentations with visual defects.
- If issues found, fix them in the following order of priority:
- Increase margins - Add more padding/spacing around problematic elements
- Adjust font size - Reduce text size to fit within available space
- Rethink the layout entirely - If the above fixes don't work, redesign the slide layout
- Regenerate the presentation after making changes
- Repeat until all slides are visually correct
Editing an existing PowerPoint presentation
To edit slides in an existing PowerPoint presentation, work with the raw Office Open XML (OOXML) format. This involves unpacking the .pptx file, editing the XML content, and repacking it.
Workflow
- Read documentation: Read
ooxml.md completely (see "CRITICAL: Read All Documentation First" section above)
- Unpack the presentation:
python ooxml/scripts/unpack.py <office_file> <output_dir>
- Edit the XML files (primarily
ppt/slides/slide{N}.xml and related files)
- CRITICAL: Validate immediately after each edit:
python ooxml/scripts/validate.py <dir> --original <file>
- Pack the final presentation:
python ooxml/scripts/pack.py <input_directory> <office_file>
Creating a new PowerPoint presentation using a template
To create a presentation that follows an existing template's design, duplicate and re-arrange template slides before replacing placeholder content.
Workflow
Extract template text AND create visual thumbnail grid:
- Extract text:
python -m markitdown template.pptx > template-content.md
- Read
template-content.md completely to understand the template contents
- Create thumbnail grids:
python scripts/thumbnail.py template.pptx
- See Creating Thumbnail Grids section for more details
Analyze template and save inventory to a file:
Visual Analysis: Review thumbnail grid(s) to understand slide layouts, design patterns, and visual structure
Create and save a template inventory file at template-inventory.md containing:
# Template Inventory Analysis
**Total Slides: [count]**
**IMPORTANT: Slides are 0-indexed (first slide = 0, last slide = count-1)**
## [Category Name]
- Slide 0: [Layout code if available] - Description/purpose
- Slide 1: [Layout code] - Description/purpose
- Slide 2: [Layout code] - Description/purpose
[... EVERY slide must be listed individually with its index ...]
Using the thumbnail grid: Reference the visual thumbnails to identify:
- Layout patterns (title slides, content layouts, section dividers)
- Image placeholder locations and counts
- Design consistency across slide groups
- Visual hierarchy and structure
This inventory file is REQUIRED for selecting appropriate templates in the next step
Create presentation outline based on template inventory:
- Review available templates from step 2.
- Choose an intro or title template for the first slide. This should be one of the first templates.
- Choose safe, text-based layouts for the other slides.
- CRITICAL: Match layout structure to actual content:
- Single-column layouts: Use for unified narrative or single topic
- Two-column layouts: Use ONLY when there are exactly 2 distinct items/concepts
- Three-column layouts: Use ONLY when there are exactly 3 distinct items/concepts
- Image + text layouts: Use ONLY when there are actual images to insert
- Quote layouts: Use ONLY for actual quotes from people (with attribution), never for emphasis
- Never use layouts with more placeholders than available content
- With 2 items, avoid forcing them into a 3-column layout
- With 4+ items, consider breaking into multiple slides or using a list format
- Count actual content pieces BEFORE selecting the layout
- Verify each placeholder in the chosen layout will be filled with meaningful content
- Select one option representing the best layout for each content section.
- Save
outline.md with content AND template mapping that leverages available designs
- Example template mapping:
# Template slides to use (0-based indexing)
# WARNING: Verify indices are within range! Template with 73 slides has indices 0-72
# Mapping: slide numbers from outline -> template slide indices
template_mapping = [
0, # Use slide 0 (Title/Cover)
34, # Use slide 34 (B1: Title and body)
34, # Use slide 34 again (duplicate for second B1)
50, # Use slide 50 (E1: Quote)
54, # Use slide 54 (F2: Closing + Text)
]
Duplicate, reorder, and delete slides using rearrange.py:
- Use the
scripts/rearrange.py script to create a new presentation with slides in the desired order:python scripts/rearrange.py template.pptx working.pptx 0,34,34,50,52
- The script handles duplicating repeated slides, deleting unused slides, and reordering automatically
- Slide indices are 0-based (first slide is 0, second is 1, etc.)
- The same slide index can appear multiple times to duplicate that slide
Extract ALL text using the inventory.py script:
Run inventory extraction:
python scripts/inventory.py working.pptx text-inventory.json
Read text-inventory.json completely to understand all shapes and their properties
The inventory JSON structure:
{
"slide-0": {
"shape-0": {
"placeholder_type": "TITLE", // or null for non-placeholders
"left": 1.5, // position in inches
"top": 2.0,
"width": 7.5,
"height": 1.2,
"paragraphs": [
{
"text": "Paragraph text",
// Optional properties (only included when non-default):
"bullet": true, // explicit bullet detected
"level": 0, // only included when bullet is true
"alignment": "CENTER", // CENTER, RIGHT (not LEFT)
"space_before": 10.0, // space before paragraph in points
"space_after": 6.0, // space after paragraph in points
"line_spacing": 22.4, // line spacing in points
"font_name": "Arial", // from first run
"font_size": 14.0, // in points
"bold": true,
"italic": false,
"underline": false,
"color": "FF0000" // RGB color
}
]
}
}
}
Key features:
- Slides: Named as "slide-0", "slide-1", etc.
- Shapes: Ordered by visual position (top-to-bottom, left-to-right) as "shape-0", "shape-1", etc.
- Placeholder types: TITLE, CENTER_TITLE, SUBTITLE, BODY, OBJECT, or null
- Default font size:
default_font_size in points extracted from layout placeholders (when available)
- Slide numbers are filtered: Shapes with SLIDE_NUMBER placeholder type are automatically excluded from inventory
- Bullets: When
bullet: true, level is always included (even if 0)
- Spacing:
space_before, space_after, and line_spacing in points (only included when set)
- Colors:
color for RGB (e.g., "FF0000"), theme_color for theme colors (e.g., "DARK_1")
- Properties: Only non-default values are included in the output
Generate replacement text and save the data to a JSON file
Based on the text inventory from the previous step:
- CRITICAL: First verify which shapes exist in the inventory - only reference shapes that are actually present
- VALIDATION: The replace.py script validates that all shapes in the replacement JSON exist in the inventory
- Referencing a non-existent shape produces an error showing available shapes
- Referencing a non-existent slide produces an error indicating the slide doesn't exist
- All validation errors are shown at once before the script exits
- IMPORTANT: The replace.py script uses inventory.py internally to identify ALL text shapes
- AUTOMATIC CLEARING: ALL text shapes from the inventory are cleared unless "paragraphs" are provided for them
- Add a "paragraphs" field to shapes that need content (not "replacement_paragraphs")
- Shapes without "paragraphs" in the replacement JSON have their text cleared automatically
- Paragraphs with bullets are automatically left aligned. Avoid setting the
alignment property when "bullet": true
- Generate appropriate replacement content for placeholder text
- Use shape size to determine appropriate content length
- CRITICAL: Include paragraph properties from the original inventory - don't just provide text
- IMPORTANT: When bullet: true, do NOT include bullet symbols (•, -, *) in text - they're added automatically
- ESSENTIAL FORMATTING RULES:
- Headers/titles should typically have
"bold": true
- List items should have
"bullet": true, "level": 0 (level is required when bullet is true)
- Preserve any alignment properties (e.g.,
"alignment": "CENTER" for centered text)
- Include font properties when different from default (e.g.,
"font_size": 14.0, "font_name": "Lora")
- Colors: Use
"color": "FF0000" for RGB or "theme_color": "DARK_1" for theme colors
- The replacement script expects properly formatted paragraphs, not just text strings
- Overlapping shapes: Prefer shapes with larger default_font_size or more appropriate placeholder_type
- Save the updated inventory with replacements to
replacement-text.json
- WARNING: Different template layouts have different shape counts - always check the actual inventory before creating replacements
Example paragraphs field showing proper formatting:
"paragraphs": [
{
"text": "New presentation title text",
"alignment": "CENTER",
"bold": true
},
{
"text": "Section Header",
"bold": true
},
{
"text": "First bullet point without bullet symbol",
"bullet": true,
"level": 0
},
{
"text": "Red colored text",
"color": "FF0000"
},
{
"text": "Theme colored text",
"theme_color": "DARK_1"
},
{
"text": "Regular paragraph text without special formatting"
}
]
Shapes not listed in the replacement JSON are automatically cleared:
{
"slide-0": {
"shape-0": {
"paragraphs": [...] // This shape gets new text
}
// shape-1 and shape-2 from inventory will be cleared automatically
}
}
Common formatting patterns for presentations:
- Title slides: Bold text, sometimes centered
- Section headers within slides: Bold text
- Bullet lists: Each item needs
"bullet": true, "level": 0
- Body text: Usually no special properties needed
- Quotes: May have special alignment or font properties
Apply replacements using the replace.py script
python scripts/replace.py working.pptx replacement-text.json output.pptx
The script will:
- First extract the inventory of ALL text shapes using functions from inventory.py
- Validate that all shapes in the replacement JSON exist in the inventory
- Clear text from ALL shapes identified in the inventory
- Apply new text only to shapes with "paragraphs" defined in the replacement JSON
- Preserve formatting by applying paragraph properties from the JSON
- Handle bullets, alignment, font properties, and colors automatically
- Save the updated presentation
Example validation errors:
ERROR: Invalid shapes in replacement JSON:
- Shape 'shape-99' not found on 'slide-0'. Available shapes: shape-0, shape-1, shape-4
- Slide 'slide-999' not found in inventory
ERROR: Replacement text made overflow worse in these shapes:
- slide-0/shape-2: overflow worsened by 1.25" (was 0.00", now 1.25")
Creating Thumbnail Grids
To create visual thumbnail grids of PowerPoint slides for quick analysis and reference:
python scripts/thumbnail.py template.pptx [output_prefix]
Features:
- Creates:
thumbnails.jpg (or thumbnails-1.jpg, thumbnails-2.jpg, etc. for large decks)
- Default: 5 columns, max 30 slides per grid (5×6)
- Custom prefix:
python scripts/thumbnail.py template.pptx my-grid
- Note: The output prefix should include the path if you want output in a specific directory (e.g.,
workspace/my-grid)
- Adjust columns:
--cols 4 (range: 3-6, affects slides per grid)
- Grid limits: 3 cols = 12 slides/grid, 4 cols = 20, 5 cols = 30, 6 cols = 42
- Slides are zero-indexed (Slide 0, Slide 1, etc.)
Use cases:
- Template analysis: Quickly understand slide layouts and design patterns
- Content review: Visual overview of entire presentation
- Navigation reference: Find specific slides by their visual appearance
- Quality check: Verify all slides are properly formatted
Examples:
# Basic usage
python scripts/thumbnail.py presentation.pptx
# Combine options: custom name, columns
python scripts/thumbnail.py template.pptx analysis --cols 4
Converting Slides to Images
To visually analyze PowerPoint slides, convert them to images using a two-step process:
Convert PPTX to PDF:
soffice --headless --convert-to pdf template.pptx
Convert PDF pages to JPEG images:
pdftoppm -jpeg -r 150 template.pdf slide
This creates files like slide-1.jpg, slide-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)
slide: Prefix for output files
Example for specific range:
pdftoppm -jpeg -r 150 -f 2 -l 5 template.pdf slide # Converts only pages 2-5
Code Style Guidelines
IMPORTANT: When generating code for PPTX operations:
- Write concise code
- Avoid verbose variable names and redundant operations
- Avoid unnecessary print statements
Dependencies
Required dependencies (should already be installed):
- markitdown:
pip install "markitdown[pptx]" (for text extraction from presentations)
- pptxgenjs:
npm install -g pptxgenjs (for creating presentations via html2pptx)
- playwright:
npm install -g playwright (for HTML rendering in html2pptx)
- react-icons:
npm install -g react-icons react react-dom (for icons in SVG format)
- LibreOffice: For PDF conversion (required for visual validation step)
- macOS:
brew install --cask libreoffice
- Linux:
sudo apt-get install libreoffice
- Poppler:
sudo apt-get install poppler-utils (for pdftoppm to convert PDF to images)
- defusedxml:
pip install defusedxml (for secure XML parsing)
1---2name: pptx-133description: Presentation creation, editing, and analysis. When Claude needs to work with presentations (.pptx files) for: (1) Creating new presentations, (2) Modifying or editing content, (3) Working with layouts, (4) Adding comments or speaker notes, or any other presentation tasks4license: Proprietary. LICENSE.txt has complete terms5---6
7# PPTX creation, editing, and analysis
8
9## Overview
10
11Create, edit, or analyze the contents of .pptx files when requested. A .pptx file is essentially a ZIP archive containing XML files and other resources. Different tools and workflows are available for different tasks.
12
13## CRITICAL: Read All Documentation First
14
15**Before starting any presentation task**, read ALL relevant documentation files completely to understand the full workflow:
16
171. **For creating new presentations**: Read [`html2pptx.md`](html2pptx.md) and [`css.md`](css.md) in their entirety
182. **For editing existing presentations**: Read [`ooxml.md`](ooxml.md) in its entirety
193. **For template-based creation**: Read the relevant sections of this file plus [`css.md`](css.md)
20
21**NEVER set any range limits when reading these files.** Understanding the complete workflow, constraints, and best practices before starting is essential for producing high-quality presentations. Partial knowledge leads to errors, inconsistent styling, and visual defects that require rework.
22
23## Reading and analyzing content
24
25### Text extraction
26
27To read just the text content of a presentation, convert the document to markdown:
28
29```bash
30# Convert document to markdown
31python -m markitdown path-to-file.pptx
32```
33
34### Raw XML access
35
36Use raw XML access for: comments, speaker notes, slide layouts, animations, design elements, and complex formatting. To access these features, unpack a presentation and read its raw XML contents.
37
38#### Unpacking a file
39
40`python ooxml/scripts/unpack.py <office_file> <output_dir>`
41
42**Note**: The unpack.py script is located at `skills/public/pptx/ooxml/scripts/unpack.py` relative to the project root. If the script doesn't exist at this path, use `find . -name "unpack.py"` to locate it.
43
44#### Key file structures
45
46- `ppt/presentation.xml` - Main presentation metadata and slide references
47- `ppt/slides/slide{N}.xml` - Individual slide contents (slide1.xml, slide2.xml, etc.)
48- `ppt/notesSlides/notesSlide{N}.xml` - Speaker notes for each slide
49- `ppt/comments/modernComment_*.xml` - Comments for specific slides
50- `ppt/slideLayouts/` - Layout templates for slides
51- `ppt/slideMasters/` - Master slide templates
52- `ppt/theme/` - Theme and styling information
53- `ppt/media/` - Images and other media files
54
55#### Typography and color extraction
56
57**To emulate example designs**, analyze the presentation's typography and colors first using the methods below:
58
591. **Read theme file**: Check `ppt/theme/theme1.xml` for colors (`<a:clrScheme>`) and fonts (`<a:fontScheme>`)
602. **Sample slide content**: Examine `ppt/slides/slide1.xml` for actual font usage (`<a:rPr>`) and colors
613. **Search for patterns**: Use grep to find color (`<a:solidFill>`, `<a:srgbClr>`) and font references across all XML files
62
63## Creating a new PowerPoint presentation **without a template**
64
65When creating a new PowerPoint presentation from scratch, use the **html2pptx** workflow to convert HTML slides to PowerPoint with accurate positioning.
66
67### Workflow
68
691. **Read documentation**: Read [`html2pptx.md`](html2pptx.md) and [`css.md`](css.md) completely (see "CRITICAL: Read All Documentation First" section above)
70
712. **PREREQUISITE - Extract html2pptx library**:
72 - Extract the library next to your script: `mkdir -p html2pptx && tar -xzf skills/public/pptx/html2pptx.tgz -C html2pptx`
73 - This creates a `html2pptx/` directory with the library files and CLI binaries
74
753. **Plan the presentation**: Follow html2pptx.md "Design Philosophy" section for:
76 - Aesthetic direction and bold design choices
77 - Color palette selection (see "Creating your color palette")
78 - Typography strategy
79 - Write DETAILED outline with slide layouts and presenter notes (1-3 sentences per slide)
80
814. **Set CSS variables**: Override CSS variables in a shared `.css` file for colors, typography, and spacing (see css.md "Design System Variables")
82
835. **Create HTML slides** (960px × 540px for 16:9): Follow html2pptx.md for:
84 - Slide layout zones (title, content, footnote)
85 - Critical text rules (proper HTML tags)
86 - Supported elements and styling
87
886. Create and run a JavaScript file using the [`html2pptx`](./html2pptx) library to convert HTML slides to PowerPoint and save the presentation
89
90 - Run with: `NODE_PATH="$(npm root -g)" node your-script.js 2>&1`
91 - Use the `html2pptx` function to process each HTML file
92 - Add charts and tables to placeholder areas using PptxGenJS API
93 - Save the presentation using `pptx.writeFile()`
94
95 - **⚠️ CRITICAL:** Your script MUST follow this example structure. Think aloud before writing the script to make sure that you correctly use the APIs. Do NOT call `pptx.addSlide`.
96
97 ```javascript
98 const pptxgen = require("pptxgenjs");
99 const { html2pptx } = require("./html2pptx");
100
101 // Create a new pptx presentation
102 const pptx = new pptxgen();
103 pptx.layout = "LAYOUT_16x9"; // Must match HTML body dimensions
104
105 // Add an HTML-only slide
106 await html2pptx("slide1.html", pptx);
107
108 // Add a HTML slide with chart placeholders
109 const { slide: slide2, placeholders } = await html2pptx("slide2.html", pptx);
110 slide.addChart(pptx.charts.LINE, chartData, placeholders[0]);
111
112 // Save the presentation
113 await pptx.writeFile("output.pptx");
114 ```
115
1167. **Visual validation**: Convert to images and inspect for layout issues
117 - Convert PPTX to PDF first: `soffice --headless --convert-to pdf output.pptx`
118 - Then convert PDF to images: `pdftoppm -jpeg -r 150 output.pdf slide`
119 - This creates files like `slide-1.jpg`, `slide-2.jpg`, etc.
120 - Read each generated image file and carefully examine for:
121 - **Text cutoff**: Text being cut off by header bars, shapes, or slide edges
122 - **Text overlap**: Text overlapping with other text or shapes
123 - **Positioning issues**: Content too close to slide boundaries or other elements
124 - **Contrast issues**: Insufficient contrast between text and backgrounds
125 - **Alignment problems**: Elements not properly aligned with each other
126 - **Visual hierarchy**: Important content properly emphasized
127 - **CRITICAL: All slides MUST pass these validation checks before delivering to the user.** Do not skip this step or deliver presentations with visual defects.
128 - If issues found, fix them in the following order of priority:
129 1. **Increase margins** - Add more padding/spacing around problematic elements
130 2. **Adjust font size** - Reduce text size to fit within available space
131 3. **Rethink the layout entirely** - If the above fixes don't work, redesign the slide layout
132 - Regenerate the presentation after making changes
133 - Repeat until all slides are visually correct
134
135## Editing an existing PowerPoint presentation
136
137To edit slides in an existing PowerPoint presentation, work with the raw Office Open XML (OOXML) format. This involves unpacking the .pptx file, editing the XML content, and repacking it.
138
139### Workflow
140
1411. **Read documentation**: Read [`ooxml.md`](ooxml.md) completely (see "CRITICAL: Read All Documentation First" section above)
1422. Unpack the presentation: `python ooxml/scripts/unpack.py <office_file> <output_dir>`
1433. Edit the XML files (primarily `ppt/slides/slide{N}.xml` and related files)
1444. **CRITICAL**: Validate immediately after each edit: `python ooxml/scripts/validate.py <dir> --original <file>`
1455. Pack the final presentation: `python ooxml/scripts/pack.py <input_directory> <office_file>`
146
147## Creating a new PowerPoint presentation **using a template**
148
149To create a presentation that follows an existing template's design, duplicate and re-arrange template slides before replacing placeholder content.
150
151### Workflow
152
1531. **Extract template text AND create visual thumbnail grid**:
154
155 - Extract text: `python -m markitdown template.pptx > template-content.md`
156 - Read `template-content.md` completely to understand the template contents
157 - Create thumbnail grids: `python scripts/thumbnail.py template.pptx`
158 - See [Creating Thumbnail Grids](#creating-thumbnail-grids) section for more details
159
1602. **Analyze template and save inventory to a file**:
161
162 - **Visual Analysis**: Review thumbnail grid(s) to understand slide layouts, design patterns, and visual structure
163 - Create and save a template inventory file at `template-inventory.md` containing:
164
165 ```markdown
166 # Template Inventory Analysis
167
168 **Total Slides: [count]**
169 **IMPORTANT: Slides are 0-indexed (first slide = 0, last slide = count-1)**
170
171 ## [Category Name]
172
173 - Slide 0: [Layout code if available] - Description/purpose
174 - Slide 1: [Layout code] - Description/purpose
175 - Slide 2: [Layout code] - Description/purpose
176 [... EVERY slide must be listed individually with its index ...]
177 ```
178
179 - **Using the thumbnail grid**: Reference the visual thumbnails to identify:
180 - Layout patterns (title slides, content layouts, section dividers)
181 - Image placeholder locations and counts
182 - Design consistency across slide groups
183 - Visual hierarchy and structure
184 - This inventory file is REQUIRED for selecting appropriate templates in the next step
185
1863. **Create presentation outline based on template inventory**:
187
188 - Review available templates from step 2.
189 - Choose an intro or title template for the first slide. This should be one of the first templates.
190 - Choose safe, text-based layouts for the other slides.
191 - **CRITICAL: Match layout structure to actual content**:
192 - Single-column layouts: Use for unified narrative or single topic
193 - Two-column layouts: Use ONLY when there are exactly 2 distinct items/concepts
194 - Three-column layouts: Use ONLY when there are exactly 3 distinct items/concepts
195 - Image + text layouts: Use ONLY when there are actual images to insert
196 - Quote layouts: Use ONLY for actual quotes from people (with attribution), never for emphasis
197 - Never use layouts with more placeholders than available content
198 - With 2 items, avoid forcing them into a 3-column layout
199 - With 4+ items, consider breaking into multiple slides or using a list format
200 - Count actual content pieces BEFORE selecting the layout
201 - Verify each placeholder in the chosen layout will be filled with meaningful content
202 - Select one option representing the **best** layout for each content section.
203 - Save `outline.md` with content AND template mapping that leverages available designs
204 - Example template mapping:
205 ```
206 # Template slides to use (0-based indexing)
207 # WARNING: Verify indices are within range! Template with 73 slides has indices 0-72
208 # Mapping: slide numbers from outline -> template slide indices
209 template_mapping = [
210 0, # Use slide 0 (Title/Cover)
211 34, # Use slide 34 (B1: Title and body)
212 34, # Use slide 34 again (duplicate for second B1)
213 50, # Use slide 50 (E1: Quote)
214 54, # Use slide 54 (F2: Closing + Text)
215 ]
216 ```
217
2184. **Duplicate, reorder, and delete slides using `rearrange.py`**:
219
220 - Use the `scripts/rearrange.py` script to create a new presentation with slides in the desired order:
221 ```bash
222 python scripts/rearrange.py template.pptx working.pptx 0,34,34,50,52
223 ```
224 - The script handles duplicating repeated slides, deleting unused slides, and reordering automatically
225 - Slide indices are 0-based (first slide is 0, second is 1, etc.)
226 - The same slide index can appear multiple times to duplicate that slide
227
2285. **Extract ALL text using the `inventory.py` script**:
229
230 - **Run inventory extraction**:
231 ```bash
232 python scripts/inventory.py working.pptx text-inventory.json
233 ```
234 - **Read text-inventory.json** completely to understand all shapes and their properties
235
236 - The inventory JSON structure:
237
238 ```json
239 {
240 "slide-0": {
241 "shape-0": {
242 "placeholder_type": "TITLE", // or null for non-placeholders
243 "left": 1.5, // position in inches
244 "top": 2.0,
245 "width": 7.5,
246 "height": 1.2,
247 "paragraphs": [
248 {
249 "text": "Paragraph text",
250 // Optional properties (only included when non-default):
251 "bullet": true, // explicit bullet detected
252 "level": 0, // only included when bullet is true
253 "alignment": "CENTER", // CENTER, RIGHT (not LEFT)
254 "space_before": 10.0, // space before paragraph in points
255 "space_after": 6.0, // space after paragraph in points
256 "line_spacing": 22.4, // line spacing in points
257 "font_name": "Arial", // from first run
258 "font_size": 14.0, // in points
259 "bold": true,
260 "italic": false,
261 "underline": false,
262 "color": "FF0000" // RGB color
263 }
264 ]
265 }
266 }
267 }
268 ```
269
270 - Key features:
271 - **Slides**: Named as "slide-0", "slide-1", etc.
272 - **Shapes**: Ordered by visual position (top-to-bottom, left-to-right) as "shape-0", "shape-1", etc.
273 - **Placeholder types**: TITLE, CENTER_TITLE, SUBTITLE, BODY, OBJECT, or null
274 - **Default font size**: `default_font_size` in points extracted from layout placeholders (when available)
275 - **Slide numbers are filtered**: Shapes with SLIDE_NUMBER placeholder type are automatically excluded from inventory
276 - **Bullets**: When `bullet: true`, `level` is always included (even if 0)
277 - **Spacing**: `space_before`, `space_after`, and `line_spacing` in points (only included when set)
278 - **Colors**: `color` for RGB (e.g., "FF0000"), `theme_color` for theme colors (e.g., "DARK_1")
279 - **Properties**: Only non-default values are included in the output
280
2816. **Generate replacement text and save the data to a JSON file**
282 Based on the text inventory from the previous step:
283
284 - **CRITICAL**: First verify which shapes exist in the inventory - only reference shapes that are actually present
285 - **VALIDATION**: The replace.py script validates that all shapes in the replacement JSON exist in the inventory
286 - Referencing a non-existent shape produces an error showing available shapes
287 - Referencing a non-existent slide produces an error indicating the slide doesn't exist
288 - All validation errors are shown at once before the script exits
289 - **IMPORTANT**: The replace.py script uses inventory.py internally to identify ALL text shapes
290 - **AUTOMATIC CLEARING**: ALL text shapes from the inventory are cleared unless "paragraphs" are provided for them
291 - Add a "paragraphs" field to shapes that need content (not "replacement_paragraphs")
292 - Shapes without "paragraphs" in the replacement JSON have their text cleared automatically
293 - Paragraphs with bullets are automatically left aligned. Avoid setting the `alignment` property when `"bullet": true`
294 - Generate appropriate replacement content for placeholder text
295 - Use shape size to determine appropriate content length
296 - **CRITICAL**: Include paragraph properties from the original inventory - don't just provide text
297 - **IMPORTANT**: When bullet: true, do NOT include bullet symbols (•, -, \*) in text - they're added automatically
298 - **ESSENTIAL FORMATTING RULES**:
299 - Headers/titles should typically have `"bold": true`
300 - List items should have `"bullet": true, "level": 0` (level is required when bullet is true)
301 - Preserve any alignment properties (e.g., `"alignment": "CENTER"` for centered text)
302 - Include font properties when different from default (e.g., `"font_size": 14.0`, `"font_name": "Lora"`)
303 - Colors: Use `"color": "FF0000"` for RGB or `"theme_color": "DARK_1"` for theme colors
304 - The replacement script expects **properly formatted paragraphs**, not just text strings
305 - **Overlapping shapes**: Prefer shapes with larger default_font_size or more appropriate placeholder_type
306 - Save the updated inventory with replacements to `replacement-text.json`
307 - **WARNING**: Different template layouts have different shape counts - always check the actual inventory before creating replacements
308
309 Example paragraphs field showing proper formatting:
310
311 ```json
312 "paragraphs": [
313 {
314 "text": "New presentation title text",
315 "alignment": "CENTER",
316 "bold": true
317 },
318 {
319 "text": "Section Header",
320 "bold": true
321 },
322 {
323 "text": "First bullet point without bullet symbol",
324 "bullet": true,
325 "level": 0
326 },
327 {
328 "text": "Red colored text",
329 "color": "FF0000"
330 },
331 {
332 "text": "Theme colored text",
333 "theme_color": "DARK_1"
334 },
335 {
336 "text": "Regular paragraph text without special formatting"
337 }
338 ]
339 ```
340
341 **Shapes not listed in the replacement JSON are automatically cleared**:
342
343 ```json
344 {
345 "slide-0": {
346 "shape-0": {
347 "paragraphs": [...] // This shape gets new text
348 }
349 // shape-1 and shape-2 from inventory will be cleared automatically
350 }
351 }
352 ```
353
354 **Common formatting patterns for presentations**:
355
356 - Title slides: Bold text, sometimes centered
357 - Section headers within slides: Bold text
358 - Bullet lists: Each item needs `"bullet": true, "level": 0`
359 - Body text: Usually no special properties needed
360 - Quotes: May have special alignment or font properties
361
3627. **Apply replacements using the `replace.py` script**
363
364 ```bash
365 python scripts/replace.py working.pptx replacement-text.json output.pptx
366 ```
367
368 The script will:
369
370 - First extract the inventory of ALL text shapes using functions from inventory.py
371 - Validate that all shapes in the replacement JSON exist in the inventory
372 - Clear text from ALL shapes identified in the inventory
373 - Apply new text only to shapes with "paragraphs" defined in the replacement JSON
374 - Preserve formatting by applying paragraph properties from the JSON
375 - Handle bullets, alignment, font properties, and colors automatically
376 - Save the updated presentation
377
378 Example validation errors:
379
380 ```
381 ERROR: Invalid shapes in replacement JSON:
382 - Shape 'shape-99' not found on 'slide-0'. Available shapes: shape-0, shape-1, shape-4
383 - Slide 'slide-999' not found in inventory
384 ```
385
386 ```
387 ERROR: Replacement text made overflow worse in these shapes:
388 - slide-0/shape-2: overflow worsened by 1.25" (was 0.00", now 1.25")
389 ```
390
391## Creating Thumbnail Grids
392
393To create visual thumbnail grids of PowerPoint slides for quick analysis and reference:
394
395```bash
396python scripts/thumbnail.py template.pptx [output_prefix]
397```
398
399**Features**:
400
401- Creates: `thumbnails.jpg` (or `thumbnails-1.jpg`, `thumbnails-2.jpg`, etc. for large decks)
402- Default: 5 columns, max 30 slides per grid (5×6)
403- Custom prefix: `python scripts/thumbnail.py template.pptx my-grid`
404 - Note: The output prefix should include the path if you want output in a specific directory (e.g., `workspace/my-grid`)
405- Adjust columns: `--cols 4` (range: 3-6, affects slides per grid)
406- Grid limits: 3 cols = 12 slides/grid, 4 cols = 20, 5 cols = 30, 6 cols = 42
407- Slides are zero-indexed (Slide 0, Slide 1, etc.)
408
409**Use cases**:
410
411- Template analysis: Quickly understand slide layouts and design patterns
412- Content review: Visual overview of entire presentation
413- Navigation reference: Find specific slides by their visual appearance
414- Quality check: Verify all slides are properly formatted
415
416**Examples**:
417
418```bash
419# Basic usage
420python scripts/thumbnail.py presentation.pptx
421
422# Combine options: custom name, columns
423python scripts/thumbnail.py template.pptx analysis --cols 4
424```
425
426## Converting Slides to Images
427
428To visually analyze PowerPoint slides, convert them to images using a two-step process:
429
4301. **Convert PPTX to PDF**:
431
432 ```bash
433 soffice --headless --convert-to pdf template.pptx
434 ```
435
4362. **Convert PDF pages to JPEG images**:
437 ```bash
438 pdftoppm -jpeg -r 150 template.pdf slide
439 ```
440 This creates files like `slide-1.jpg`, `slide-2.jpg`, etc.
441
442Options:
443
444- `-r 150`: Sets resolution to 150 DPI (adjust for quality/size balance)
445- `-jpeg`: Output JPEG format (use `-png` for PNG if preferred)
446- `-f N`: First page to convert (e.g., `-f 2` starts from page 2)
447- `-l N`: Last page to convert (e.g., `-l 5` stops at page 5)
448- `slide`: Prefix for output files
449
450Example for specific range:
451
452```bash
453pdftoppm -jpeg -r 150 -f 2 -l 5 template.pdf slide # Converts only pages 2-5
454```
455
456## Code Style Guidelines
457
458**IMPORTANT**: When generating code for PPTX operations:
459
460- Write concise code
461- Avoid verbose variable names and redundant operations
462- Avoid unnecessary print statements
463
464## Dependencies
465
466Required dependencies (should already be installed):
467
468- **markitdown**: `pip install "markitdown[pptx]"` (for text extraction from presentations)
469- **pptxgenjs**: `npm install -g pptxgenjs` (for creating presentations via html2pptx)
470- **playwright**: `npm install -g playwright` (for HTML rendering in html2pptx)
471- **react-icons**: `npm install -g react-icons react react-dom` (for icons in SVG format)
472- **LibreOffice**: For PDF conversion (required for visual validation step)
473 - macOS: `brew install --cask libreoffice`
474 - Linux: `sudo apt-get install libreoffice`
475- **Poppler**: `sudo apt-get install poppler-utils` (for pdftoppm to convert PDF to images)
476- **defusedxml**: `pip install defusedxml` (for secure XML parsing)