Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki refurbishment #312

Draft
wants to merge 114 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
114 commits
Select commit Hold shift + click to select a range
512edf9
First pass
ronzulu Oct 1, 2024
56259bb
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 1, 2024
f2c4ba8
Attempt to fix: Expected the closing tag `</details>` either after th…
ronzulu Oct 1, 2024
24c3825
Merge branch 'issue-170-improve-for-non-programmers' of https://githu…
ronzulu Oct 1, 2024
7dd2cb5
package-lock
ronzulu Oct 4, 2024
7e93765
Moved FAQ to top level nav
ronzulu Oct 5, 2024
4d7fe5a
Progress
ronzulu Oct 6, 2024
bef2e49
Added page for symbols
ronzulu Oct 6, 2024
69855fc
restructure customization related info
ronzulu Oct 7, 2024
5e07039
More restructuring
ronzulu Oct 8, 2024
7a79ed1
More restructuring
ronzulu Oct 9, 2024
0b89964
Added info about captures
ronzulu Oct 10, 2024
ef088eb
Starting to incorporate info from https://github.com/talonhub/communi…
ronzulu Oct 10, 2024
c06e615
Beefing up the section on keys
ronzulu Oct 10, 2024
d6d9fff
started the formatters page
ronzulu Oct 10, 2024
ab46d6d
Updated formatters
ronzulu Oct 10, 2024
6b5c297
Changing filename
ronzulu Oct 10, 2024
0cf8787
Changing filename
ronzulu Oct 10, 2024
2ee840e
Added PC control page
ronzulu Oct 11, 2024
7cfe96d
Added info about the mouse grid
ronzulu Oct 11, 2024
e8b82d1
Added text and navigation info
ronzulu Oct 11, 2024
bbdae56
Minor update
ronzulu Oct 11, 2024
0ab324d
Added section on chaining and repeating commands
ronzulu Oct 11, 2024
b816f9a
Added info about zip and git installation options
ronzulu Oct 12, 2024
c2f6d4d
Added info about grabbing screenshots
ronzulu Oct 12, 2024
62ed6cd
Added more information from the user file set readme
ronzulu Oct 12, 2024
bffb857
More
ronzulu Oct 12, 2024
1b9ceed
More progress
ronzulu Oct 12, 2024
fd0f13c
Minor
ronzulu Oct 13, 2024
9dafdf1
Beefed up the section on help commands
ronzulu Oct 13, 2024
3645759
Added info about help scope
ronzulu Oct 14, 2024
77a9ff0
Partial restructure of file locations
ronzulu Oct 14, 2024
2b51817
Fixing internal references
ronzulu Oct 14, 2024
e40f66d
More moving files around
ronzulu Oct 14, 2024
2e789bc
Started description of dictation mode
ronzulu Oct 14, 2024
e97ff7a
more progress
ronzulu Oct 14, 2024
8ce3a4b
create new folder for command mode pages
ronzulu Oct 15, 2024
b0976bf
added section on saying individual words et
ronzulu Oct 15, 2024
e187fc7
Moved some integration files around
ronzulu Oct 15, 2024
8e7f38f
completed the section on file managers
ronzulu Oct 15, 2024
4575ee4
moved info about talon sack to under help
ronzulu Oct 16, 2024
7626766
edited the info about writing code
ronzulu Oct 16, 2024
5b9990d
added info about writing code
ronzulu Oct 16, 2024
87d7e45
reorganized educational resources to categorize by topic
ronzulu Oct 17, 2024
32ab428
restructured hardware related markdown files
ronzulu Oct 17, 2024
ba2098f
minor
ronzulu Oct 18, 2024
f87f830
info about writing code
ronzulu Oct 19, 2024
d28c896
Added more info about the common commands
ronzulu Oct 19, 2024
402e2f5
minor update
ronzulu Oct 19, 2024
7169e90
minor
ronzulu Oct 19, 2024
e366f8f
minor
ronzulu Oct 20, 2024
49a41be
Minor
ronzulu Oct 22, 2024
6d93468
minor
ronzulu Oct 26, 2024
454c6ea
more minor changes
ronzulu Oct 26, 2024
6147991
various fixes
ronzulu Oct 27, 2024
ae5af80
fixed broken links
ronzulu Oct 27, 2024
cfcb03e
Merge remote-tracking branch 'upstream/main' into restructure
ronzulu Oct 28, 2024
40e6286
minor changes
ronzulu Oct 28, 2024
3061019
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 28, 2024
9aef10b
progress
ronzulu Oct 30, 2024
a94658d
minor
ronzulu Oct 30, 2024
e15fa72
added description of homophones
ronzulu Oct 30, 2024
5cc2338
Merge branch 'restructure' of https://github.com/ronzulu/talon-commun…
ronzulu Oct 30, 2024
69e3ebc
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 30, 2024
1908d58
added info on the benefits of saying words over phrases
ronzulu Oct 31, 2024
254b3ae
progress
ronzulu Oct 31, 2024
5e7320f
more progress
ronzulu Nov 3, 2024
1c0f818
progress
ronzulu Nov 4, 2024
f588591
progress
ronzulu Nov 4, 2024
214d99f
progress
ronzulu Nov 5, 2024
b98120c
progress
ronzulu Nov 5, 2024
360386f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 5, 2024
5462ece
progress
ronzulu Nov 6, 2024
e12d86d
moved the talon framework section from customizations to the resource…
ronzulu Nov 6, 2024
076c264
moved things around again
ronzulu Nov 7, 2024
b05c4eb
progress
ronzulu Nov 7, 2024
bf81800
progress
ronzulu Nov 7, 2024
885495a
progress
ronzulu Nov 7, 2024
3beedd5
progress
ronzulu Nov 7, 2024
e79c25d
minor
ronzulu Nov 7, 2024
8d3ff05
minor
ronzulu Nov 7, 2024
24afda5
progress
ronzulu Nov 7, 2024
817bc7c
progress
ronzulu Nov 8, 2024
c6d12e3
progress
ronzulu Nov 8, 2024
b7275b2
progress
ronzulu Nov 9, 2024
64074ed
progress
ronzulu Nov 10, 2024
bf94ab4
progress
ronzulu Nov 10, 2024
3fbc78c
fixed links etc
ronzulu Nov 11, 2024
666612a
progress
ronzulu Nov 12, 2024
2f4f94b
added info about the macro recorder
ronzulu Nov 12, 2024
c560413
progress
ronzulu Nov 12, 2024
4af7016
custom admonitions for to do and feedback
ronzulu Nov 13, 2024
d2ffce9
progress
ronzulu Nov 13, 2024
d6747e3
progress
ronzulu Nov 13, 2024
9c94981
progress
ronzulu Nov 13, 2024
97e1712
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 13, 2024
9275e6c
progress
ronzulu Nov 13, 2024
eae9f4e
progress
ronzulu Nov 13, 2024
9a463d1
Merge branch 'restructure' of https://github.com/ronzulu/talon-commun…
ronzulu Nov 13, 2024
4bd59c6
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 13, 2024
fe865fd
hopefully fixes icon size issue for new wiki preview admonition types
ronzulu Nov 13, 2024
45ee045
Merge branch 'restructure' of https://github.com/ronzulu/talon-commun…
ronzulu Nov 13, 2024
91d8a9e
added section on customizable subtitles, the talon UI, partially orga…
ronzulu Nov 14, 2024
e746c30
continued organization of IMG folder
ronzulu Nov 14, 2024
699752a
added a section on the talon mode indicator
ronzulu Nov 14, 2024
c9c87cc
added section on microphone selection commands
ronzulu Nov 14, 2024
672acd3
added section on automatic sleeping
ronzulu Nov 14, 2024
dde094d
added section on command history
ronzulu Nov 14, 2024
fc5e2ea
completed the section on working with media
ronzulu Nov 14, 2024
afb4884
add info about find and replace
ronzulu Nov 15, 2024
c571870
minor
ronzulu Nov 15, 2024
be6a502
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 15, 2024
37b386f
minor
ronzulu Nov 18, 2024
c4f6204
Merge branch 'restructure' of https://github.com/ronzulu/talon-commun…
ronzulu Nov 18, 2024
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
Prev Previous commit
Next Next commit
progress
ronzulu committed Nov 13, 2024
commit d2ffce9fa0b9b4a879d2d3790d1556867f5c1545
2 changes: 1 addition & 1 deletion docs/Basic Usage/Command Mode/pc-control.md
Original file line number Diff line number Diff line change
@@ -92,7 +92,7 @@ In a couple of the above commands, the screen number is required, which can be f
| `zoom mouse` | Toggle Control Mouse (Zoom). |
| `control off` | Turn the eye tracker off |

