Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom Documentaion Documentaion #158

Merged
merged 5 commits into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ dep/
cmake-build*
ignore/
minst.sh
.vscode/
25 changes: 25 additions & 0 deletions doc/manualdaw.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,31 @@ effect. The default collection ("Recommended") contains Chris's greatest hits.
To select a collection other than "Recommended", choose the "Filter by Collections"
menu and select a collection you want. "All plugins" choice removes any filtering.

## Custom Documentation

You can add user-defined documentation to the existing effect documentation by placing .txt files in the 'customDocs' directory. When switching effects in the UI, the plugin loads `customDocs/<effect-name>.txt` (if present) and prepends it with a separator before the original text. For example, to add documentation to the effect `ToTape7`:

- Choose "Show Config Dir" from the menu to navigate to the config directory.
- Create the file `customDocs/ToTape7.txt`.
- Add "This is my own text" to the file and save.
- In the plugin UI, switch away from the ToTape7 effect, then switch back. This forces the text to reload.

You'll now see:

```
This is my own text

#----------------------

This is the original text...
```

Note:

- Filename casing is important on Linux (and sometimes on Mac). Use `ToTape7.txt`, not `totape7.TXT`.



## Using a Screen Reader

The User Interface is exposed via a Screen Reader on macOS and Windows.
Expand Down
Loading