From 512edf978cac3b6ba21d2b805c2a9eb51147c0aa Mon Sep 17 00:00:00 2001
From: ronzulu <75528127+ronzulu@users.noreply.github.com>
Date: Tue, 1 Oct 2024 15:42:56 +1000
Subject: [PATCH 001/107] First pass
---
docs/Quickstart/Hardware/hardware.md | 10 ++-
docs/Quickstart/getting_started.md | 81 +++++++++++++++----
docs/Quickstart/troubleshooting.md | 2 +-
static/img/talon_menu_speech_recognition.png | Bin 0 -> 23395 bytes
4 files changed, 77 insertions(+), 16 deletions(-)
create mode 100644 static/img/talon_menu_speech_recognition.png
diff --git a/docs/Quickstart/Hardware/hardware.md b/docs/Quickstart/Hardware/hardware.md
index 84bab2fd..e61c5ac5 100644
--- a/docs/Quickstart/Hardware/hardware.md
+++ b/docs/Quickstart/Hardware/hardware.md
@@ -1,4 +1,12 @@
-# Hardware
+# Hardware & OS
+
+## Operating System
+
+| 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 |
## Microphones
diff --git a/docs/Quickstart/getting_started.md b/docs/Quickstart/getting_started.md
index 5b57bc3f..230c4454 100644
--- a/docs/Quickstart/getting_started.md
+++ b/docs/Quickstart/getting_started.md
@@ -4,44 +4,97 @@ sidebar_position: 1
# Getting Started
-:::note
+## 1: Check System Requirements
-You can also install and run Talon by following the [official installation instructions](https://talonvoice.com/docs/). This info supplements that page.
+Talon has various [system requirements](Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
-:::
-## 1: [Download Talon](https://talonvoice.com/)
+## 2: Download & Install Talon
Notes for Linux Users
- - Talon, like many tools for automation or accessibility, __does not support Wayland__
+ Linux Users
+ - Download [Talon for Linux](https://talonvoice.com/dl/latest/talon-linux.tar.xz)
+ - Install by **To be completed**
+
+:::note
+- 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/dl/latest/talon-mac.dmg)
+ - Install by **To be completed**
+
+Windows Users
+ - Download [Talon for Windows](https://talonvoice.com/dl/latest/talon-windows.exe)
+ - 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)
+:::
+
+Screenshot
+
mqpDK{UOxtlILx8MlVv8q0u@)E2Xi4s0ULF2=}N?^20$
zqN{LP{os?j-I|s%^cXsaHM^R_uB@?=OY}=Z<%Hx3p0EuxcK_MRfwW+;@Z);d!Q^62
z&NYTxx!PoLmQwk;6}^@(n_zP9-;Dbioth3TS3CQ|M)J-}cI@q~!lJsD5wAo&6TGP%
z{k8=Vi8yqnU^*ROpTT|anoB vm>+9#KxblLU|`3{
z$f(Dqc>mSrty={+PWZURgoK1VG3a=~`>#7DHa0UkDJd^FICy+*ZLQ;mc_^oB jO_Ohd6wxs(6lRvuB
zj?KG36BPXhoe+q;{4M5~wXlPuqbOp>i=>W`3qe6fWu>Jhj)!IWCyb5RP!N>>O{b1t
zDm7VIS=rf#b|BhNV4Y7^cD)+aQ?tWPR4G-XheTmQ^f!M0c8O~m)s-C>@Lw;RM1hHW
z>pA0sjw{;S-aZpyR@hVGo*97(uW<5YgQ1bp#mA2y+cZ8s5i76VjyjzU5yuN?c<6g|
zFq@&kBS9p!#wVhxzSCbN-vM1Zf>I?}lk^+3TOuh4FK_Q?AmUv}>q1*OB*FntX70(Z
z|7$BqOB-{_3Hnb7GUmF^UHf8-_j|;PIT3(DqIy%|+Xkvl@(j+4v!-jHaV78uBFB#(
z?|5Ze#Y=7tHL*DS$oMmAL4EPnzn7mF3e-q&oQ?Nm`}ySN`pMo0DhE7(kzS&k^!Yo@
z|7DvMxXAkm)3}L8OG4O~%eJ=TKFBNuJzQO&VOg>0?#T3>oq*bznKd(ZT*{HoxTlxk
zHh>=XW|leFVFPZwGYKzzG=4-t;5p*G=?E`x-Pqu}8!=jsllF**C{m$ezE^GbBqT(=
z9=B>8vP=A>G!IYEmwfAU-cw&*{&9sebm3ZpjGqPN^#Gz-y<=g1T+<3kUwb*9>yw3W
zT>UU3QBs}-g3MCZcX4*%_R}iFO72Mo1vMlxo@WZ)M)OUw=>4p~BUgC+GNUadc`!A!
z_ROI}vtun>ov1zcZ*SS9^Uf^y6T&f5De@+o<%+`aKy;e(oEwIXa&};4M;muj0rk<`
zuG&X}x81uN$Pg`Fn_>Ph8*Gsg+t!(iD!Kv&>uYCcrzJY3Zmu(-|B`5*mD+0`B8*-Y
z ?`%ShAL``TXqRKdyhH3U2>#*SSF9#x)5_rVDPekEEVA
z2jm|b5;D9Kx- 7{nBBYD1u{<|ieXgg5JmmNEh;SUlIXYqC&pf-iDx7DdM!MxRHMo9A&k(8
zmUaLoo>$5o;&TpWR+^5$8shac3O&B6guy^^iE;WUW#Z9cc{a{gtnz%`6u9EVssg<6
zVt9`G6KvZ-1(4}Nm7tmRpxD?M-BMq{3zg=obSQs5Qe9GZ@*;>fdiINZrZ8i$WW+OJUTk|XJ2RXFt4&TT!t)706)w6kv9
zFIp1
Screenshot
@@ -64,7 +62,7 @@ One recognition engine that comes with Talon is known as `Conformer D`. To insta
/>
Mac Users
- Download [Talon for Mac](https://talonvoice.com/dl/latest/talon-mac.dmg)
- Install by **To be completed**
-
Windows Users
- Download [Talon for Windows](https://talonvoice.com/dl/latest/talon-windows.exe)
- 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)
:::
-
-
+
+## Uppercase Letters
+
+For uppercase letters, you say the word `shift` before the word for the letter. For example, to get an uppercase `Z` you would say `shift zip`.
+
+## Learning Tools
+
+[Talon Practice Website](/docs/Help/Items/talon-practice-website.md)
+
diff --git a/docs/Basic Usage/basic_usage.md b/docs/Basic Usage/basic_usage.md
index 88b034d8..b3fc9172 100644
--- a/docs/Basic Usage/basic_usage.md
+++ b/docs/Basic Usage/basic_usage.md
@@ -1,16 +1,23 @@
# Basic Usage
-The examples below are just a very small selection of common commands for working with Talon. These are based on the [Talon Community](https://github.com/talonhub/community) user file set.
+## Talon Modes
+
+Talon has three basic modes by default:
+
+| Mode | Description |
+| ---------------- | --------------------------- |
+| **command mode** | Your speech will be interpreted as commands by default. |
+| **dictation mode** | Your speech will be transcribed as plain text by default (although with some commands, like "comma" etc. for punctuation), similar to traditional speech recognition systems. |
+| **sleep mode** | Talon will do nothing until it hears a commands that wakes it up.|
+
## Mode Switching
-Talon has three basic modes by default:
-- In **command mode**, your speech will be interpreted as commands by default.
-- In **dictation mode**, your speech will be transcribed as plain text by default (although with some commands, like "comma" etc. for punctuation), similar to traditional speech recognition systems.
-- In **sleep mode**, Talon will do nothing until it hears a commands that wakes it up.
+
-To keep track of what mode you are in with a visual icon, enable the [mode indicator feature](https://github.com/talonhub/community/tree/main/plugin/mode_indicator) in the community repository.
| Command | Description |
| ---------------- | --------------------------- |
@@ -21,119 +28,10 @@ To keep track of what mode you are in with a visual icon, enable the [mode indic
| `dictation mode` | Switch to dictation mode. |
| `command mode` | Switch to command mode. |
-## Help Commands
-
-| Command | Description |
-| ---------------------------- | ---------------------------------------------------------------- |
-| `help alphabet` | show the spelling alphabet for pressing individual keys |
-| `help context` | show all defined commands |
-| `help active` | show all currently available commands |
-| `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 |
-
-## Dictating Text
-
-Say a formatter then the text. (i.e. `say "hello world"`) to dictate while in command mode
-
-| Formatter | Description |
-| ----------------- | --------------------------------------- |
-| `say` | no special formatting is applied |
-| `sentence` | the first word is capitalized |
-| `title` | every word starts with a capital letter |
-| `all down` | every word is all lower case |
-| `smash` | no spaces between words |
-| `kebab` | dashes instead of spaces |
-| `help formatters` | show all available formatters |
-
-## Customize Talon
-
-These commands will open up a CSV or [Talon list](Customization/talon_lists.md) file in your default text editor that you can edit to customize voice commands without needing to write Talon scripts.
-
-| Command | Description |
-| ---------------------------- | ------------------------------------------------- |
-| `customize additional words` | add additional words that Talon will recognize |
-| `customize words to replace` | remap or reformat words that Talon will recognize |
-| `customize alphabet` | change the default Talon alphabet |
-| `customize websites` | add websites that can be opened with Talon |
-
-## Working with applications
-
-| Command | Description |
-| ------------------- | ----------------------------------------------------------------- |
-| `focus "app name"` | say "focus chrome" for example, to switch active window to chrome |
-| `running list` | see all active applications |
-| `launch "app name"` | say "launch chrome" for example, to open chrome |
-| `window close` | closes the currently active window |
-
-## Working with tabs
-
-| Command |
-| ----------------- |
-| `tab new` |
-| `tab last` |
-| `tab next` |
-| `tab close` |
-| `tab restore` |
-| `go tab
+
+
\ No newline at end of file
diff --git a/docs/Integrations/Details/talon-hud.md b/docs/Integrations/Details/talon-hud.md
new file mode 100644
index 00000000..931b802a
--- /dev/null
+++ b/docs/Integrations/Details/talon-hud.md
@@ -0,0 +1,9 @@
+# Talon HUD (Heads Up Display)
+
+Show visual information about your current state of Talon.
+
+
+
+See https://github.com/chaosparrot/talon_hud
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 3c6aa9b2..27a642d4 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -123,6 +123,12 @@ const config: Config = {
position: "left",
label: "Integrations",
},
+ {
+ type: "docSidebar",
+ sidebarId: "HelpSidebar",
+ position: "left",
+ label: "Help",
+ },
{
type: "doc",
docId: "FAQ",
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;
diff --git a/static/img/basic-modes.png b/static/img/basic-modes.png
new file mode 100644
index 0000000000000000000000000000000000000000..8e778da0615822896318fe7a4c883fbccccae52a
GIT binary patch
literal 73856
zcmce8hd-BX*#2!+Qb`CY6{(1jovcb`!zQvfkxfJ@4cV!L$S5
2oj>n18%~n0X^LHBm{LmC$@STL{Pecr0YjO%Uy3
z$XFk5Dj;JmxNMkabz3WTozqgvb|oU&+x6-bE*8Dn`ei_$Uk&uh(#p!krugHpNh;X;
z^5x5QU{&*g7L8hxPH$!=