:::warning
:::docofeedback
Should the `camera overlay` command be mentioned here? It calls `tracking.control_debug_toggle()`
:::

2 changes: 1 addition & 1 deletion docs/Basic Usage/Command Mode/text-shortcuts.md
Original file line number Diff line number Diff line change
@@ -214,7 +214,7 @@ and will not reappear after talon is restarted.
| `macro list` | displays a panel that lists all recorded macros (since talon was started) |
| `macro list close` | |

For example, if the following was said:
For example, if the following was said (with a pause after every line):
```
macro record
go top
12 changes: 11 additions & 1 deletion docs/Basic Usage/Command Mode/words-and-phrases.md
Original file line number Diff line number Diff line change
@@ -2,6 +2,16 @@
sidebar_position: 20
---

:::docotodo

There seems to be some commands missing from:
`core\text\text.talon`

For example `recent list`

:::


# Saying Words and Phrases

Whilst in command mode, it's easy to enter a single word or phrase at a time.
@@ -37,7 +47,7 @@ Advantages:

### Interspersing Words and Voice Commands

Words can be interspersed with other voice commands. For example, starting with the following line:
Words can be interspersed with other voice commands. For example, with the following line already in a text editor:

```
are two classes of aliens in science fiction
2 changes: 1 addition & 1 deletion docs/Basic Usage/basic_usage.md
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ Once you have the basics of text input down:
- explore using ordinal repetition for easily [repeating a command](./Command%20Mode/command_mode.md#chaining-and-repeating-commands) without pausing (e.g., saying `go up fifth` will go up five lines)
- window switching (`focus chrome`)

:::warning Also look at controlling specific applications and application tags
:::docotodo Also look at controlling specific applications and application tags

:::

4 changes: 2 additions & 2 deletions docs/Basic Usage/dictation_mode.md
Original file line number Diff line number Diff line change
@@ -152,7 +152,7 @@ staycation

This works as the spoken form and written form of the word are the same, and talon can cleverly infer how to recognize the word from its spelling.

:::warning Fact Check
:::docofeedback Fact Check

Is this correct?
Does this also happen with other recognition engines?
@@ -184,7 +184,7 @@ Entries included in `vocabulary.talon-list` are recognized in:

## Replacement Words

:::warning
:::docofeedback

ronzulu: I am unclear about the purpose of `words_to_replace.csv` and how it differs to `vocabulary.talon-list`.
The default file has the following entries:
2 changes: 1 addition & 1 deletion docs/Basic Usage/talon-modes.md
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@ There are the following ways to keep track of what mode you are in with a visual

2. Install the [Talon HUD](/docs/Integrations/user-interface.md#talon-hud-heads-up-display)

:::warning
:::docotodo
Fix all references to `(https://github.com/talonhub/community/tree`
:::

2 changes: 1 addition & 1 deletion docs/Customization/TalonScript/index.md
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ you may wish to keep them in a `my-talon` subdirectory as a way to [manage your

In general Talon will automatically pick up and apply any changes to `.talon` or `.py` files in your Talon user directory, so you don't have to restart Talon each time you make a change.

:::warning Fact Check
:::docofeedback Fact Check

The original wording only mentioned changes to `.talon` or `.py`.
However, this seems to also apply to `.talon-list` and `.csv` files as well.
2 changes: 1 addition & 1 deletion docs/Customization/overview.md
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ and the list of common websites.

The default entries for the items listed below can all be customized.

:::warning
:::warning Managing Customizations

Before changing any of these files, it is recommended to first read the notes on [managing customizations](./managing-customizations.md)

9 changes: 6 additions & 3 deletions docs/Customization/settings.md
Original file line number Diff line number Diff line change
@@ -19,10 +19,13 @@ Talon settings can be applied from any `.talon` file in the user directory, rega

:::

:::warning need to fix
:::docofeedback

The community user file set read me says something different, that there is a single settings file...
Several options are configurable via a `single settings file` out of the box. Any setting can be made context specific as needed (e.g., per-OS, per-app, etc).
The community user file set read me says something different:

"Several options are configurable via a `single settings file` out of the box. Any setting can be made context specific as needed (e.g., per-OS, per-app, etc)."

Is that poorly worded? My understanding is that settings can be set from any `.talon` file.

:::