+
+### Advanced Users
+
+If you are an advanced user and have decided to install a different user file set, then not all parts
+of this wiki is relevant. Those that are will be highlighted as follows.
+
+
+
+ [SCOPE]: TALON PLATFORM
+
+
+
+
+---
+
## Goal of this Wiki
The goal of this wiki is to provide information and documentation for the users of Talon. As the software is under rapid development, this wiki is in a constant state of "work in progress". Some of this content exists temporarily until the official Talon Docs are created.
+---
+
## Wiki Navigation
-| If you are looking for: | See: |
-| ------------------------------------------------- | --------------------------------------------------------- |
-| Information on getting started with Talon | [Getting Started](/Quickstart/getting_started) |
-| How to customize Talon | [Basic Customization](/Customization/basic_customization) |
-| Troubleshooting help | [Troubleshooting](/Quickstart/troubleshooting) |
-| Help with deciding on a microphone or eye tracker | [Hardware](/Quickstart/Hardware) |
-| Videos of Talon in use | [Video Demos](/Integrations/talon_related_resources) |
-| Answers to frequently asked questions | [FAQ](/Quickstart/FAQ) |
+| If you are looking for: | See: |
+| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| Videos of Talon in use | [Video Demos](/Resource%20Hub/talon_related_resources) |
+| Help with deciding on a microphone or eye tracker | [Hardware](/Resource%20Hub/Hardware) |
+| Installing and getting started with Talon | [Installing Talon](/Resource%20Hub/Talon%20Installation/installation_guide), [Getting Started](/Basic%20Usage/basic_usage) |
+| How to customize Talon, obtaining additional functionality | [Basic Customization](/Customization/overview), [Integrations](/Integrations) |
+| Troubleshooting help | [Troubleshooting](/Resource%20Hub/Troubleshooting/basic-issues) |
+| Answers to frequently asked questions | [FAQ](/Help/FAQ) |
-## Talon Slack
+:::tip 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.
+Talon has a [Slack community](/Help/talon-slack) for users to get help, ask questions, and meet one another. This is the most efficient way to get questions answered if they are not covered in this wiki.
-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
+---
# Contributing
From 9200a6c34cf027489a8e884226c21c4ce9ed6743 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Thu, 6 Mar 2025 23:02:00 +1100
Subject: [PATCH 03/25] Added help menu with a page on talon slack
---
docs/Help/talon-slack.md | 11 +++++++++++
docusaurus.config.ts | 6 ++++++
sidebars.ts | 6 ++++++
3 files changed, 23 insertions(+)
create mode 100644 docs/Help/talon-slack.md
diff --git a/docs/Help/talon-slack.md b/docs/Help/talon-slack.md
new file mode 100644
index 00000000..ff4236c9
--- /dev/null
+++ b/docs/Help/talon-slack.md
@@ -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
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index add58c07..7341a9ad 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -148,6 +148,12 @@ const config: Config = {
position: "left",
label: "Integrations",
},
+ {
+ type: "docSidebar",
+ sidebarId: "HelpSidebar",
+ position: "left",
+ label: "Help",
+ },
{
href: "https://github.com/TalonCommunity/Wiki/",
label: "GitHub",
diff --git a/sidebars.ts b/sidebars.ts
index 0ab456ab..9cd63345 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -25,6 +25,12 @@ const sidebars: SidebarsConfig = {
dirName: "Integrations",
},
],
+ HelpSidebar: [
+ {
+ type: "autogenerated",
+ dirName: "Help",
+ },
+ ],
};
export default sidebars;
From 88553302c626183899ef04ee5d3580e768fde3f1 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:02:09 +1100
Subject: [PATCH 04/25] Update the getting started page, and move the
appropriate linked files to under the new resource hub and help menus
---
docs/{Quickstart => Help}/FAQ.md | 2 +-
docs/{Quickstart => Help}/beta_talon.md | 0
docs/Quickstart/getting_started.md | 124 ++++++++++++++----
.../Hardware/_category_.yml | 0
.../Hardware/hardware.md | 2 +-
.../Hardware/tobii_4c.md | 0
.../Hardware/tobii_5.md | 2 +-
...Linux-or-Mac-Talon-Using-Windows-Dragon.md | 0
.../improving_recognition_accuracy.md | 2 +-
.../Speech Recognition}/speech engines.md | 0
.../Speech Recognition}/troubleshooting.md | 0
.../downloading-community.md | 95 ++++++++++++++
docusaurus.config.ts | 12 ++
sidebars.ts | 6 +
14 files changed, 217 insertions(+), 28 deletions(-)
rename docs/{Quickstart => Help}/FAQ.md (93%)
rename docs/{Quickstart => Help}/beta_talon.md (100%)
rename docs/{Quickstart => Resource Hub}/Hardware/_category_.yml (100%)
rename docs/{Quickstart => Resource Hub}/Hardware/hardware.md (99%)
rename docs/{Quickstart => Resource Hub}/Hardware/tobii_4c.md (100%)
rename docs/{Quickstart => Resource Hub}/Hardware/tobii_5.md (93%)
rename docs/{Quickstart/Speech Engines => Resource Hub/Speech Recognition}/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md (100%)
rename docs/{Quickstart => Resource Hub/Speech Recognition}/improving_recognition_accuracy.md (98%)
rename docs/{Quickstart/Speech Engines => Resource Hub/Speech Recognition}/speech engines.md (100%)
rename docs/{Quickstart => Resource Hub/Speech Recognition}/troubleshooting.md (100%)
create mode 100644 docs/Resource Hub/Talon Installation/downloading-community.md
diff --git a/docs/Quickstart/FAQ.md b/docs/Help/FAQ.md
similarity index 93%
rename from docs/Quickstart/FAQ.md
rename to docs/Help/FAQ.md
index 01c31f78..9bd4bcd0 100644
--- a/docs/Quickstart/FAQ.md
+++ b/docs/Help/FAQ.md
@@ -14,7 +14,7 @@ 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) page for microphone and eye tracker recommendations.
### Are languages other than English supported?
diff --git a/docs/Quickstart/beta_talon.md b/docs/Help/beta_talon.md
similarity index 100%
rename from docs/Quickstart/beta_talon.md
rename to docs/Help/beta_talon.md
diff --git a/docs/Quickstart/getting_started.md b/docs/Quickstart/getting_started.md
index 5b57bc3f..2c5a0790 100644
--- a/docs/Quickstart/getting_started.md
+++ b/docs/Quickstart/getting_started.md
@@ -1,47 +1,123 @@
---
-sidebar_position: 1
+sidebar_position: 1.1
---
-# Getting Started
+# Installation Guide
+:::docoscope Talon Platform
+
+Although much of this page is pertinent to the talon platform itself,
+some steps are specific to the talon community user file set, and will be marked as such.
+
+:::
+
+## 1: Check System Requirements
+
+Talon has various [system requirements](../Resource%20Hub/Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
+
+## 2: Download & Install Talon
+
+
+ Linux Users
+ - Download [Talon for Linux](https://talonvoice.com)
+ - Install by **To be completed**
:::note
-You can also install and run Talon by following the [official installation instructions](https://talonvoice.com/docs/). This info supplements that page.
+- Talon, like many tools for automation or accessibility, **does not support Wayland**
+ - You will have to select an X11 session from your login manager.
+ - This is supported by Gnome and Plasma and many others, but some environments like sway are explicitly Wayland-only.
+- To install the speech engine, you must use Talon's tray icon:
+ - If you use stock Gnome, you need to install [AppIndicator and KStatusNotifierItem Support](https://extensions.gnome.org/extension/615/appindicator-support/) to see it
+ - If you use i3 or a system tray that doesn't support the `StatusNotifierItem` protocol, install [snixembed](https://git.sr.ht/~steef/snixembed) to add support.
:::
-## 1: [Download Talon](https://talonvoice.com/)
+
- Notes for Linux Users
- - Talon, like many tools for automation or accessibility, __does not support Wayland__
- - You will have to select an X11 session from your login manager.
- - This is supported by Gnome and Plasma and many others, but some environments like sway are explicitly Wayland-only.
-- To install the speech engine, you must use Talon's tray icon:
- * If you use stock Gnome, you need to install [AppIndicator and KStatusNotifierItem Support](https://extensions.gnome.org/extension/615/appindicator-support/) to see it
- * If you use i3 or a system tray that doesn't support the `StatusNotifierItem` protocol, install [snixembed](https://git.sr.ht/~steef/snixembed) to add support.
+ Mac Users
+ - Download [Talon for Mac](https://talonvoice.com)
+ - Install by **To be completed**
+
+
+ Windows Users
+ - Download [Talon for Windows](https://talonvoice.com)
+ - Install Talon by running `talon-windows.exe`
+:::note
+It is recommended that Talon is installed as described above.
+However, please note that the application is also available as a [portable zip file](https://talonvoice.com/dl/latest/talon-windows.zip)
+:::
-## 2: Install a speech recognition engine
+## 3: Install a speech recognition engine
+
+Talon uses a local speech recognition engine that translates voice audio to text.
+
+One recognition engine that comes with Talon is known as `Conformer D`. To install it:
+
+- Run the Talon app
+- Click the Talon tray icon and select `Speech Recognition → Conformer D`.
+
+
+ Screenshot
+
+
+
+:::note
+For other engine options, see the [speech engine page](/docs/Resource%20Hub/Speech%20Recognition/speech%20engines.md)
+:::
+
+## 4: Download the Talon user file set
+
+:::important
+Talon does not come with voice commands out of the box. So at this point in the installation process,
+Talon can not do anything useful.
+
+It requires a `user file set` and
+for beginners, we strongly recommend that you use the [Talon Community](https://github.com/talonhub/community) user file set.
+
+If you install a different user file set then portions of this wiki will not be relevant.
+These will be marked as such.
+:::
+
+
+
+
+A `user file set` is simply a bunch of files that need to be downloaded and placed in the correct directory -
+the talon user directory.
+
+
+:::docoscope community
+
+:::
+
+This can be done one of two ways - either as a `zip` file or by using `git`.
+Considerations in choosing between the two methods, as well as instructions, are described [here](../Resource%20Hub/Talon%20Installation/downloading-community).
-Talon uses a local speech recognition engine that translates voice audio to text. To install your speech engine, click the Talon tray icon and select `Speech Recognition → Conformer D`. For other engine options, see the [speech engine page](./Speech%20Engines/speech%20engines.md)
+## 5: Test your Talon Setup
-## 3: Install a Talon user file set
+If you have installed talon community, try a few [basic commands](/docs/Basic%20Usage/basic_usage.md).
-Talon does not come with voice commands out of the box. To start, we strongly recommend that you use the [Talon Community](https://github.com/talonhub/community) user file set. The whole wiki assumes this repository is used if not otherwise noted.
+If you have installed a different user file set, consult its documentation on usage.
-See the [Talon Community README](https://github.com/talonhub/community?tab=readme-ov-file#installation) for installation instructions.
+## 6: Next steps
-In addition to [Talon Community](https://github.com/talonhub/community), you may want to consider installing any of the [essential Talon integrations](../Integrations/essential-tools.md)
-## 4: Test your Talon Setup
+- If needed, try ways to [improve recognition accuracy](../Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy.md)
+- [Customize Talon](../Customization/basic_customization): learn about how to configure Talon to your liking.
+ - If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
+- For earlier access to new features, priority support, and access to additional [speech engines](/docs/Resource%20Hub/Speech%20Recognition/speech%20engines.md), install the [beta version](../Help/beta_talon).
-- Try a few [basic commands](../Basic%20Usage/basic_usage.md).
-- If needed, try ways to [improve recognition accuracy](improving_recognition_accuracy.md)
-- [Customize Talon](../Customization/basic_customization.md): learn about how to configure Talon to your liking.
-- For earlier access to new features, priority support, and access to additional [speech engines](./Speech%20Engines/speech%20engines.md), install the [beta version](beta_talon.md).
+
-## Join the Talon Slack
+
-If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
diff --git a/docs/Quickstart/Hardware/_category_.yml b/docs/Resource Hub/Hardware/_category_.yml
similarity index 100%
rename from docs/Quickstart/Hardware/_category_.yml
rename to docs/Resource Hub/Hardware/_category_.yml
diff --git a/docs/Quickstart/Hardware/hardware.md b/docs/Resource Hub/Hardware/hardware.md
similarity index 99%
rename from docs/Quickstart/Hardware/hardware.md
rename to docs/Resource Hub/Hardware/hardware.md
index 41ea8492..86041e58 100644
--- a/docs/Quickstart/Hardware/hardware.md
+++ b/docs/Resource Hub/Hardware/hardware.md
@@ -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
diff --git a/docs/Quickstart/Hardware/tobii_4c.md b/docs/Resource Hub/Hardware/tobii_4c.md
similarity index 100%
rename from docs/Quickstart/Hardware/tobii_4c.md
rename to docs/Resource Hub/Hardware/tobii_4c.md
diff --git a/docs/Quickstart/Hardware/tobii_5.md b/docs/Resource Hub/Hardware/tobii_5.md
similarity index 93%
rename from docs/Quickstart/Hardware/tobii_5.md
rename to docs/Resource Hub/Hardware/tobii_5.md
index a4356d18..7ce1bbb9 100644
--- a/docs/Quickstart/Hardware/tobii_5.md
+++ b/docs/Resource Hub/Hardware/tobii_5.md
@@ -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.
diff --git a/docs/Quickstart/Speech Engines/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md b/docs/Resource Hub/Speech Recognition/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md
similarity index 100%
rename from docs/Quickstart/Speech Engines/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md
rename to docs/Resource Hub/Speech Recognition/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md
diff --git a/docs/Quickstart/improving_recognition_accuracy.md b/docs/Resource Hub/Speech Recognition/improving_recognition_accuracy.md
similarity index 98%
rename from docs/Quickstart/improving_recognition_accuracy.md
rename to docs/Resource Hub/Speech Recognition/improving_recognition_accuracy.md
index 2c22dddd..784a1eff 100644
--- a/docs/Quickstart/improving_recognition_accuracy.md
+++ b/docs/Resource Hub/Speech Recognition/improving_recognition_accuracy.md
@@ -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](../Hardware/hardware) for recommendations and correct setup.
## Keep a relaxed voice
diff --git a/docs/Quickstart/Speech Engines/speech engines.md b/docs/Resource Hub/Speech Recognition/speech engines.md
similarity index 100%
rename from docs/Quickstart/Speech Engines/speech engines.md
rename to docs/Resource Hub/Speech Recognition/speech engines.md
diff --git a/docs/Quickstart/troubleshooting.md b/docs/Resource Hub/Speech Recognition/troubleshooting.md
similarity index 100%
rename from docs/Quickstart/troubleshooting.md
rename to docs/Resource Hub/Speech Recognition/troubleshooting.md
diff --git a/docs/Resource Hub/Talon Installation/downloading-community.md b/docs/Resource Hub/Talon Installation/downloading-community.md
new file mode 100644
index 00000000..35de02d0
--- /dev/null
+++ b/docs/Resource Hub/Talon Installation/downloading-community.md
@@ -0,0 +1,95 @@
+# Downloading the Talon Community User File Set
+
+After installing talon and a speech recognition engine, as described here
+you will need to download a user file set. This wiki is all about the Talon community user file set
+and so this page is about downloading that specific user file set.
+
+This can be done using two different methods, using zip and using git.
+
+The background to this choice is that if you use Talon for any period of time,
+you can expect the following:
+
+- The community will update the `user file set` with bug fixes and new features, and you will want
+ to update your local copy of it.
+- You might make your own changes to some of these files.
+
+---
+
+## Considerations
+
+### About `zip`
+
+This is easier to get started with Talon as it involves only downloading a single file and using standard
+methods on your PC to extract all the files from it.
+
+The disadvantage is longer term. Periodically on those occasions when you download the latest community user file set, you will manually need to keep track of which files you have changed
+and make sure those changes aren't lost during the update.
+
+:::tip
+
+In many cases, this disadvantage can be mitigated by following the recommendations SO BE COMPLETED
+
+:::
+
+### About `git`
+
+The benefit of `git`, is that it makes it easy to obtain the latest files without losing any changes you've made in the meantime.
+This is a benefit when using Talon longer term.
+
+If you haven't already heard of `git`, and if you are not particularly comfortable using a command terminal,
+this will be harder to get started with Talon.
+
+### Summary
+
+If you are not particularly comfortable using a command terminal, and if you are just wanting to explore the suitability of Talon
+you may wish to use the simpler method of downloading `zip` files.
+
+You will always be able to switch to using `git` down the track.
+
+---
+
+## Instructions
+
+### Installing Using the Zip File
+
+In this method, the zip file is downloaded from:
+https://github.com/talonhub/community
+
+Click on the `Code` button:
+
+
+And download the zip file:
+
+
+- Extract the files. If you don’t know how to extract zip files, a quick google search for "extract zip files" may be helpful.
+- Place these extracted files inside the `user` folder of the Talon Home directory. You can find this folder by right-clicking the Talon icon in the taskbar (Windows) or clicking the Talon icon in the menu bar (Mac), clicking Scripting > Open ~/talon, and navigating to `user`.
+
+### Installing Using Git
+
+If you wish to install `community` by using git, proceed as follows:
+
+#### Linux & Mac
+
+1. Install [`git`](https://git-scm.com/)
+1. Open a terminal ([Mac](https://support.apple.com/en-gb/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac) / [Ubuntu](https://ubuntu.com/tutorials/command-line-for-beginners#3-opening-a-terminal))
+1. Paste the following into the terminal window then press Enter/Return:
+
+```bash
+cd ~/.talon/user
+git clone https://github.com/talonhub/community community
+```
+
+#### Windows
+
+1. Install [`git`](https://git-scm.com/)
+2. Open a [command prompt](https://www.wikihow.com/Open-the-Command-Prompt-in-Windows)
+3. Paste the following into the command prompt window then press Enter:
+
+```
+cd %AppData%\Talon\user
+git clone https://github.com/talonhub/community community
+```
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 7341a9ad..ef2c8720 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -130,6 +130,12 @@ const config: Config = {
},
hideOnScroll: true,
items: [
+ {
+ type: "docSidebar",
+ sidebarId: "QuickstartSidebar",
+ position: "left",
+ label: "Quickstart",
+ },
{
type: "docSidebar",
sidebarId: "BasicUsageSidebar",
@@ -148,6 +154,12 @@ const config: Config = {
position: "left",
label: "Integrations",
},
+ {
+ type: "docSidebar",
+ sidebarId: "ResourceHubSidebar",
+ position: "left",
+ label: "Resource Hub",
+ },
{
type: "docSidebar",
sidebarId: "HelpSidebar",
diff --git a/sidebars.ts b/sidebars.ts
index 9cd63345..878c1724 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -25,6 +25,12 @@ const sidebars: SidebarsConfig = {
dirName: "Integrations",
},
],
+ ResourceHubSidebar: [
+ {
+ type: "autogenerated",
+ dirName: "Resource Hub",
+ },
+ ],
HelpSidebar: [
{
type: "autogenerated",
From b0a259a95114fc541c07dd31170f9cbd4a3dd5e7 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:09:29 +1100
Subject: [PATCH 05/25] Moved the nonvisual use page from quick start to the
integrations menu
---
.../accessibility.md} | 10 ++++++----
docs/Quickstart/Accessibility/_category_.yml | 1 -
2 files changed, 6 insertions(+), 5 deletions(-)
rename docs/{Quickstart/Accessibility/non-visual-use.md => Integrations/accessibility.md} (85%)
delete mode 100644 docs/Quickstart/Accessibility/_category_.yml
diff --git a/docs/Quickstart/Accessibility/non-visual-use.md b/docs/Integrations/accessibility.md
similarity index 85%
rename from docs/Quickstart/Accessibility/non-visual-use.md
rename to docs/Integrations/accessibility.md
index 841ee463..d47bf3b0 100644
--- a/docs/Quickstart/Accessibility/non-visual-use.md
+++ b/docs/Integrations/accessibility.md
@@ -1,18 +1,20 @@
-# Non-Visual Use
+# 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)
+- Setup Talon according to the standard [quickstart](../Quickstart/getting_started.md)
- Install Talon
- Install 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.
diff --git a/docs/Quickstart/Accessibility/_category_.yml b/docs/Quickstart/Accessibility/_category_.yml
deleted file mode 100644
index c1d74a49..00000000
--- a/docs/Quickstart/Accessibility/_category_.yml
+++ /dev/null
@@ -1 +0,0 @@
-position: 8 # float position is supported
From 639741039d5d3c34b2657a13933ce029caafde37 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:14:38 +1100
Subject: [PATCH 06/25] Moved the "Using Talon with Nix" page to under the
resource hub menu
---
docs/Quickstart/Speech Engines/_category_.yml | 1 -
docs/Quickstart/getting_started.md | 1 -
.../Talon Installation}/nix.md | 0
3 files changed, 2 deletions(-)
delete mode 100644 docs/Quickstart/Speech Engines/_category_.yml
rename docs/{Quickstart/Non-standard Usage => Resource Hub/Talon Installation}/nix.md (100%)
diff --git a/docs/Quickstart/Speech Engines/_category_.yml b/docs/Quickstart/Speech Engines/_category_.yml
deleted file mode 100644
index 3b0fd414..00000000
--- a/docs/Quickstart/Speech Engines/_category_.yml
+++ /dev/null
@@ -1 +0,0 @@
-position: 4
diff --git a/docs/Quickstart/getting_started.md b/docs/Quickstart/getting_started.md
index 2c5a0790..038cfa22 100644
--- a/docs/Quickstart/getting_started.md
+++ b/docs/Quickstart/getting_started.md
@@ -120,4 +120,3 @@ If you have installed a different user file set, consult its documentation on us
-
diff --git a/docs/Quickstart/Non-standard Usage/nix.md b/docs/Resource Hub/Talon Installation/nix.md
similarity index 100%
rename from docs/Quickstart/Non-standard Usage/nix.md
rename to docs/Resource Hub/Talon Installation/nix.md
From c997d811993c20c49fc35816ab2289e1f6f449c8 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:54:31 +1100
Subject: [PATCH 07/25] Moved the last remaining page from quick start
(installation guide) to under the resource hub menu
---
.../Talon Installation/installation_guide.md} | 8 ++++----
docusaurus.config.ts | 6 ------
sidebars.ts | 6 ------
src/pages/index.md | 11 ++++++++++-
4 files changed, 14 insertions(+), 17 deletions(-)
rename docs/{Quickstart/getting_started.md => Resource Hub/Talon Installation/installation_guide.md} (88%)
diff --git a/docs/Quickstart/getting_started.md b/docs/Resource Hub/Talon Installation/installation_guide.md
similarity index 88%
rename from docs/Quickstart/getting_started.md
rename to docs/Resource Hub/Talon Installation/installation_guide.md
index 038cfa22..e6537155 100644
--- a/docs/Quickstart/getting_started.md
+++ b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -13,7 +13,7 @@ some steps are specific to the talon community user file set, and will be marked
## 1: Check System Requirements
-Talon has various [system requirements](../Resource%20Hub/Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
+Talon has various [system requirements](../Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
## 2: Download & Install Talon
@@ -108,10 +108,10 @@ If you have installed a different user file set, consult its documentation on us
## 6: Next steps
-- If needed, try ways to [improve recognition accuracy](../Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy.md)
-- [Customize Talon](../Customization/basic_customization): learn about how to configure Talon to your liking.
+- If needed, try ways to [improve recognition accuracy](../Speech%20Recognition/improving_recognition_accuracy.md)
+- [Customize Talon](../../Customization/basic_customization): learn about how to configure Talon to your liking.
- If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
-- For earlier access to new features, priority support, and access to additional [speech engines](/docs/Resource%20Hub/Speech%20Recognition/speech%20engines.md), install the [beta version](../Help/beta_talon).
+- For earlier access to new features, priority support, and access to additional [speech engines](../Speech%20Recognition/speech%20engines.md), install the [beta version](../../Help/beta_talon).
-:::docoscope community
+:::info talon-scope-community
:::
This can be done one of two ways - either as a `zip` file or by using `git`.
-Considerations in choosing between the two methods, as well as instructions, are described [here](../Resource%20Hub/Talon%20Installation/downloading-community).
+Considerations in choosing between the two methods, as well as instructions, are described [here](../Talon%20Installation/downloading-community).
## 5: Test your Talon Setup
diff --git a/src/css/custom.css b/src/css/custom.css
index 53337535..a5121a8e 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -41,24 +41,20 @@
color: var(--shiki-dark) !important;
}
-.alert--docotodo {
- --ifm-alert-background-color: rgb(121, 68, 146);
- --ifm-alert-background-color-highlight: rgb(121, 68, 146);
- --ifm-alert-foreground-color: white;
- --ifm-alert-border-color: rgb(58, 23, 73);
+.theme-admonition.docotodo {
+ background-color: rgb(121, 68, 146);
+ border-left: 4px solid rgb(58, 23, 73);
+ color: white;
}
-.alert--docofeedback {
- --ifm-alert-background-color: rgb(92, 104, 61);
- --ifm-alert-background-color-highlight: rgb(92, 104, 61);
- --ifm-alert-foreground-color: white;
- --ifm-alert-border-color: rgb(4, 43, 7);
+.theme-admonition.docofeedback {
+ background-color: rgb(92, 104, 61);
+ border-left: 4px solid rgb(4, 43, 7);
+ color: white;
}
-.alert--docoscope {
- --ifm-alert-background-color: #373255;
- --ifm-alert-background-color-highlight: #373255;
- --ifm-alert-foreground-color: white;
- --ifm-alert-border-color: #651FFF;
+.theme-admonition.docoscope {
+ background-color: #373255;
+ border-left: 4px solid #651FFF;
+ color: white;
}
-
\ No newline at end of file
diff --git a/src/theme/Admonition/Type/Info.tsx b/src/theme/Admonition/Type/Info.tsx
new file mode 100644
index 00000000..13608d23
--- /dev/null
+++ b/src/theme/Admonition/Type/Info.tsx
@@ -0,0 +1,49 @@
+import React, {type ReactNode} from 'react';
+import Info from '@theme-original/Admonition/Type/Info';
+import type InfoType from '@theme/Admonition/Type/Info';
+import type {WrapperProps} from '@docusaurus/types';
+
+type Props = WrapperProps;
+
+function ScopeIcon() {
+ return (
+
+ );
+}
+
+export default function InfoWrapper(props: Props): ReactNode {
+ const { title, children } = props;
+
+ let scope = null;
+ let body = null;
+ if (props.title == "talon-scope-platform") {
+ scope = "Talon Platform";
+ body = `This section is relevant to all users of the talon platform, regardless of whether or not the Talon community user file set
+ has also been installed.`;
+ } else if (props.title == "talon-scope-community") {
+ scope = "Talon Community User File Set";
+ body = (This section is only relevant to users who have installed the
+ Talon community user file set);
+ } else if (props.title == "talon-scope") {
+ scope = "";
+ body = children;
+ }
+ const isCustom = Boolean(body);
+ const heading = isCustom ? `[SCOPE] ${scope}` : null;
+
+
+ return (
+ <>
+ { isCustom ?
+ } className="docoscope" title={heading} >
+ {body}
+
+ :
+
+ }
+
+ );
+}
From ff9853701f517de3eae35c106bb58ae80d068e6a Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 22:59:15 +1100
Subject: [PATCH 09/25] some minor fixes
---
docs/Integrations/accessibility.md | 4 ++++
docs/Integrations/essential-tools.md | 4 ++++
.../Speech Recognition/speech engines.md | 2 +-
src/pages/index.md | 14 +++++++-------
src/theme/Admonition/Type/Info.tsx | 2 +-
5 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/docs/Integrations/accessibility.md b/docs/Integrations/accessibility.md
index f261a877..491f40eb 100644
--- a/docs/Integrations/accessibility.md
+++ b/docs/Integrations/accessibility.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 10
+---
+
# Accessibility
## Non-Visual Use
diff --git a/docs/Integrations/essential-tools.md b/docs/Integrations/essential-tools.md
index 63aa4578..a3fa1b1e 100644
--- a/docs/Integrations/essential-tools.md
+++ b/docs/Integrations/essential-tools.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+---
+
# Essential Talon Integrations
| Software | Description |
diff --git a/docs/Resource Hub/Speech Recognition/speech engines.md b/docs/Resource Hub/Speech Recognition/speech engines.md
index e25473bd..07f45cc6 100644
--- a/docs/Resource Hub/Speech Recognition/speech engines.md
+++ b/docs/Resource Hub/Speech Recognition/speech engines.md
@@ -4,7 +4,7 @@ sidebar_position: 1
# Speech Engines
-:::docoscope talon-scope-platform
+:::info talon-scope-platform
:::
diff --git a/src/pages/index.md b/src/pages/index.md
index f7c081b0..08d18394 100644
--- a/src/pages/index.md
+++ b/src/pages/index.md
@@ -45,8 +45,8 @@ mindmap
Before installing talon, there is useful information on this page and on the linked pages for you to read.
-If you prefer jumping in, here is the [installation guide](/docs/Resource%20Hub/Talon%20Installation/installation_guide.md) and
-information about [basic usage](/docs/Basic%20Usage/basic_usage.md).
+If you prefer jumping in, here is the [installation guide](/Resource%20Hub/Talon%20Installation/installation_guide) and
+information about [basic usage](/Basic%20Usage/basic_usage).
---
@@ -58,7 +58,7 @@ If you do so, then everything in this wiki is relevant to you.
These sections will be highlighted as:
-
+
[SCOPE]: TALON COMMUNITY USER FILE SET
@@ -69,7 +69,7 @@ These sections will be highlighted as:
If you are an advanced user and have decided to install a different user file set, then not all parts
of this wiki is relevant. Those that are will be highlighted as follows.
-
+
[SCOPE]: TALON PLATFORM
@@ -88,11 +88,11 @@ The goal of this wiki is to provide information and documentation for the users
| If you are looking for: | See: |
| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| Videos of Talon in use | [Video Demos](/Resource%20Hub/talon_related_resources) |
+| Videos of Talon in use | [Video Demos](/Integrations/talon_related_resources) |
| Help with deciding on a microphone or eye tracker | [Hardware](/Resource%20Hub/Hardware) |
| Installing and getting started with Talon | [Installing Talon](/Resource%20Hub/Talon%20Installation/installation_guide), [Basic Usage](/Basic%20Usage/basic_usage) |
-| How to customize Talon, obtaining additional functionality | [Basic Customization](/Customization/overview), [Integrations](/Integrations) |
-| Troubleshooting help | [Troubleshooting](/Resource%20Hub/Troubleshooting/basic-issues) |
+| How to customize Talon, obtaining additional functionality | [Basic Customization](/Customization/basic_customization), [Integrations](/Integrations/essential-tools) |
+| Troubleshooting help | [Troubleshooting](/Resource%20Hub/Speech%20Recognition/troubleshooting) |
| Answers to frequently asked questions | [FAQ](/Help/FAQ) |
:::tip Talon Slack
diff --git a/src/theme/Admonition/Type/Info.tsx b/src/theme/Admonition/Type/Info.tsx
index 13608d23..db9fca6e 100644
--- a/src/theme/Admonition/Type/Info.tsx
+++ b/src/theme/Admonition/Type/Info.tsx
@@ -9,7 +9,7 @@ function ScopeIcon() {
return (
);
}
From 6f352279e74f1b59f82630f78d5b42bf8c02beb9 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 23:05:48 +1100
Subject: [PATCH 10/25] minor change
---
docs/Resource Hub/Talon Installation/installation_guide.md | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/docs/Resource Hub/Talon Installation/installation_guide.md b/docs/Resource Hub/Talon Installation/installation_guide.md
index dfa77c4a..ecea7297 100644
--- a/docs/Resource Hub/Talon Installation/installation_guide.md
+++ b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -21,7 +21,8 @@ Talon has various [system requirements](../Hardware/os), covering the computer h
Linux Users
- Download [Talon for Linux](https://talonvoice.com)
- - Install by **To be completed**
+ - Install
+
:::note
- Talon, like many tools for automation or accessibility, **does not support Wayland**
@@ -38,17 +39,19 @@ Talon has various [system requirements](../Hardware/os), covering the computer h
Mac Users
- Download [Talon for Mac](https://talonvoice.com)
- - Install by **To be completed**
+ - Install
Windows Users
- Download [Talon for Windows](https://talonvoice.com)
- Install Talon by running `talon-windows.exe`
+
:::note
It is recommended that Talon is installed as described above.
However, please note that the application is also available as a [portable zip file](https://talonvoice.com/dl/latest/talon-windows.zip)
:::
+
## 3: Install a speech recognition engine
From 3bb80400840bf1c599f18beb540293e442b0732c Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Sat, 8 Mar 2025 10:15:50 +1100
Subject: [PATCH 11/25] Removed unnecessary "admonitions" definition that was
temporarily added in this branch
---
docusaurus.config.ts | 4 ----
1 file changed, 4 deletions(-)
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index ea6a4efa..6f89059f 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -61,10 +61,6 @@ const config: Config = {
} satisfies RehypeShikiOptions,
],
],
- admonitions: {
- keywords: ["docotodo", "docofeedback", "docoscope"],
- extendDefaults: true,
- },
},
theme: {
customCss: "./src/css/custom.css",
From 132ddda7969ff01518c0a1902f5b2178d54b6037 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
<66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Fri, 7 Mar 2025 23:20:57 +0000
Subject: [PATCH 12/25] [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
---
docs/Basic Usage/settings.md | 2 +-
.../Talon Installation/installation_guide.md | 8 +-
docusaurus.config.ts | 2 +-
src/css/custom.css | 72 ++++++++--------
src/pages/index.md | 19 ++--
src/theme/Admonition/Type/Info.tsx | 86 +++++++++++--------
6 files changed, 97 insertions(+), 92 deletions(-)
diff --git a/docs/Basic Usage/settings.md b/docs/Basic Usage/settings.md
index 9ac28c9c..8414dd1a 100644
--- a/docs/Basic Usage/settings.md
+++ b/docs/Basic Usage/settings.md
@@ -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](../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.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)
diff --git a/docs/Resource Hub/Talon Installation/installation_guide.md b/docs/Resource Hub/Talon Installation/installation_guide.md
index ecea7297..f8d47a4b 100644
--- a/docs/Resource Hub/Talon Installation/installation_guide.md
+++ b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -11,7 +11,6 @@ some steps are specific to the talon community user file set, and will be marked
:::
-
## 1: Check System Requirements
Talon has various [system requirements](../Hardware/os), covering the computer hardware, operating system and microphone hardware.
@@ -87,11 +86,9 @@ If you install a different user file set then portions of this wiki will not be
These will be marked as such.
:::
-
-
-
A `user file set` is simply a bunch of files that need to be downloaded and placed in the correct directory -
the talon user directory.
+
@@ -111,10 +108,9 @@ If you have installed a different user file set, consult its documentation on us
## 6: Next steps
-
- If needed, try ways to [improve recognition accuracy](../Speech%20Recognition/improving_recognition_accuracy.md)
- [Customize Talon](../../Customization/basic_customization): learn about how to configure Talon to your liking.
- - If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
+- If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
- For earlier access to new features, priority support, and access to additional [speech engines](../Speech%20Recognition/speech%20engines.md), install the [beta version](../../Help/beta_talon).
:::info talon-scope-community
@@ -105,7 +105,7 @@ Considerations in choosing between the two methods, as well as instructions, are
## 5: Test your Talon Setup
-If you have installed talon community, try a few [basic commands](/docs/Basic%20Usage/basic_usage.md).
+If you have installed Talon community, try a few [basic commands](/docs/Basic%20Usage/basic_usage.md).
If you have installed a different user file set, consult its documentation on usage.
diff --git a/src/pages/index.md b/src/pages/index.md
index 08d18394..62b296ec 100644
--- a/src/pages/index.md
+++ b/src/pages/index.md
@@ -43,7 +43,7 @@ mindmap
## Jumping In
-Before installing talon, there is useful information on this page and on the linked pages for you to read.
+Before installing Talon, there is useful information on this page and on the linked pages for you to read.
If you prefer jumping in, here is the [installation guide](/Resource%20Hub/Talon%20Installation/installation_guide) and
information about [basic usage](/Basic%20Usage/basic_usage).
@@ -52,8 +52,8 @@ information about [basic usage](/Basic%20Usage/basic_usage).
## Documentation Scope
-To use talon, the talon platform needs to be installed.
-If you are a beginner then it is recommended that you additionally install the talon community user file set.
+To use Talon, the Talon platform needs to be installed.
+If you are a beginner then it is recommended that you additionally install the Talon community user file set.
If you do so, then everything in this wiki is relevant to you.
These sections will be highlighted as:
From 09213f88e82480ddfdc3b139b51113d5f2a18741 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
<66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Mon, 24 Mar 2025 06:30:55 +0000
Subject: [PATCH 18/25] [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
---
docs/Basic Usage/settings.md | 2 +-
docs/Resource Hub/Talon Installation/downloading-community.md | 2 +-
docs/Resource Hub/Talon Installation/installation_guide.md | 1 +
3 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/Basic Usage/settings.md b/docs/Basic Usage/settings.md
index bc03e31c..18bcc299 100644
--- a/docs/Basic Usage/settings.md
+++ b/docs/Basic Usage/settings.md
@@ -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](../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.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)
diff --git a/docs/Resource Hub/Talon Installation/downloading-community.md b/docs/Resource Hub/Talon Installation/downloading-community.md
index 8223e9e1..095337d1 100644
--- a/docs/Resource Hub/Talon Installation/downloading-community.md
+++ b/docs/Resource Hub/Talon Installation/downloading-community.md
@@ -37,7 +37,7 @@ The benefit of `git`, is that it makes it easy to obtain the latest files withou
This is a benefit when using Talon longer term.
If you haven't already heard of `git`, you might find that this approach makes it a little harder to get started with Talon.
-`git` is a very extensive tool, but you will only need to use it in a minimal way. Even still, there will be terms that you will come across such as `repository`, `branch` and `working directory`.
+`git` is a very extensive tool, but you will only need to use it in a minimal way. Even still, there will be terms that you will come across such as `repository`, `branch` and `working directory`.
`git` is available as both a command line utility and as a GUI application.
If you are not particularly comfortable usihellong a command terminal, you may prefer a GUI application such as [`GitHub Desktop`](https://docs.github.com/en/desktop/overview/about-github-desktop).
diff --git a/docs/Resource Hub/Talon Installation/installation_guide.md b/docs/Resource Hub/Talon Installation/installation_guide.md
index 3383347c..c1730176 100644
--- a/docs/Resource Hub/Talon Installation/installation_guide.md
+++ b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -88,6 +88,7 @@ These will be marked as such.
A `user file set` is simply a bunch of files that need to be downloaded and placed in the correct directory -
the Talon user directory.
+
From ebbc122e60bdc1e30ad68f0d61084d9a57b965c9 Mon Sep 17 00:00:00 2001
From: Nicholas Riley
Date: Sat, 19 Apr 2025 11:40:26 -0400
Subject: [PATCH 19/25] Remove duplicate /
---
docs/Basic Usage/settings.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Basic Usage/settings.md b/docs/Basic Usage/settings.md
index 18bcc299..224620a8 100644
--- a/docs/Basic Usage/settings.md
+++ b/docs/Basic Usage/settings.md
@@ -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](../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.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)
From 5cae33654329b5a4b2ebed1f715e8fe229fc3960 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
<66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Sat, 19 Apr 2025 15:40:33 +0000
Subject: [PATCH 20/25] [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
---
docs/Basic Usage/settings.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Basic Usage/settings.md b/docs/Basic Usage/settings.md
index 224620a8..fa4c6b71 100644
--- a/docs/Basic Usage/settings.md
+++ b/docs/Basic Usage/settings.md
@@ -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](../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.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)
From b3757357326e6e358317ba89c8be5d5ce417b33a Mon Sep 17 00:00:00 2001
From: Nicholas Riley
Date: Sat, 19 Apr 2025 11:42:21 -0400
Subject: [PATCH 21/25] A couple more capitalization fixes and a typo fix
---
docs/Customization/talon-files.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Customization/talon-files.md b/docs/Customization/talon-files.md
index f4a67789..b96fdebe 100644
--- a/docs/Customization/talon-files.md
+++ b/docs/Customization/talon-files.md
@@ -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:
From c9f869f5dbca5f1889bdfb7bff7ba1ae1afcddec Mon Sep 17 00:00:00 2001
From: Nicholas Riley
Date: Sat, 19 Apr 2025 11:44:36 -0400
Subject: [PATCH 22/25] Update docs/Help/FAQ.md
---
docs/Help/FAQ.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Help/FAQ.md b/docs/Help/FAQ.md
index bf88a4ed..e06980fe 100644
--- a/docs/Help/FAQ.md
+++ b/docs/Help/FAQ.md
@@ -14,7 +14,7 @@ Talon does not require special configuration for different programming languages
### What hardware should I have?
-Check out the [hardware](/docs/Resource%20Hub/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?
From 12608344c83b3486c9f89fad32e57c9e3b544ad3 Mon Sep 17 00:00:00 2001
From: Nicholas Riley
Date: Sat, 19 Apr 2025 11:45:32 -0400
Subject: [PATCH 23/25] Fix capitalization
---
docs/Resource Hub/Talon Installation/installation_guide.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Resource Hub/Talon Installation/installation_guide.md b/docs/Resource Hub/Talon Installation/installation_guide.md
index c1730176..5ad915c7 100644
--- a/docs/Resource Hub/Talon Installation/installation_guide.md
+++ b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -100,7 +100,7 @@ the [Talon user directory](/docs/Resource%20Hub/terminology).
This can be done one of two ways - either as a `zip` file or by using `git`.
Considerations in choosing between the two methods, as well as instructions, are described [here](../Talon%20Installation/downloading-community).
-## 5: Test your Talon Setup
+## 5: Test your Talon setup
If you have installed Talon community, try a few [basic commands](/docs/Basic%20Usage/basic_usage.md).
From 37dd3a682fec1ee9397d1c4d50e15f9cdf9c00f2 Mon Sep 17 00:00:00 2001
From: Nicholas Riley
Date: Sat, 19 Apr 2025 11:46:19 -0400
Subject: [PATCH 24/25] Link to Patreon donation page.
---
docs/Help/talon-slack.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Help/talon-slack.md b/docs/Help/talon-slack.md
index ff4236c9..83736c6d 100644
--- a/docs/Help/talon-slack.md
+++ b/docs/Help/talon-slack.md
@@ -5,7 +5,7 @@ Talon has a Slack community for users to get help, ask questions, and meet one a
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)
+- `#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
From 286611d5ee8005b568de9a82cc6c0290f91b17ea Mon Sep 17 00:00:00 2001
From: Nicholas Riley
Date: Sat, 19 Apr 2025 11:46:38 -0400
Subject: [PATCH 25/25] Improve wording
---
docs/Help/FAQ.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/Help/FAQ.md b/docs/Help/FAQ.md
index e06980fe..229a5974 100644
--- a/docs/Help/FAQ.md
+++ b/docs/Help/FAQ.md
@@ -35,4 +35,4 @@ While Talon is closed source, there's plenty you can do to help:
### Troubleshooting
-Checkout the [troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) for solutions to common problems.
+The [Troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) page includes solutions to common problems.
+
+
+And download the zip file:
+
+
+- Extract the files. If you don’t know how to extract zip files, a quick google search for "extract zip files" may be helpful.
+- Place these extracted files inside the `user` folder of the Talon Home directory. You can find this folder by right-clicking the Talon icon in the taskbar (Windows) or clicking the Talon icon in the menu bar (Mac), clicking Scripting > Open ~/talon, and navigating to `user`.
+
+### Installing Using Git
+
+If you wish to install `community` by using git, proceed as follows:
+
+#### Linux & Mac
+
+1. Install [`git`](https://git-scm.com/)
+1. Open a terminal ([Mac](https://support.apple.com/en-gb/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac) / [Ubuntu](https://ubuntu.com/tutorials/command-line-for-beginners#3-opening-a-terminal))
+1. Paste the following into the terminal window then press Enter/Return:
+
+```bash
+cd ~/.talon/user
+git clone https://github.com/talonhub/community community
+```
+
+#### Windows
+
+1. Install [`git`](https://git-scm.com/)
+2. Open a [command prompt](https://www.wikihow.com/Open-the-Command-Prompt-in-Windows)
+3. Paste the following into the command prompt window then press Enter:
+
+```
+cd %AppData%\Talon\user
+git clone https://github.com/talonhub/community community
+```
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 7341a9ad..ef2c8720 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -130,6 +130,12 @@ const config: Config = {
},
hideOnScroll: true,
items: [
+ {
+ type: "docSidebar",
+ sidebarId: "QuickstartSidebar",
+ position: "left",
+ label: "Quickstart",
+ },
{
type: "docSidebar",
sidebarId: "BasicUsageSidebar",
@@ -148,6 +154,12 @@ const config: Config = {
position: "left",
label: "Integrations",
},
+ {
+ type: "docSidebar",
+ sidebarId: "ResourceHubSidebar",
+ position: "left",
+ label: "Resource Hub",
+ },
{
type: "docSidebar",
sidebarId: "HelpSidebar",
diff --git a/sidebars.ts b/sidebars.ts
index 9cd63345..878c1724 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -25,6 +25,12 @@ const sidebars: SidebarsConfig = {
dirName: "Integrations",
},
],
+ ResourceHubSidebar: [
+ {
+ type: "autogenerated",
+ dirName: "Resource Hub",
+ },
+ ],
HelpSidebar: [
{
type: "autogenerated",
From b0a259a95114fc541c07dd31170f9cbd4a3dd5e7 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:09:29 +1100
Subject: [PATCH 05/25] Moved the nonvisual use page from quick start to the
integrations menu
---
.../accessibility.md} | 10 ++++++----
docs/Quickstart/Accessibility/_category_.yml | 1 -
2 files changed, 6 insertions(+), 5 deletions(-)
rename docs/{Quickstart/Accessibility/non-visual-use.md => Integrations/accessibility.md} (85%)
delete mode 100644 docs/Quickstart/Accessibility/_category_.yml
diff --git a/docs/Quickstart/Accessibility/non-visual-use.md b/docs/Integrations/accessibility.md
similarity index 85%
rename from docs/Quickstart/Accessibility/non-visual-use.md
rename to docs/Integrations/accessibility.md
index 841ee463..d47bf3b0 100644
--- a/docs/Quickstart/Accessibility/non-visual-use.md
+++ b/docs/Integrations/accessibility.md
@@ -1,18 +1,20 @@
-# Non-Visual Use
+# 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)
+- Setup Talon according to the standard [quickstart](../Quickstart/getting_started.md)
- Install Talon
- Install 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.
diff --git a/docs/Quickstart/Accessibility/_category_.yml b/docs/Quickstart/Accessibility/_category_.yml
deleted file mode 100644
index c1d74a49..00000000
--- a/docs/Quickstart/Accessibility/_category_.yml
+++ /dev/null
@@ -1 +0,0 @@
-position: 8 # float position is supported
From 639741039d5d3c34b2657a13933ce029caafde37 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:14:38 +1100
Subject: [PATCH 06/25] Moved the "Using Talon with Nix" page to under the
resource hub menu
---
docs/Quickstart/Speech Engines/_category_.yml | 1 -
docs/Quickstart/getting_started.md | 1 -
.../Talon Installation}/nix.md | 0
3 files changed, 2 deletions(-)
delete mode 100644 docs/Quickstart/Speech Engines/_category_.yml
rename docs/{Quickstart/Non-standard Usage => Resource Hub/Talon Installation}/nix.md (100%)
diff --git a/docs/Quickstart/Speech Engines/_category_.yml b/docs/Quickstart/Speech Engines/_category_.yml
deleted file mode 100644
index 3b0fd414..00000000
--- a/docs/Quickstart/Speech Engines/_category_.yml
+++ /dev/null
@@ -1 +0,0 @@
-position: 4
diff --git a/docs/Quickstart/getting_started.md b/docs/Quickstart/getting_started.md
index 2c5a0790..038cfa22 100644
--- a/docs/Quickstart/getting_started.md
+++ b/docs/Quickstart/getting_started.md
@@ -120,4 +120,3 @@ If you have installed a different user file set, consult its documentation on us
-
diff --git a/docs/Quickstart/Non-standard Usage/nix.md b/docs/Resource Hub/Talon Installation/nix.md
similarity index 100%
rename from docs/Quickstart/Non-standard Usage/nix.md
rename to docs/Resource Hub/Talon Installation/nix.md
From c997d811993c20c49fc35816ab2289e1f6f449c8 Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Fri, 7 Mar 2025 10:54:31 +1100
Subject: [PATCH 07/25] Moved the last remaining page from quick start
(installation guide) to under the resource hub menu
---
.../Talon Installation/installation_guide.md} | 8 ++++----
docusaurus.config.ts | 6 ------
sidebars.ts | 6 ------
src/pages/index.md | 11 ++++++++++-
4 files changed, 14 insertions(+), 17 deletions(-)
rename docs/{Quickstart/getting_started.md => Resource Hub/Talon Installation/installation_guide.md} (88%)
diff --git a/docs/Quickstart/getting_started.md b/docs/Resource Hub/Talon Installation/installation_guide.md
similarity index 88%
rename from docs/Quickstart/getting_started.md
rename to docs/Resource Hub/Talon Installation/installation_guide.md
index 038cfa22..e6537155 100644
--- a/docs/Quickstart/getting_started.md
+++ b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -13,7 +13,7 @@ some steps are specific to the talon community user file set, and will be marked
## 1: Check System Requirements
-Talon has various [system requirements](../Resource%20Hub/Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
+Talon has various [system requirements](../Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
## 2: Download & Install Talon
@@ -108,10 +108,10 @@ If you have installed a different user file set, consult its documentation on us
## 6: Next steps
-- If needed, try ways to [improve recognition accuracy](../Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy.md)
-- [Customize Talon](../Customization/basic_customization): learn about how to configure Talon to your liking.
+- If needed, try ways to [improve recognition accuracy](../Speech%20Recognition/improving_recognition_accuracy.md)
+- [Customize Talon](../../Customization/basic_customization): learn about how to configure Talon to your liking.
- If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
-- For earlier access to new features, priority support, and access to additional [speech engines](/docs/Resource%20Hub/Speech%20Recognition/speech%20engines.md), install the [beta version](../Help/beta_talon).
+- For earlier access to new features, priority support, and access to additional [speech engines](../Speech%20Recognition/speech%20engines.md), install the [beta version](../../Help/beta_talon).
-:::docoscope community
+:::info talon-scope-community
:::
This can be done one of two ways - either as a `zip` file or by using `git`.
-Considerations in choosing between the two methods, as well as instructions, are described [here](../Resource%20Hub/Talon%20Installation/downloading-community).
+Considerations in choosing between the two methods, as well as instructions, are described [here](../Talon%20Installation/downloading-community).
## 5: Test your Talon Setup
diff --git a/src/css/custom.css b/src/css/custom.css
index 53337535..a5121a8e 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -41,24 +41,20 @@
color: var(--shiki-dark) !important;
}
-.alert--docotodo {
- --ifm-alert-background-color: rgb(121, 68, 146);
- --ifm-alert-background-color-highlight: rgb(121, 68, 146);
- --ifm-alert-foreground-color: white;
- --ifm-alert-border-color: rgb(58, 23, 73);
+.theme-admonition.docotodo {
+ background-color: rgb(121, 68, 146);
+ border-left: 4px solid rgb(58, 23, 73);
+ color: white;
}
-.alert--docofeedback {
- --ifm-alert-background-color: rgb(92, 104, 61);
- --ifm-alert-background-color-highlight: rgb(92, 104, 61);
- --ifm-alert-foreground-color: white;
- --ifm-alert-border-color: rgb(4, 43, 7);
+.theme-admonition.docofeedback {
+ background-color: rgb(92, 104, 61);
+ border-left: 4px solid rgb(4, 43, 7);
+ color: white;
}
-.alert--docoscope {
- --ifm-alert-background-color: #373255;
- --ifm-alert-background-color-highlight: #373255;
- --ifm-alert-foreground-color: white;
- --ifm-alert-border-color: #651FFF;
+.theme-admonition.docoscope {
+ background-color: #373255;
+ border-left: 4px solid #651FFF;
+ color: white;
}
-
\ No newline at end of file
diff --git a/src/theme/Admonition/Type/Info.tsx b/src/theme/Admonition/Type/Info.tsx
new file mode 100644
index 00000000..13608d23
--- /dev/null
+++ b/src/theme/Admonition/Type/Info.tsx
@@ -0,0 +1,49 @@
+import React, {type ReactNode} from 'react';
+import Info from '@theme-original/Admonition/Type/Info';
+import type InfoType from '@theme/Admonition/Type/Info';
+import type {WrapperProps} from '@docusaurus/types';
+
+type Props = WrapperProps