Files

T

rune 854fd02fad Add live search to the Help Book's table of contents

A search box above the Contents list filters TOC entries by each
linked section's full text content (not just the link title), so
e.g. searching "european" surfaces "Slash Commands" via its command
history date-format note. Pure vanilla JS/CSS, no dependencies --
the page is a static file opened directly in the default browser.

Tested interactively in Safari Technology Preview: filtering,
no-results state, reset, and click-through navigation all verified
working, in both the matched and empty-query cases.

2026-07-22 15:21:30 +02:00

Contents

Add live search to the Help Book's table of contents

2026-07-22 15:21:30 +02:00

README.md

Bug gixes, features added, GUI updates and more

2026-02-12 14:29:35 +01:00

README.md

oAI Help Book

This folder contains the Apple Help Book for oAI.

Adding to Xcode Project

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"
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
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:

Edit Contents/Resources/en.lproj/index.html
Update styles in Contents/Resources/en.lproj/styles.css
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:

Create new HTML files in Contents/Resources/en.lproj/
Link to them from index.html

Include proper meta tags for searchability:

<meta name="AppleTitle" content="Page Title">
<meta name="keywords" content="keyword1, keyword2">