Skip to content

Restructure part1 (focusing on the quickstart menu) #317

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

Merged
merged 26 commits into from
Apr 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
12f1126
moved some image files to under a new folder under img, etc
ronzulu Mar 6, 2025
9cd8292
Added mermaid mind map to homepage
ronzulu Mar 6, 2025
9200a6c
Added help menu with a page on talon slack
ronzulu Mar 6, 2025
8855330
Update the getting started page, and move the appropriate linked file…
ronzulu Mar 6, 2025
b0a259a
Moved the nonvisual use page from quick start to the integrations menu
ronzulu Mar 6, 2025
6397410
Moved the "Using Talon with Nix" page to under the resource hub menu
ronzulu Mar 6, 2025
c997d81
Moved the last remaining page from quick start (installation guide) t…
ronzulu Mar 6, 2025
06ac0e7
Fixed various document links, include custom platform/ community admo…
ronzulu Mar 7, 2025
ff98537
some minor fixes
ronzulu Mar 7, 2025
6f35227
minor change
ronzulu Mar 7, 2025
3bb8040
Removed unnecessary "admonitions" definition that was temporarily add…
ronzulu Mar 7, 2025
132ddda
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 7, 2025
3de19bd
Added info about using a git GUI application
ronzulu Mar 24, 2025
bccb547
Added info about using a git GUI application
ronzulu Mar 24, 2025
5280500
Added suggestion of backing up the talon user directory
ronzulu Mar 24, 2025
0884272
Removed announcement bar message regarding experimental version
ronzulu Mar 24, 2025
579cc52
Standardized the capitalization of "Talon"
ronzulu Mar 24, 2025
f13530b
Merge branch 'restructure-part1' of https://github.com/ronzulu/talon-…
ronzulu Mar 24, 2025
09213f8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 24, 2025
ebbc122
Remove duplicate /
nriley Apr 19, 2025
5cae336
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 19, 2025
b375735
A couple more capitalization fixes and a typo fix
nriley Apr 19, 2025
c9f869f
Update docs/Help/FAQ.md
nriley Apr 19, 2025
1260834
Fix capitalization
nriley Apr 19, 2025
37dd3a6
Link to Patreon donation page.
nriley Apr 19, 2025
286611d
Improve wording
nriley Apr 19, 2025
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
6 changes: 3 additions & 3 deletions docs/Basic Usage/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To keep track of what mode you are in with a visual icon, enable the [mode indic
| `help next`, `help previous` | go to the next or previous page of help items if there are a lot |
| `help close` | hide any open help window again |
| `command history` | show the command history |
| `talon open log` | open the talon log for debugging |
| `talon open log` | open the Talon log for debugging |

## Dictating Text

Expand Down Expand Up @@ -102,9 +102,9 @@ These commands will open up a CSV or [Talon list](Customization/talon_lists.md)
| Command | Description |
| -------------- | ------------------------------------------------------------------------- |
| `copy that` | |
| `control cap` | copy via the keyboard shortcut using the talon alphabet (`cap` for `c`) |
| `control cap` | copy via the keyboard shortcut using the Talon alphabet (`cap` for `c`) |
| `paste that` | |
| `control vest` | paste via the keyboard shortcut using the talon alphabet (`vest` for `v`) |
| `control vest` | paste via the keyboard shortcut using the Talon alphabet (`vest` for `v`) |
| `cut that` | |
| `undo that` | |
| `redo that` | |
Expand Down
6 changes: 3 additions & 3 deletions docs/Basic Usage/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Talon's behavior can be changed by changing the value of settings within a `.talon` file inside a `settings():` block.

```talon
# Example talon file
# Example Talon file
settings():
# Enable the Talon mode indicator
user.mode_indicator_show = true
Expand Down Expand Up @@ -49,11 +49,11 @@ If the same setting is defined multiple times, Talon will use the setting value
| Setting | Example Value | Description |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| imgui.scale | 1.5 | Adjust the scale of the imgui windows |
| imgui.dark_mode | false | If `true` enable dark mode for talon imgui menus (used for help menus in community) |
| imgui.dark_mode | false | If `true` enable dark mode for Talon imgui menus (used for help menus in community) |
| 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/Talon Framework/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Because list contents can only be replaced in their entirety, end users can have

### Dynamic Lists

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

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

Expand Down
4 changes: 2 additions & 2 deletions 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 Expand Up @@ -164,7 +164,7 @@ You might have noticed that we've been using the key() and insert() actions in t

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.
2. Type `actions.list()` and press enter. This will list out all the available actions.
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:
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:

```python
import io;old=sys.stdout;sys.stdout = io.StringIO();actions.list();clip.set_text(sys.stdout.getvalue());sys.stdout = old
Expand Down
4 changes: 2 additions & 2 deletions docs/Customization/talon-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2

# `.talon` Files

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

- A [context header](#context-header) defining the circumstances in which the file is active
- A body that implements various behaviors within that context which can:
Expand Down Expand Up @@ -55,7 +55,7 @@ The following requirements can be set:
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `os` | require specific operating systems; currently either `linux`, `mac`, or `windows` |
| `tag` | require a specific tag |
| `mode` | only active for specific talon modes (like `command`, `dictation`, `sleep` et al.) |
| `mode` | only active for specific Talon modes (like `command`, `dictation`, `sleep` et al.) |
| `app` | match applications by explicitly declared, well-known name |
| `app.name` | match applications by name (TODO where does Talon read this out?) |
| `app.exe` | match applications by executable, like `/usr/lib/firefox/firefox` or `firefox.exe` |
Expand Down
10 changes: 5 additions & 5 deletions docs/Quickstart/FAQ.md → docs/Help/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,25 @@ 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](../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?
### 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?

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

- https://speech.talonvoice.com/ Extend the voice data set used for speech recognition training.
- 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/).
- 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/).
- Report issues at https://github.com/talonvoice/talon/issues
- Add more to these docs :)

