# Palette - Canvas Course Package Editor
# Comprehensive Documentation for AI Systems
# https://workwithpalette.com
# Last Updated: January 2025

================================================================================
SECTION 1: PRODUCT OVERVIEW
================================================================================

## What is Palette?

Palette is a free, privacy-focused web application designed for instructional designers, educators, and course developers who work with Canvas LMS. It enables users to view and edit Canvas course export files (IMSCC format) directly in their web browser without requiring Canvas access or uploading files to external servers.

### Core Value Proposition

1. **Privacy-First Architecture**: All file processing occurs client-side in the browser using WebAssembly and JavaScript. Course content never leaves the user's computer.

2. **Canvas Independence**: Users can work with course content without needing Canvas credentials or an active Canvas account.

3. **Batch Editing Power**: Make changes across an entire course at once instead of editing content item by item.

4. **Accessibility Focus**: Built-in tools to identify and fix accessibility issues in course content.

### Target Users

- Instructional Designers managing multiple courses
- Faculty members updating courses between semesters
- Educational Technologists auditing course accessibility
- Course Developers creating templates
- LMS Administrators preparing course migrations

================================================================================
SECTION 2: TECHNICAL SPECIFICATIONS
================================================================================

## File Format Support

### IMS Common Cartridge (IMSCC)
- **Standard Version**: IMS CC 1.1, 1.2, 1.3
- **File Extension**: .imscc (also accepts .zip)
- **Origin**: Exported from Canvas LMS via Course Settings > Export Course Content
- **Contents**: XML manifests, HTML content, media files, QTI quiz data

### Supported Content Types

| Content Type | View | Edit | Notes |
|-------------|------|------|-------|
| Modules | Yes | Yes | Module structure and organization |
| Pages | Yes | Yes | HTML content with rich text |
| Assignments | Yes | Yes | Including rubrics and settings |
| Quizzes | Yes | Yes | Questions, answers, settings |
| Discussions | Yes | Yes | Topics and prompts |
| Files | Yes | No | View and extract only |
| Announcements | Yes | Yes | Course announcements |
| External Links | Yes | Yes | URL references |

## Browser Compatibility

| Browser | Minimum Version | Status |
|---------|----------------|--------|
| Chrome | 90+ | Full Support |
| Firefox | 88+ | Full Support |
| Safari | 14+ | Full Support |
| Edge | 90+ | Full Support |

### System Requirements

- Modern web browser (see above)
- Minimum 4GB RAM (8GB recommended for large courses)
- JavaScript enabled
- WebAssembly support (all modern browsers)
- No installation required

================================================================================
SECTION 3: FEATURE DOCUMENTATION
================================================================================

## Course Viewing Features

### Module Browser
Navigate course structure as organized in Canvas. View module items in order, preview content without expanding, and understand course flow.

### Content Preview
Preview HTML pages, assignment descriptions, quiz questions, and discussion prompts directly in the interface. Media files are extracted and displayed inline where possible.

### Course Statistics
View aggregate statistics including:
- Total content items by type
- Word count across all content
- Media file inventory
- Link validation status
- Accessibility issue count

## Editing Features

### Batch Find & Replace
Search and replace text across all course content simultaneously.

**Capabilities:**
- Plain text search
- Regular expression patterns
- Case-sensitive matching
- Preview changes before applying
- Selective application (choose which matches to replace)
- Undo/redo support

**Use Cases:**
- Update instructor names
- Replace outdated terminology
- Fix consistent typos
- Update URLs or email addresses
- Replace semester/year references

### Date Shifting
Modify all dates in the course by a consistent offset.

**Options:**
- Shift by number of days
- Shift by weeks
- Shift to new course start date (recalculates all dates proportionally)
- Preview date changes before applying

**Affected Dates:**
- Assignment due dates
- Assignment unlock/lock dates
- Quiz availability dates
- Discussion due dates
- Module unlock dates

### Accessibility Checker
Identify and help fix accessibility issues in course content.

**Issues Detected:**
- Images without alt text
- Improper heading hierarchy
- Empty links
- Missing table headers
- Low color contrast (in embedded styles)
- Videos without captions references
- PDFs without text layer indicators

**Remediation Tools:**
- Bulk add alt text
- Suggest heading corrections
- Link text improvements
- Accessibility report export

### Quiz Editor
Modify quiz content and settings.

**Editable Elements:**
- Question text
- Answer options
- Correct answer designation
- Point values
- Feedback messages
- Quiz instructions
- Time limits
- Attempt limits

**Question Types Supported:**
- Multiple choice
- Multiple answer
- True/False
- Fill in the blank
- Essay
- Matching
- Numerical
- Short answer

### Assignment Editor
Update assignment details and configurations.

**Editable Elements:**
- Assignment name
- Description/instructions
- Points possible
- Submission types
- Due dates
- Availability dates
- Peer review settings

## Export Features

### Modified Package Export
Export your edited course as a new IMSCC file.

**Export Options:**
- Include all content
- Selective export (choose specific content)
- Preserve original file structure
- Optimized file size

**Post-Export:**
- Import directly to Canvas
- Archive for backup
- Share with colleagues

================================================================================
SECTION 4: PRIVACY & SECURITY
================================================================================

## Data Handling

