44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# The Dictionary
|
|
|
|
Cagire includes a built-in dictionary of all the internal Forth words. Press `Ctrl+Up` to reach the **Dict** view.
|
|
|
|
## Using the Dictionary
|
|
|
|
The dictionary shows every available word organized by category:
|
|
|
|
- **Stack**: Manipulation words like `dup`, `swap`, `drop`
|
|
- **Arithmetic**: Math operations
|
|
- **Sound**: Sound sources and emission
|
|
- **Filter**, **Envelope**, **Effects**: Sound shaping
|
|
- **Context**: Sequencer state like `step`, `beat`, `tempo`
|
|
- And many more...
|
|
|
|
## Navigation
|
|
|
|
| Key | Action |
|
|
|-----|--------|
|
|
| `Tab` | Switch between categories and words |
|
|
| `↑/↓` or `j/k` | Navigate items |
|
|
| `PgUp/PgDn` | Page through lists |
|
|
| `/` or `Ctrl+F` | Search |
|
|
| `Esc` | Clear search |
|
|
|
|
## Word Information
|
|
|
|
Each word entry shows:
|
|
|
|
- **Name** and aliases
|
|
- **Stack effect**: `( before -- after )`
|
|
- **Description**: What the word does
|
|
- **Example**: How to use it
|
|
|
|
## Search
|
|
|
|
Press `/` to search across all words. The search matches word names, aliases, and descriptions. Press `Esc` to clear and return to browsing.
|
|
|
|
## Tips
|
|
|
|
- Use the dictionary while writing scripts to check stack effects
|
|
- Categories group related words together
|
|
- Some words have shorter aliases (e.g., `sound` → `s`)
|