Initial commit of documentation files.
This commit is contained in:
@@ -0,0 +1,157 @@
|
||||
# Edison PowerPoint Add-in
|
||||
|
||||
A productivity toolkit that enhances PowerPoint with specialized formatting and content tools for creating professional presentations.
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
### Content Tools
|
||||
|
||||
- **Match Properties**: Copy visual properties (line style, fill color, text formatting) from the first selected shape to all other selected shapes.
|
||||
- **Match Sizes**: Resize all selected shapes to match the dimensions of the first selected shape.
|
||||
- **Swap Positions**: Swap the position of two selected shapes while maintaining their size and formatting.
|
||||
- **Insert Titles**: Add slide titles to slides that are missing them.
|
||||
- **Round Image**: Create circular images by generating an elliptical mask and selecting both shapes for intersection.
|
||||
|
||||
### Slide Enhancement Tools
|
||||
|
||||
- **Progress Bar**: Add or remove a visual progress indicator at the bottom of each slide showing the current position in the presentation.
|
||||
- **Confidential Marking**: Add or remove a "Confidential" label to all slides in the presentation.
|
||||
- **Draft Watermark**: Add or remove a "DRAFT" watermark on slide masters to mark in-progress presentations.
|
||||
|
||||
### Alignment Tools
|
||||
|
||||
- **Horizontal Alignment**: Align selected objects to the left, center, or right of the slide.
|
||||
- **Vertical Alignment**: Align selected objects to the top, middle, or bottom of the slide.
|
||||
|
||||
## Installation
|
||||
|
||||
### For End Users
|
||||
|
||||
1. Download the latest release from the [Releases](https://github.com/your-org/edison-powerpoint-addin/releases) page.
|
||||
2. Follow the installation instructions provided with the download.
|
||||
3. Open PowerPoint and find the Edison add-in in the ribbon.
|
||||
|
||||
### For Developers
|
||||
|
||||
To set up the development environment:
|
||||
|
||||
1. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/your-org/edison-powerpoint-addin.git
|
||||
cd edison-powerpoint-addin
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
3. Build the project:
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
|
||||
4. Start the development server:
|
||||
```
|
||||
npm run start
|
||||
```
|
||||
|
||||
## Development Guide
|
||||
|
||||
### Project Structure
|
||||
|
||||
- `/src/taskpane/components/` - React components for each tool
|
||||
- `/src/commands/` - Command handlers for add-in functionality
|
||||
- `/assets/` - Images and icons
|
||||
|
||||
### Key Development Commands
|
||||
|
||||
- `npm run build` - Build the project for production
|
||||
- `npm run build:dev` - Build with development settings
|
||||
- `npm run dev-server` - Start the development server
|
||||
- `npm run lint` - Check code quality
|
||||
- `npm run lint:fix` - Fix linting issues
|
||||
- `npm run start` - Start the add-in in PowerPoint
|
||||
- `npm run stop` - Stop the running add-in
|
||||
- `npm run validate` - Validate the manifest file
|
||||
|
||||
### Creating New Tools
|
||||
|
||||
To add a new tool to the add-in:
|
||||
|
||||
1. Create a new component in `/src/taskpane/components/`
|
||||
2. Follow the pattern of existing components, using the Office.js API for PowerPoint
|
||||
3. Import and add your component to `App.tsx`
|
||||
4. Update this documentation to include your new tool
|
||||
|
||||
## User Guide
|
||||
|
||||
### Getting Started
|
||||
|
||||
1. Open PowerPoint and navigate to the "Home" tab
|
||||
2. Click on the "Edison Pane" button to open the add-in taskpane
|
||||
3. The taskpane displays all available tools organized by category
|
||||
|
||||
### Using Content Tools
|
||||
|
||||
#### Match Properties
|
||||
|
||||
1. Select multiple shapes (the first shape is the source)
|
||||
2. Click "Match Properties" in the Edison pane
|
||||
3. All selected shapes will adopt the properties of the first selected shape
|
||||
|
||||
#### Match Sizes
|
||||
|
||||
1. Select multiple shapes (the first shape is the source)
|
||||
2. Click "Match Sizes" in the Edison pane
|
||||
3. All selected shapes will be resized to match the first selected shape
|
||||
|
||||
#### Swap Positions
|
||||
|
||||
1. Select exactly two shapes
|
||||
2. Click "Swap Positions" in the Edison pane
|
||||
3. The shapes will exchange positions while maintaining their size and formatting
|
||||
|
||||
#### Insert Titles
|
||||
|
||||
1. Click "Insert Titles" in the Edison pane
|
||||
2. Slides without titles will have a title placeholder added
|
||||
|
||||
#### Round Image
|
||||
|
||||
1. Select an image
|
||||
2. Click "Round Image" in the Edison pane
|
||||
3. The image will be cropped to a circular shape
|
||||
|
||||
### Using Slide Enhancement Tools
|
||||
|
||||
#### Progress Bar
|
||||
|
||||
1. Click "Add Progress Bar" to add a progress indicator to all slides
|
||||
2. Click "Remove Progress Bar" to remove the progress indicators
|
||||
|
||||
#### Confidential Marking
|
||||
|
||||
1. Click "Add Confidential" to add the confidential label to all slides
|
||||
2. Click "Remove Confidential" to remove all confidential labels
|
||||
|
||||
#### Draft Watermark
|
||||
|
||||
1. Click "Add Draft" to add a DRAFT watermark to the slide masters
|
||||
2. Click "Remove Draft" to remove all DRAFT watermarks
|
||||
|
||||
### Using Alignment Tools
|
||||
|
||||
1. Select one or more shapes
|
||||
2. Click on the desired alignment button (Left, Center, Right, Top, Middle, Bottom)
|
||||
3. All selected shapes will be aligned accordingly
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the LICENSE file for details.
|
||||
|
||||
## Version History
|
||||
|
||||
- v0.1.0 - Initial release with core functionality
|
||||
Reference in New Issue
Block a user