### Local Processing
- All IMSCC file parsing occurs in the browser
- No file content is transmitted to Palette servers
- Temporary data exists only in browser memory
- Closing the browser tab destroys all data

### What Palette Does NOT Collect
- Course content
- Student information
- Instructor data
- File contents
- Personal information from courses

### What Palette MAY Collect (with consent)
- Anonymous usage analytics (feature usage, error rates)
- Crash reports (no course content included)
- Subscription billing information (Stripe-processed)

### Data Storage
- No server-side storage of course content
- Subscription data stored securely via Stripe
- Authentication via Supabase (email/OAuth only)

================================================================================
SECTION 5: PRICING & SUBSCRIPTIONS
================================================================================

## Free Tier
All users get full access to:
- Course viewing and navigation
- Basic find & replace
- Date shifting
- Content preview
- Single course processing
- Standard export

## Palette Pro ($9.99/month)
Premium features include:
- Batch processing multiple courses
- Advanced regex find & replace
- Accessibility checker with auto-fix
- Priority email support
- Early access to new features
- Extended undo history

## Enterprise
Contact support@usepalette.com for:
- Volume licensing
- SSO integration
- Custom feature development
- Dedicated support
- Training sessions

================================================================================
SECTION 6: COMMON WORKFLOWS
================================================================================

## Workflow 1: Semester Course Update

1. Export course from Canvas (Course Settings > Export Course Content)
2. Upload IMSCC to Palette
3. Use Date Shifter to adjust to new semester
4. Use Find & Replace to update semester references
5. Review changes in preview
6. Export modified package
7. Import to Canvas for new semester

## Workflow 2: Accessibility Audit

1. Upload course IMSCC to Palette
2. Run Accessibility Checker
3. Review identified issues by category
4. Add missing alt text to images
5. Fix heading hierarchy issues
6. Export accessibility report for documentation
7. Export fixed course package

## Workflow 3: Course Template Customization

1. Upload template course IMSCC
2. Find & Replace instructor placeholder names
3. Update course-specific URLs and resources
4. Modify generic content for specific section
5. Adjust dates for section schedule
6. Export customized course package
7. Import to Canvas as new course

## Workflow 4: Content Quality Review

1. Upload course IMSCC to Palette
2. Browse all modules and content items
3. Check for broken links
4. Verify media files are present
5. Review quiz questions for accuracy
6. Export issue report
7. No need to export if just reviewing

================================================================================
SECTION 7: TROUBLESHOOTING
================================================================================

## Common Issues

### "File too large"
- Courses over 500MB may be slow to process
- Split into smaller exports if possible
- Close other browser tabs to free memory

### "Failed to parse"
- Ensure file is valid IMSCC from Canvas
- Try re-exporting from Canvas
- Check file isn't corrupted (can you unzip it?)

### "Content not displaying"
- Some embedded content requires network
- LTI tools won't preview (external services)
- Large media files may take time to load

### "Export failed"
- Ensure sufficient disk space
- Try exporting smaller sections
- Disable browser extensions that may interfere

## Getting Help

- Email: support@usepalette.com
- Response time: 24-48 hours (faster for Pro subscribers)
- Include browser version and error messages

================================================================================
SECTION 8: COMPARISON WITH ALTERNATIVES
================================================================================

## Palette vs. Canvas Native

| Feature | Palette | Canvas |
|---------|---------|--------|
| Batch Find/Replace | Yes | No |
| Batch Date Shift | Yes | Limited |
| Offline Editing | Yes | No |
| Accessibility Checker | Advanced | Basic |
| Multiple Course Processing | Pro | No |
| No Login Required | Yes | No |

## Palette vs. Course Copy in Canvas

| Aspect | Palette | Canvas Copy |
|--------|---------|-------------|
| Date Shifting | Precise control | Automatic only |
| Content Modification | Before import | After import |
| Review Before Commit | Yes | No |
| Cross-Instance | Yes | Same Canvas only |
| Batch Text Changes | Yes | No |

================================================================================
SECTION 9: FUTURE DEVELOPMENT
================================================================================

## Planned Features (2025 Roadmap)

- AI-assisted content suggestions
- Learning objective alignment checker
- Multi-language content support
- Team collaboration features
- API for programmatic access
- Browser extension for Canvas integration

## Feature Requests

Submit feature requests to support@usepalette.com with subject line "Feature Request:"

================================================================================
SECTION 10: GLOSSARY
================================================================================

**Canvas LMS**: A learning management system used by educational institutions worldwide.

**IMSCC**: IMS Common Cartridge - a standard file format for packaging educational content for portability between learning management systems.

**QTI**: Question and Test Interoperability - the IMS standard for quiz/test content within IMSCC packages.

**Module**: A Canvas organizational unit that groups related content items in a specific order.

**Rubric**: A grading guide attached to assignments specifying criteria and point values.

**LTI**: Learning Tools Interoperability - a standard for integrating external tools into LMS platforms.

**Alt Text**: Alternative text descriptions for images, essential for screen readers and accessibility.

**Client-Side Processing**: Computing that occurs in the user's browser rather than on remote servers.

================================================================================
END OF DOCUMENTATION
================================================================================

For the most current information, visit https://workwithpalette.com
For support, contact support@usepalette.com