Skip to content

Commit 13c94bd

Browse files
authored
Merge pull request #317 from ronzulu/restructure-part1
Restructure part1 (focusing on the quickstart menu)
2 parents 8886857 + 286611d commit 13c94bd

39 files changed

+1800
-245
lines changed

docs/Basic Usage/basic_usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To keep track of what mode you are in with a visual icon, enable the [mode indic
3131
| `help next`, `help previous` | go to the next or previous page of help items if there are a lot |
3232
| `help close` | hide any open help window again |
3333
| `command history` | show the command history |
34-
| `talon open log` | open the talon log for debugging |
34+
| `talon open log` | open the Talon log for debugging |
3535

3636
## Dictating Text
3737

@@ -102,9 +102,9 @@ These commands will open up a CSV or [Talon list](Customization/talon_lists.md)
102102
| Command | Description |
103103
| -------------- | ------------------------------------------------------------------------- |
104104
| `copy that` | |
105-
| `control cap` | copy via the keyboard shortcut using the talon alphabet (`cap` for `c`) |
105+
| `control cap` | copy via the keyboard shortcut using the Talon alphabet (`cap` for `c`) |
106106
| `paste that` | |
107-
| `control vest` | paste via the keyboard shortcut using the talon alphabet (`vest` for `v`) |
107+
| `control vest` | paste via the keyboard shortcut using the Talon alphabet (`vest` for `v`) |
108108
| `cut that` | |
109109
| `undo that` | |
110110
| `redo that` | |

docs/Basic Usage/settings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Talon's behavior can be changed by changing the value of settings within a `.talon` file inside a `settings():` block.
44

55
```talon
6-
# Example talon file
6+
# Example Talon file
77
settings():
88
# Enable the Talon mode indicator
99
user.mode_indicator_show = true
@@ -49,11 +49,11 @@ If the same setting is defined multiple times, Talon will use the setting value
4949
| Setting | Example Value | Description |
5050
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5151
| imgui.scale | 1.5 | Adjust the scale of the imgui windows |
52-
| imgui.dark_mode | false | If `true` enable dark mode for talon imgui menus (used for help menus in community) |
52+
| imgui.dark_mode | false | If `true` enable dark mode for Talon imgui menus (used for help menus in community) |
5353
| insert_wait | 0 | Increase this if characters seem to be jumbled in a specific app when typing whole sentences. Default is 0. |
5454
| key_hold | 16 | Increase this if you're playing a game and some keys aren't registering at all. You should probably increase it in 16ms increments, e.g. set it to 16ms or 32ms. |
5555
| key_wait | 1 | Increase this if modifier keys are getting dropped or if key presses are misbehaving even with the other two settings (`insert_wait` and `key_hold`) tuned. `key_wait` should be the last resort because it results in the slowest overall keypress rate. Default is 1.0 in milliseconds. |
56-
| speech.engine | | Determines which [speech engine](../Quickstart/Speech%20Engines/speech%20engines.md) talon uses to recognize input. This is useful for configuring dictation mode to use a different speech engine; for example, 'webspeech'. |
56+
| speech.engine | | Determines which [speech engine](../Resource%20Hub/Speech%20Recognition/speech%20engines.md) Talon uses to recognize input. This is useful for configuring dictation mode to use a different speech engine; for example, 'webspeech'. |
5757
| speech.timeout | | This determines how long a pause Talon waits for before deciding you've finished speaking and interpreting what you've just said as a sequence of commands. This parameter is generally very important; for example, it determines the amount of time you can pause between saying 'phrase' and the following phrase. It is measured in seconds; the default is 0.300, i.e. 300 milliseconds. |
5858

5959
To add your own additional custom settings for changing Talon behavior, see [the settings customization page](../Customization/Talon%20Framework/settings.md)

docs/Customization/Talon Framework/lists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Because list contents can only be replaced in their entirety, end users can have
5656

5757
### Dynamic Lists
5858

59-
Dynamic lists are an advanced Talon feature that as of Talon 0.4 are currently **beta-only**. They are used for generating lists of items for voice commands at runtime. For example, you can use dynamic lists to create voice commands specific to the names of elements currently on the screen. Without dynamic lists you would otherwise have to poll and constantly update a normal talon list. Dynamic lists can also return [selection lists](#selection-lists) to dynamically match voice commands to substrings.
59+
Dynamic lists are an advanced Talon feature that as of Talon 0.4 are currently **beta-only**. They are used for generating lists of items for voice commands at runtime. For example, you can use dynamic lists to create voice commands specific to the names of elements currently on the screen. Without dynamic lists you would otherwise have to poll and constantly update a normal Talon list. Dynamic lists can also return [selection lists](#selection-lists) to dynamically match voice commands to substrings.
6060

6161
If you do not need the list to be constructed during the voice command, you should use a regular Talon list instead.
6262

docs/Customization/basic_customization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 1
44

55
# Basic customization
66

7-
Once you have successfully [set up Talon](../Quickstart/getting_started.md) you may find that you would like to change some of how it behaves at a basic level.
7+
Once you have successfully [set up Talon](../Resource%20Hub/Talon%20Installation/installation_guide) you may find that you would like to change some of how it behaves at a basic level.
88

99
## Customization overview
1010

@@ -164,7 +164,7 @@ You might have noticed that we've been using the key() and insert() actions in t
164164

165165
1. Right click on the Talon icon in your status bar, choose scripting, and then 'Console (REPL)'. This will open a terminal window where you type Python commands and the results of those commands are printed out.
166166
2. Type `actions.list()` and press enter. This will list out all the available actions.
167-
3. You might like to look at this list of actions in your text editor (so you can search them, for example). To put the full list into your clipboard, copy and paste this code into the talon console and press enter:
167+
3. You might like to look at this list of actions in your text editor (so you can search them, for example). To put the full list into your clipboard, copy and paste this code into the Talon console and press enter:
168168

169169
```python
170170
import io;old=sys.stdout;sys.stdout = io.StringIO();actions.list();clip.set_text(sys.stdout.getvalue());sys.stdout = old

docs/Customization/talon-files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# `.talon` Files
66

7-
The primary way to extend talon is using `.talon` files placed anywherein the `user` directory. A talon file comes in two parts
7+
The primary way to extend Talon is using `.talon` files placed anywhere in the `user` directory. A Talon file comes in two parts:
88

99
- A [context header](#context-header) defining the circumstances in which the file is active
1010
- A body that implements various behaviors within that context which can:
@@ -55,7 +55,7 @@ The following requirements can be set:
5555
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5656
| `os` | require specific operating systems; currently either `linux`, `mac`, or `windows` |
5757
| `tag` | require a specific tag |
58-
| `mode` | only active for specific talon modes (like `command`, `dictation`, `sleep` et al.) |
58+
| `mode` | only active for specific Talon modes (like `command`, `dictation`, `sleep` et al.) |
5959
| `app` | match applications by explicitly declared, well-known name |
6060
| `app.name` | match applications by name (TODO where does Talon read this out?) |
6161
| `app.exe` | match applications by executable, like `/usr/lib/firefox/firefox` or `firefox.exe` |

docs/Quickstart/FAQ.md renamed to docs/Help/FAQ.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,25 @@ Talon does not require special configuration for different programming languages
1414

1515
### What hardware should I have?
1616

17-
Check out the [hardware](./Hardware/hardware.md) page for microphone and eye tracker recommendations.
17+
Check out the [hardware](../Resource%20Hub/Hardware/hardware.md) page for microphone and eye tracker recommendations.
1818

1919
### Are languages other than English supported?
2020

2121
They're being worked on, join [Talon Slack](https://talonvoice.com/chat) and find a channel for your language to see how it's going. If you are in the beta program, you can configure the WebSpeech API for dictation in other languages.
2222

23-
### How can I make talon recognise me better?
23+
### How can I make Talon recognise me better?
2424

25-
See the page [Improving Recognition Accuracy](improving_recognition_accuracy).
25+
See the page [Improving Recognition Accuracy](../Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy).
2626

2727
### How can I contribute?
2828

2929
While Talon is closed source, there's plenty you can do to help:
3030

3131
- https://speech.talonvoice.com/ Extend the voice data set used for speech recognition training.
32-
- Publish your talon commands on Github for others to share. Consider contributing back to the [Talon Community](https://github.com/talonhub/community) user file set. Publicly shared file sets are [searchable using this search engine](https://search.talonvoice.com/search/).
32+
- Publish your Talon commands on Github for others to share. Consider contributing back to the [Talon Community](https://github.com/talonhub/community) user file set. Publicly shared file sets are [searchable using this search engine](https://search.talonvoice.com/search/).
3333
- Report issues at https://github.com/talonvoice/talon/issues
3434
- Add more to these docs :)
3535

3636
### Troubleshooting
3737

38-
Checkout the [troubleshooting](troubleshooting) for solutions to common problems.
38+
The [Troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) page includes solutions to common problems.
File renamed without changes.

docs/Help/talon-slack.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Talon Slack
2+
3+
Talon has a Slack community for users to get help, ask questions, and meet one another. If you are starting to use Talon, join the [Talon Slack](https://talonvoice.com/chat). This is the most efficient way to get questions answered if they are not covered in this wiki. There are also a few general channels, like `#health`, for those looking for resources and other folks who might be navigating complex injuries like RSI (Repetitive Strain Injuries) from typing.
4+
5+
A few notable channels:
6+
7+
- `#help`: get help with Talon setup, usage, or ask questions about Talon
8+
- `#beta`: find beta download links and ask questions specific to the beta (this is a private channel that requires a [Patreon donation](https://www.patreon.com/join/lunixbochs))
9+
- `#health`: chat with others about computer health issues, share knowledge, find other folks who might be going through similar things
10+
- `#talon-docs`: chat about Talon documentation such as this wiki
11+
- `#hardware`: chat about hardware, e.g., microphones
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
1-
# Non-Visual Use
1+
---
2+
sidebar_position: 10
3+
---
4+
5+
# Accessibility
6+
7+
## Non-Visual Use
28

39
Although Talon is not explicitly designed for non-visual use, it can still be used well alongside screen readers or other assistive technology.
410

511
Please note that Talon is in rapid development and is largely community supported. If you have issues, please join the [community slack](https://talonvoice.com/chat) and let someone know.
612

7-
## How to get started
13+
### How to get started
814

9-
- Setup Talon according to the standard [quickstart](../getting_started.md)
10-
- Install Talon
11-
- Install a speech recognition engine
15+
- Setup Talon as per normal:
16+
- [Install Talon](../Resource%20Hub/Talon%20Installation/installation_guide) and a speech recognition engine
1217
- Install the [community user file set](https://github.com/talonhub/community)
1318
- Once setup, install [sight-free-talon](https://github.com/C-Loftus/sight-free-talon). This repository provides text-to-speech integration for Talon. If you use a screen reader, this repo prevents Talon from interrupting the text-to-speech voice as it types characters during dictation.
1419
- See the documentation in that repo for specific setup instructions
1520

16-
## Limitations
21+
### Limitations
1722

1823
- Certain windows produced by Talon's imgui library, like those from the `help scope` command are not accessible.

docs/Integrations/essential-tools.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
15
# Essential Talon Integrations
26

37
| Software | Description |

0 commit comments

Comments
 (0)