From 7a33cf78cdd8ef523e15e1e483882ece31ebcb54 Mon Sep 17 00:00:00 2001 From: duianto Date: Mon, 1 Sep 2025 19:20:18 +0200 Subject: [PATCH] Fix typos "wihthin" was reported on discord by gerb82 (Oded) --- docs/CharaChorder One.rst | 2 +- docs/CharaChorder Two.rst | 4 ++-- docs/CharaChorder X.rst | 2 +- docs/CharaChorder_Lite.rst | 2 +- docs/Device Manager.rst | 12 ++++++------ docs/GenerativeTextMenu.rst | 4 ++-- docs/Glossary.rst | 4 ++-- docs/Layout.rst | 6 +++--- docs/SerialAPI.rst | 8 ++++---- 9 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/CharaChorder One.rst b/docs/CharaChorder One.rst index 03fcb66..9b45cd5 100644 --- a/docs/CharaChorder One.rst +++ b/docs/CharaChorder One.rst @@ -420,7 +420,7 @@ Practice ~~~~~~~~ Now that you’re familiar with your new CharaChorder device, it’s time to -use it! Head over the the :doc:`training section` for instructions +use it! Head over the :doc:`training section` for instructions on how to get started with learning your device. If you want to just jump in without having to read a minute longer, head on over to our training website; https://www.iq-eq.io/#/ diff --git a/docs/CharaChorder Two.rst b/docs/CharaChorder Two.rst index f739407..f37b83e 100644 --- a/docs/CharaChorder Two.rst +++ b/docs/CharaChorder Two.rst @@ -63,7 +63,7 @@ Each CC2 half has nine 5-way switches. Starting from the outside on each half and working inwards, the switches correspond to the following fingers; pinky, ring, middle, and index. The three switches on the inner-most side of each half correspond to the thumb. You can see -what characters are on each switch in :doc:`Layout`. Additionally, +what characters are on each switch in the :doc:`CC English Layout`. Additionally, there are two switches off the “home-row” which can be accessed by the ring and middle fingers. @@ -393,7 +393,7 @@ Practice ~~~~~~~~ Now that you’re familiar with your new CharaChorder device, it’s time to -use it! Head over the the :doc:`training section` for instructions +use it! Head over the :doc:`training section` for instructions on how to get started with learning your device. If you want to just jump in without having to read a minute longer, head on over to our training website; https://www.iq-eq.io/#/ diff --git a/docs/CharaChorder X.rst b/docs/CharaChorder X.rst index 155c196..5e639dd 100644 --- a/docs/CharaChorder X.rst +++ b/docs/CharaChorder X.rst @@ -279,7 +279,7 @@ Practice ~~~~~~~~ Now that you’re familiar with your new CharaChorder device, it’s time to -use it! Head over the the :doc:`training section` for instructions +use it! Head over the :doc:`training section` for instructions on how to get started with learning your device. If you want to just jump in without having to read a minute longer, head on over to our training website; https://www.iq-eq.io/#/ diff --git a/docs/CharaChorder_Lite.rst b/docs/CharaChorder_Lite.rst index 9c6c09d..4a69987 100644 --- a/docs/CharaChorder_Lite.rst +++ b/docs/CharaChorder_Lite.rst @@ -64,7 +64,7 @@ Back: Key Plate ^^^^^^^^^ -The Lite's Key Plate is also made of ABS plastic, designed and assembed in America. +The Lite's Key Plate is also made of ABS plastic, designed and assembled in America. External Parts diff --git a/docs/Device Manager.rst b/docs/Device Manager.rst index 50479f8..33b5cb0 100644 --- a/docs/Device Manager.rst +++ b/docs/Device Manager.rst @@ -89,11 +89,11 @@ Undo and Redo :width: 200 :alt: The Undo and Redo arrows -Near the top left corner, the device manager has handy undo and redo buttons which do exactly what their names describe. If you're making changes to your layout, your chords, or your layout, you can step back, one change at a time, all the way back to the very first change that you made during that session. Once you're stepped back, you can step forward to redo the change(s) that was/were undone. +Near the top left corner, the device manager has handy undo and redo buttons which do exactly what their names describe. If you're making changes to your layout, your chords, or your settings, you can step back, one change at a time, all the way back to the very first change that you made during that session. Once you're stepped back, you can step forward to redo the change(s) that was/were undone. Color Scheme ------------ -On the bottom right of the device manager, you'll see a circle with a solid color. Hovering over this circle will reveal the label "color scheme." You can click this circle to change the color scheme of the device manager. In the color scheme menu, you can choose your preferred color using a color pallette, an RGB color system, or by clicking the dropper icon to choose a color on your screen. +On the bottom right of the device manager, you'll see a circle with a solid color. Hovering over this circle will reveal the label "color scheme." You can click this circle to change the color scheme of the device manager. In the color scheme menu, you can choose your preferred color using a color palette, an RGB color system, or by clicking the dropper icon to choose a color on your screen. .. image:: /assets/images/ManagerColorScheme.png :width: 300 @@ -101,7 +101,7 @@ On the bottom right of the device manager, you'll see a circle with a solid colo Light and Dark Mode ------------------- -Also in the bottom right-hand corner, you'll find a sun or moon icon where you can toggle between light and dark mode. This toggle can help those who would rather a brighter screen to see better or a darker screen to reduce eye strain. +Also in the bottom right-hand corner, you'll find a sun or moon icon where you can toggle between light and dark mode. This toggle can help those who would rather have a brighter screen to see better or a darker screen to reduce eye strain. Save Button ----------- @@ -213,13 +213,13 @@ Arpeggiates Arpeggiate actions are timed actions that can modify a :ref:`chord` after the chord is performed. A quick example of this is the use of :ref:`chord modifiers` after you perform the chord. You can read that section for information on how the chord modifiers work. - With arpeggiates enabled, you can chord the word run and then, within the :ref:`arpeggiate timeout window`, press the :ref:`past tense modifier` for the word to be “modified” into its past tense variant; in english, ran. + With arpeggiates enabled, you can chord the word run and then, within the :ref:`arpeggiate timeout window`, press the :ref:`past tense modifier` for the word to be “modified” into its past tense variant; in English, ran. .. image:: /assets/images/ManagerSettingsArpeggiates.png :width: 1200 :alt: The Arpeggiates settings box -In this box, ou can enable or disable arpeggiates as well as increase or decrease the :ref:`arpeggiate timeout setting`. +In this box, you can enable or disable arpeggiates as well as increase or decrease the :ref:`arpeggiate timeout setting`. Chord Modifiers --------------- @@ -276,7 +276,7 @@ Character Entry --------------- .. dropdown:: What is Character Entry? - Character entry, known to the CharaChorder community as "chentry," refers to typing one character at time. + Character entry, known to the CharaChorder community as "chentry", refers to typing one character at time. .. image:: /assets/images/ManagerSettingsChentry.png :width: 1200 diff --git a/docs/GenerativeTextMenu.rst b/docs/GenerativeTextMenu.rst index cbba995..be5ea41 100644 --- a/docs/GenerativeTextMenu.rst +++ b/docs/GenerativeTextMenu.rst @@ -515,7 +515,7 @@ Realtime Feedback This setting toggles realtime feedback ON or OFF. -Realtime feedback refers to the helpful text like ``SPURRING_ON``, ``SPURRING_OFF`` etc, that lets the user know if a certain mode has been activated or deactivated on the CharaChorder device. Since there is no other visual way to know if the chord used to enable or disable certain settings, it is helpful to have these texts pop up as confirmation. +Realtime feedback refers to the helpful text like ``SPURRING_ON``, ``SPURRING_OFF`` etc., that lets the user know if a certain mode has been activated or deactivated on the CharaChorder device. Since there is no other visual way to know if the chord used to enable or disable certain settings, it is helpful to have these texts pop up as confirmation. .. Note:: The realtime feedback setting controls the :ref:`startup` setting. If realtime feedback is OFF, then startup will be OFF, regardless of that setting's individual toggle. @@ -585,7 +585,7 @@ This setting lets you adjust the brightness of the LED backlights on your CharaC Please note that LEDs are NOT individually addressable as of December of 2023. The brightness setting adjusts the brightness for ALL LEDs equally. .. note:: - If you are using a low power usb bank or port, having a high LED brightness may lead to issues with your CharaChorder Lite's power. If you have issues on your device that seem to keep your CharaChorder Lite from properly powering on or staying on, it may be a good idea to lower this setting. + If you are using a low power USB bank or port, having a high LED brightness may lead to issues with your CharaChorder Lite's power. If you have issues on your device that seem to keep your CharaChorder Lite from properly powering on or staying on, it may be a good idea to lower this setting. You can find the default settings for the CharaChorder Lite in the table below: diff --git a/docs/Glossary.rst b/docs/Glossary.rst index cd3cfed..25d8620 100644 --- a/docs/Glossary.rst +++ b/docs/Glossary.rst @@ -32,7 +32,7 @@ community. capitalization, conjugation, part of speech, language, or structure of a chord. Note, these can be used arpeggiately. :ref:`Compound Chords` - Multiple chords which behave differently when used together consecutively wihthin the :ref:`Compound timeout`. + Multiple chords which behave differently when used together consecutively within the :ref:`Compound timeout`. Example: know + ledge = knowledge. Cursor Warping @@ -50,7 +50,7 @@ community. When an action code activates a specific library, subsequent chord creation automatically groups new chords within that library's structure, allowing for context- - specific chord sets (e.g., multiligual, coding, email) that can be + specific chord sets (e.g., multilingual, coding, email) that can be programmatically switched during use. Forced Chord Phenomenon diff --git a/docs/Layout.rst b/docs/Layout.rst index aefe109..2d2d206 100644 --- a/docs/Layout.rst +++ b/docs/Layout.rst @@ -54,7 +54,7 @@ First of all, here are some pitfalls You can use right-alt to access special characters. Holding right-alt and pressing `q` will give you an `ä`. -The other solution is to use your local layout and mentally remap. So if you wanted to type the cyrillic `Ф`, you set the Russian layout on your OS, and map the key to `a` (which will send the key-code that corresponds to Ф on a Russian layout) +The other solution is to use your local layout and mentally remap. So if you wanted to type the Cyrillic `Ф`, you set the Russian layout on your OS, and map the key to `a` (which will send the key-code that corresponds to Ф on a Russian layout) What's even going on? ^^^^^^^^^^^^^^^^^^^^^ @@ -63,7 +63,7 @@ Intuitively you'd expect keyboards to send the letter that's printed on the key Keyboards send what's called a **key-code** to the operating system, which is the ID of the key pressed. This key-code stands in no relation to the actual letter typed, it's up to the OS to turn it into an actual character. This mapping is described by a keyboard layout, which *cannot* be set by the device itself, it *must* be applied on your operating system. -The only convention here is *where* the keys are located - *on a standard layout keyboard*. There are a few standardised locations based on the US keyboard layout, like the ASCII character set, the GUI/Windows key, CTRL, SHIFT etc. However all or most of these assume a US-Layout. +The only convention here is *where* the keys are located - *on a standard layout keyboard*. There are a few standardized locations based on the US keyboard layout, like the ASCII character set, the GUI/Windows key, CTRL, SHIFT etc. However all or most of these assume a US-Layout. There is no standard for other typing input devices, nor is there a way for the device to know what layout is selected by the OS. @@ -75,7 +75,7 @@ If you set a layout on the CCOS, it moves the key-code locations around. .. warning:: Setting the letter `a` on a switch doesn't actually send "print a" to the computer - it sends a "key where the a would be on the us layout pressed" to the OS**. -So how can I add äöüß etc when it's not on the US layout? +So how can I add äöüß etc. when it's not on the US layout? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ There is a special feature on Windows that allows you to directly type *any* Unicode character with your keyboard, by holding `alt` and typing a numeric code. diff --git a/docs/SerialAPI.rst b/docs/SerialAPI.rst index f1f71d9..341f1ba 100644 --- a/docs/SerialAPI.rst +++ b/docs/SerialAPI.rst @@ -318,7 +318,7 @@ CMD_VAR_COMMIT "INPUT","1","SubCommand","Hexadecimal VAR Code","B0","Commit parameters to memory" "OUTPUT","0","Command","Chars","VAR","" "OUTPUT","1","SubCommand","Hexadecimal VAR Code","B0","" - "OUTPUT","2","Success","Boolean Number","0","This will be 0 on success, or greater than zero for an error if there was a problem commiting" + "OUTPUT","2","Success","Boolean Number","0","This will be 0 on success, or greater than zero for an error if there was a problem committing" Example(s): @@ -340,7 +340,7 @@ CMD_VAR_GET_PARAMETER "OUTPUT","1","SubCommand","Hexadecimal VAR Code","B1","" "OUTPUT","2","Parameter Code","Hexadecimal Parameter Code","0x15","" "OUTPUT","3","Data Out","Decimal Number","7","" - "OUTPUT","4","Success","Boolean Number","0","This will be 0 on success, or greater than zero for an error if the VAR Code or Parameter Code doesnt exist" + "OUTPUT","4","Success","Boolean Number","0","This will be 0 on success, or greater than zero for an error if the VAR Code or Parameter Code doesn't exist" Example(s): @@ -448,13 +448,13 @@ RST SubCommands "STARTER","Adds starter chordmaps. This does not clear the chordmap library, but adds to it, replacing those that have the same chord." "CLEARCML","Permanently deletes all the chordmaps stored in the device memory." "UPGRADECML","Attempts to upgrade chordmaps that the system detects are older. This is under development." - "FUNC","Adds back in functional chords such as CAPSLOCKS and Backspace-X chords." + "FUNC","Adds back in functional chords such as CAPSLOCK and Backspace-X chords." RAM ~~~ -The `RAM` command returns the current number of bytes availabe in SRAM. This is useful for debugging when there is a suspected heap or stack issue. +The `RAM` command returns the current number of bytes available in SRAM. This is useful for debugging when there is a suspected heap or stack issue. .. csv-table:: :header: "I/O","Index","Name","Type","Example","Notes"