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

Restructure part1 (focusing on the quickstart menu) #317

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion docs/Basic Usage/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If the same setting is defined multiple times, Talon will use the setting value
| insert_wait | 0 | Increase this if characters seem to be jumbled in a specific app when typing whole sentences. Default is 0. |
| 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. |
| 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. |
| 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'. |
| 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'. |
| 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. |

To add your own additional custom settings for changing Talon behavior, see [the settings customization page](../Customization/Talon%20Framework/settings.md)
2 changes: 1 addition & 1 deletion docs/Customization/basic_customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Basic customization

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.
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.

## Customization overview

Expand Down
6 changes: 3 additions & 3 deletions docs/Quickstart/FAQ.md → docs/Help/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ Talon does not require special configuration for different programming languages

### What hardware should I have?

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

### Are languages other than English supported?

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.

### How can I make talon recognise me better?

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

### How can I contribute?

Expand All @@ -35,4 +35,4 @@ While Talon is closed source, there's plenty you can do to help:

### Troubleshooting

Checkout the [troubleshooting](troubleshooting) for solutions to common problems.
Checkout the [troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) for solutions to common problems.
File renamed without changes.
11 changes: 11 additions & 0 deletions docs/Help/talon-slack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Talon Slack

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.

A few notable channels:

- `#help`: get help with Talon setup, usage, or ask questions about Talon
- `#beta`: find beta download links and ask questions specific to the beta (this is a private channel that requires a patreon donation)
- `#health`: chat with others about computer health issues, share knowledge, find other folks who might be going through similar things
- `#talon-docs`: chat about Talon documentation such as this wiki
- `#hardware`: chat about hardware, e.g., microphones
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# Non-Visual Use
---
sidebar_position: 10
---

# Accessibility

## Non-Visual Use

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

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.

## How to get started
### How to get started