### Troubleshooting

Checkout the [troubleshooting](troubleshooting) for solutions to common problems.
The [Troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) page includes 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](https://www.patreon.com/join/lunixbochs))
- `#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
4 changes: 2 additions & 2 deletions docs/Integrations/talon_related_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ These videos/channels demonstrate some of the possibilities of Talon without rea
- [Ryan's Eye Tracking Demo](https://youtu.be/VMNsU7rrjRI) Demonstration of mouse control using eye tracking and Zoom mouse.
- [2Shea's Emoji Searching Demo](https://youtu.be/RA0idiJkZOg) Experienced user of Talon dictating code
- [2Shea's Mojolicious Perl App using Talon](https://youtu.be/X6rsA0Svh2M) More experienced code dictation
- [talon rpi ether local w2l](https://youtu.be/PK6G1foW2Ao) Using Talon on a tablet. Channel has several videos.
- [Talon rpi ether local w2l](https://youtu.be/PK6G1foW2Ao) Using Talon on a tablet. Channel has several videos.

## Text based educational resources

- [Matt's Visual TalonScript Builder](https://visual-talonscript.pages.dev) This is a web application that helps you build custom Talon commands with a visual interface.
- [Guenther Schmitz's Wiki of Talon configuations, issues, and solutions.](https://wiki.gpunktschmitz.com/index.php/Talon) This list contains a grab-bag of various configurations, answers to questioms, and solutions. Well worth looking at.
- [chaosparrot's talon practice website:](https://chaosparrot.github.io/talon_practice) a website with games and lessions to help you practice basic Talon commands.
- [chaosparrot's Talon practice website:](https://chaosparrot.github.io/talon_practice) a website with games and lessions to help you practice basic Talon commands.
- [Xevs web-based Talon Cheatsheet](https://talon-knausj-cheatsheet.netlify.app/) An online way to look up commands.
- [Stolen Sugar](https://www.stolensugar.com/) Explore alternative keywords for commands in the [Talon Community](https://github.com/talonhub/community) user file set.
2 changes: 1 addition & 1 deletion docs/Integrations/talon_user_file_sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The main Talon user file set for Talon is [Talon Community](https://github.com/t

If intended for public consumption, these Talon user file sets are mostly annouced via the [Slack channel](https://talonvoice.com/chat). Aside from that there are a few ways you can discover them:

- You can make use of the [talon code search](https://search.talonvoice.com/search/). This aims to search all known github repositories containing Talon related code. If you're looking for integration with a particular application this is a good option.
- You can make use of the [Talon code search](https://search.talonvoice.com/search/). This aims to search all known github repositories containing Talon related code. If you're looking for integration with a particular application this is a good option.
- You can browse the [github talonvoice topic](https://github.com/topics/talonvoice). Repositories can optionally tag themselves with this to aid discoverability.
- You can take a look at the manually curated list below.

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.

Loading