Skip to content

Commit

Permalink
Custom Documentaion Documentaion (#158)
Browse files Browse the repository at this point in the history
* draft of custom doc doc

* Custom Documentation Documentation

* remove .vscode/settings.json

* add .vscode to .gitignore
  • Loading branch information
BrokenGravityMusic authored Sep 18, 2024
1 parent ef7339d commit 296c7dc
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
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

0 comments on commit 296c7dc

Please sign in to comment.