Bug gixes, features added, GUI updates and more
This commit is contained in:
71
oAI/Resources/oAI.help/README.md
Normal file
71
oAI/Resources/oAI.help/README.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# oAI Help Book
|
||||
|
||||
This folder contains the Apple Help Book for oAI.
|
||||
|
||||
## Adding to Xcode Project
|
||||
|
||||
1. **Add the help folder to your project:**
|
||||
- In Xcode, right-click on the `Resources` folder in the Project Navigator
|
||||
- Select "Add Files to 'oAI'..."
|
||||
- Select the `oAI.help` folder
|
||||
- **Important:** Check "Create folder references" (NOT "Create groups")
|
||||
- Click "Add"
|
||||
|
||||
2. **Configure the help book in build settings:**
|
||||
- Select your oAI target in Xcode
|
||||
- Go to the "Info" tab
|
||||
- Add a new key: `CFBundleHelpBookName` with value: `oAI Help`
|
||||
- Add another key: `CFBundleHelpBookFolder` with value: `oAI.help`
|
||||
|
||||
3. **Build and test:**
|
||||
- Build the app (⌘B)
|
||||
- Run the app (⌘R)
|
||||
- Press ⌘? or select Help → oAI Help to open the help
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
oAI.help/
|
||||
├── Contents/
|
||||
│ ├── Info.plist # Help book metadata
|
||||
│ └── Resources/
|
||||
│ └── en.lproj/
|
||||
│ ├── index.html # Main help page
|
||||
│ └── styles.css # Stylesheet
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- ✅ Comprehensive coverage of all oAI features
|
||||
- ✅ Searchable via macOS Help menu search
|
||||
- ✅ Dark mode support
|
||||
- ✅ Organized by topic with table of contents
|
||||
- ✅ Keyboard shortcuts reference
|
||||
- ✅ Command reference with examples
|
||||
- ✅ Follows Apple Human Interface Guidelines
|
||||
|
||||
## Customization
|
||||
|
||||
To update the help content:
|
||||
1. Edit `Contents/Resources/en.lproj/index.html`
|
||||
2. Update styles in `Contents/Resources/en.lproj/styles.css`
|
||||
3. Rebuild the app
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If help doesn't open:
|
||||
- Make sure you added the folder as a "folder reference" (blue folder icon in Xcode)
|
||||
- Check that `CFBundleHelpBookName` and `CFBundleHelpBookFolder` are set in Info
|
||||
- Clean build folder (⇧⌘K) and rebuild
|
||||
|
||||
## Adding More Pages
|
||||
|
||||
To add additional help pages:
|
||||
1. Create new HTML files in `Contents/Resources/en.lproj/`
|
||||
2. Link to them from `index.html`
|
||||
3. Include proper meta tags for searchability:
|
||||
```html
|
||||
<meta name="AppleTitle" content="Page Title">
|
||||
<meta name="keywords" content="keyword1, keyword2">
|
||||
```
|
||||
Reference in New Issue
Block a user