- Setup Talon according to the standard [quickstart](../getting_started.md)
- Install Talon
- Install a speech recognition engine
- Setup Talon as per normal:
- [Install Talon](../Resource%20Hub/Talon%20Installation/installation_guide) and a speech recognition engine
- Install the [community user file set](https://github.com/talonhub/community)
- 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.
- See the documentation in that repo for specific setup instructions

## Limitations
### Limitations

- Certain windows produced by Talon's imgui library, like those from the `help scope` command are not accessible.
4 changes: 4 additions & 0 deletions docs/Integrations/essential-tools.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 1
---

# Essential Talon Integrations

| Software | Description |
Expand Down
1 change: 0 additions & 1 deletion docs/Quickstart/Accessibility/_category_.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/Quickstart/Speech Engines/_category_.yml

This file was deleted.

47 changes: 0 additions & 47 deletions docs/Quickstart/getting_started.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Windows default drivers have a limitation and that they _cannot_ record and play
Check out the `#eye-tracking` channel in Slack, and the [Tobii 4c Tips](tobii_4c) page.

- Tobii 4C is a commonly used and recommended eye tracker, but it is slowly being superceded as the default as more folks are starting to use the Tobii 5. Talon also supports the Tobii PCEye Mini. Support for most 4th gen Tobii devices can be trivially added.
- [Tobii 5](https://gaming.tobii.com/product/eye-tracker-5/) is the newer model and may be easier to find than the 4C. This one does require a one-time initialization on a Windows PC with the Tobii software installed. Check out the dedicated [Tobii 5 page](../Hardware/tobii_5.md).
- [Tobii 5](https://gaming.tobii.com/product/eye-tracker-5/) is the newer model and may be easier to find than the 4C. This one does require a one-time initialization on a Windows PC with the Tobii software installed. Check out the dedicated [Tobii 5 page](tobii_5).

### Windows Login plus Talon

Expand Down
11 changes: 11 additions & 0 deletions docs/Resource Hub/Hardware/os.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Operating System

:::info talon-scope-platform

:::

| System | Requirement |
| ------------- | -------------------------------------------------------------------------------------------- |
| `macOS` | High Sierra (10.13) or newer. Talon is a universal2 build with native Apple Silicon support. |
| `Linux / X11` | (Ubuntu 18.04+, and most modern distros), Wayland support is currently limited to XWayland |
| `Windows` | Windows 8 or newer |
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Regardless of which OS you will be using when you use your eye tracker, the init

### Next steps

The [Tobii 4c tips](../Hardware/tobii_4c.md) page has detailed instructions on how to adjust your environment and behaviour to get a better eye tracking experience.
The [Tobii 4c tips](../Hardware/tobii_4c) page has detailed instructions on how to adjust your environment and behaviour to get a better eye tracking experience.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A quiet room will always be better than a noisy one. A good microphone can mitig

## Microphone

Make sure that you have a good microphone and sound card, as speech recognition software requires better hardware than is commonly built in to computers. Have a look at the [hardware page](./Hardware/hardware.md) for recommendations and correct setup.
Make sure that you have a good microphone and sound card, as speech recognition software requires better hardware than is commonly built in to computers. Have a look at the [hardware page](/docs/Resource%20Hub/Hardware/hardware.md) for recommendations and correct setup.

## Keep a relaxed voice

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_position: 1

# Speech Engines

:::info talon-scope-platform

:::

Talon uses a speech recognition engine that translates voice audio to text. The Conformer speech engine is recommended, but it is possible to use Talon with other speech engines, for example, if you already use Dragon and want to use Talon with Dragon or need a speech engine with language support other than English.

| Engine | OS | Description | Installation | Price |
Expand All @@ -20,7 +24,7 @@ The Professional version of Dragon for Windows is recommended (but not strictly

### Dictation Engines for Additional Language Support

As of April 2024, Talon's main conformer model only supports English. If you need to dictate text in another language, the [Talon Beta](../beta_talon) supports the following options:
As of April 2024, Talon's main conformer model only supports English. If you need to dictate text in another language, the [Talon Beta](../../Help/beta_talon) supports the following options:

| Engine | Platform | Description | Requirements |
| --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 7

## Nothing Happens When I Speak

If you are testing your setup with one of the [basic commands](../Basic%20Usage/basic_usage) and getting no response at all, first check a few fundamentals to help focus the troubleshooting. There are a number of issues at different layers of the setup that could be causing the problem. Your first few steps should help narrow the focus.
If you are testing your setup with one of the [basic commands](../../Basic%20Usage/basic_usage) and getting no response at all, first check a few fundamentals to help focus the troubleshooting. There are a number of issues at different layers of the setup that could be causing the problem. Your first few steps should help narrow the focus.

### Check Your Microphone

Expand Down Expand Up @@ -55,7 +55,7 @@ Talon's icon should show up in the menu bar in the upper right corner of your sc

### Check that Talon is Awake

When Talon is running, it will be in one of a few different [modes](../Basic%20Usage/basic_usage). One of these modes is a `sleep` mode, which will put Talon in a dormant state where it is listening but not responding to commands. While asleep, Talon will only respond to a minimal set of commands, such as `talon wake`, which will put Talon out of sleep and enable Talon to respond to commands.
When Talon is running, it will be in one of a few different [modes](../../Basic%20Usage/basic_usage). One of these modes is a `sleep` mode, which will put Talon in a dormant state where it is listening but not responding to commands. While asleep, Talon will only respond to a minimal set of commands, such as `talon wake`, which will put Talon out of sleep and enable Talon to respond to commands.

If you are trying to use Talon commands and Talon is not responding, make sure Talon is not in sleep mode. The Talon icon in the menubar provides some visual cue as to what mode Talon is in:

Expand Down Expand Up @@ -133,7 +133,7 @@ Check that your speech engine has been initialized by looking in the [talon log

### Check your Talon user file sets

Check you have some valid commands in `~/.talon/user`. If it's empty, install the [Talon Community](https://github.com/talonhub/community) user file set and test with some [basic commands](../Basic%20Usage/basic_usage). Install the entire repository, not just individual files. This user file set can be combined with other Talon user file sets, though it is common that most of the functionality will be provided by [Talon Community](https://github.com/talonhub/community). Additional file sets are commonly used to customize the default behavior provided by [Talon Community](https://github.com/talonhub/community) or add additional features not already included.
Check you have some valid commands in `~/.talon/user`. If it's empty, install the [Talon Community](https://github.com/talonhub/community) user file set and test with some [basic commands](../../Basic%20Usage/basic_usage). Install the entire repository, not just individual files. This user file set can be combined with other Talon user file sets, though it is common that most of the functionality will be provided by [Talon Community](https://github.com/talonhub/community). Additional file sets are commonly used to customize the default behavior provided by [Talon Community](https://github.com/talonhub/community) or add additional features not already included.

Talon automatically tracks changes to files in `~/.talon/user`, so that one can change scripts on the fly. This breaks if `~/.talon` (or any other part of the path) is a symlink.

Expand Down
Loading