diff --git a/docs/Beta Releases.rst b/docs/Beta Releases.rst index e716c52..a0ea47c 100644 --- a/docs/Beta Releases.rst +++ b/docs/Beta Releases.rst @@ -256,10 +256,10 @@ There was a bug that could cause library corruption which has now been fixed. Th CC Lite S2 Fixes ~~~~~~~~~~~~~~~~ -Fixed swapped Right Shift and Quote keys +Fixed swapped RIGHT SHIFT and Quote keys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Right Shift typed a single quote, and the single quote key behaved as Right Shift. +RIGHT SHIFT typed a single quote, and the single quote key behaved as RIGHT SHIFT. CC One Fixes ~~~~~~~~~~~~ diff --git a/docs/CharaChorder One.rst b/docs/CharaChorder One.rst index 03fcb66..5375337 100644 --- a/docs/CharaChorder One.rst +++ b/docs/CharaChorder One.rst @@ -334,7 +334,7 @@ A2 Layer The A2 layer, sometimes referred to as the “number layer”, is accessible with the :doc:`A2 access key`. In the above :ref:`graphic`, you’ll see this labeled -as “num-shift.” In the `Device Manager `__, +as “num-shift”. In the `Device Manager `__, this key has the name “Numeric Layer (Left)” and “Numeric Layer (Right)”, one for each side of the CharaChorder. @@ -374,27 +374,27 @@ while the target key is pressed. EXAMPLE: On the CC English layout, you can access the F1 key by pressing and holding either pinky down, into the device, and adding the letter ``a`` or ``r`` (location of number 1 on the default layout) to it. -Shift Modifier +SHIFT Modifier ^^^^^^^^^^^^^^ -On top of the three aforementioned layers, the :doc:`Shift key`, which is a :doc:`modifier`, can be used to access some extra keys. The Shift keypress works just like it +On top of the three aforementioned layers, the :doc:`SHIFT key`, which is a :doc:`modifier`, can be used to access some extra keys. The SHIFT keypress works just like it would on a traditional keyboard. You can capitalize letters and access symbols attached to numbers. This works with any key on any layer, just -like other modifiers (such as Ctrl and Alt). The Shift modifier output +like other modifiers (such as CTRL and ALT). The SHIFT modifier output is currently controlled by the Operating System that your CharaChorder is plugged to, and it is not possible to customize their outputs. In the above graphic, you’ll see -the Shift key labeled as “Shift”. In the `Device Manager `__, +the SHIFT key labeled as “Shift”. In the `Device Manager `__, this key has the name “Shift Keyboard Modifier (Left)” and “Shift Keyboard Modifier (Right)”, one for each side of the CharaChorder. -By default, the Shift is accessible by pressing and holding either pinky +By default, the SHIFT is accessible by pressing and holding either pinky finger inwards, that is, east on the left pinky or west on the right pinky. You do not have to hold them both, only one is required. Any key -that requires the Shift Modifier can only be accessed by pressing and -holding the Shift key along with the target key. You do not need to -:doc:`chord` the keys together; it’s only required that the Shift +that requires the SHIFT Modifier can only be accessed by pressing and +holding the SHIFT key along with the target key. You do not need to +:doc:`chord` the keys together; it’s only required that the SHIFT key is pressed while the target key is pressed. .. note:: diff --git a/docs/CharaChorder Two.rst b/docs/CharaChorder Two.rst index f739407..b0237c7 100644 --- a/docs/CharaChorder Two.rst +++ b/docs/CharaChorder Two.rst @@ -347,27 +347,27 @@ while the target key is pressed. EXAMPLE: On the CC English layout, you can access the F1 key by pressing and holding either pinky down, into the device, and adding the letter ``a`` or ``r`` (location of number 1 on the default layout) to it. -Shift Modifier +SHIFT Modifier ^^^^^^^^^^^^^^ -On top of the three aforementioned layers, the :doc:`Shift key`, which is a :doc:`modifier`, can be used to access some extra keys. The Shift keypress works just like it +On top of the three aforementioned layers, the :doc:`SHIFT key`, which is a :doc:`modifier`, can be used to access some extra keys. The SHIFT keypress works just like it would on a traditional keyboard. You can capitalize letters and access symbols attached to numbers. This works with any key on any layer, just -like other modifiers (such as Ctrl and Alt). The Shift modifier output +like other modifiers (such as CTRL and ALT). The SHIFT modifier output is currently controlled by the Operating System that your CharaChorder is plugged to, and it is not possible to customize their outputs. In the above :ref:`graphic`, you’ll see -the Shift key labeled as “⇧”. In the `Device Manager `__, +the SHIFT key labeled as “⇧”. In the `Device Manager `__, this key has the name “Shift Keyboard Modifier (Left)” and “Shift Keyboard Modifier (Right)”, one for each half of the CharaChorder. -By default, the Shift is accessible by pressing and holding either pinky +By default, the SHIFT is accessible by pressing and holding either pinky finger inwards, that is, east on the left pinky or west on the right pinky. You do not have to hold them both, only one is required. Any key -that requires the Shift Modifier can only be accessed by pressing and -holding the Shift key along with the target key. You do not need to -:doc:`chord` the keys together; it’s only required that the Shift +that requires the SHIFT Modifier can only be accessed by pressing and +holding the SHIFT key along with the target key. You do not need to +:doc:`chord` the keys together; it’s only required that the SHIFT key is pressed while the target key is pressed. .. note:: diff --git a/docs/CharaChorder X.rst b/docs/CharaChorder X.rst index 155c196..8dd28d4 100644 --- a/docs/CharaChorder X.rst +++ b/docs/CharaChorder X.rst @@ -247,13 +247,13 @@ along with the target key. You do not need to :doc:`chord` the keys together; it’s only required that the A3 layer access key is pressed while the target key is pressed. -Shift Modifier +SHIFT Modifier ^^^^^^^^^^^^^^ -On top of the three aforementioned layers, the :doc:`Shift key`, which is a :doc:`modifier`, can be used to access some extra keys. The Shift keypress works just like it +On top of the three aforementioned layers, the :doc:`SHIFT key`, which is a :doc:`modifier`, can be used to access some extra keys. The SHIFT keypress works just like it would on a traditional keyboard. You can capitalize letters and access symbols attached to numbers. This works with any key on any layer, just -like other modifiers (such as CTRL and ALT). The Shift modifier output +like other modifiers (such as CTRL and ALT). The SHIFT modifier output is currently controlled by the Operating System that your CharaChorder is plugged to, and it is not possible to customize their outputs. @@ -261,10 +261,10 @@ In the `Device Manager `__, this key has the name “Shift Keyboard Modifier (Left)” and “Shift Keyboard Modifier (Right)”, one for each side of the keyboard. -The Shift is accessible by pressing the key labeled "Shift" on your keyboard. Any key -that requires the Shift Modifier can only be accessed by pressing and -holding the Shift key along with the target key. You do not need to -:doc:`chord` the keys together; it’s only required that the Shift +The SHIFT is accessible by pressing the key labeled "Shift" on your keyboard. Any key +that requires the SHIFT Modifier can only be accessed by pressing and +holding the SHIFT key along with the target key. You do not need to +:doc:`chord` the keys together; it’s only required that the SHIFT key is pressed while the target key is pressed. Configurability diff --git a/docs/CharaChorder_Lite.rst b/docs/CharaChorder_Lite.rst index 9c6c09d..2e2f987 100644 --- a/docs/CharaChorder_Lite.rst +++ b/docs/CharaChorder_Lite.rst @@ -245,7 +245,7 @@ device’s settings; all you need is a place to type text. We call these settings the Generative Text Menu, or :doc:`GTM` for short. On the CharaChorder Lite, you can access the :doc:`GTM` by -:doc:`chording` the right ``ALT`` key and the letter ``G``. +:doc:`chording` the ``RIGHT ALT`` key and the letter ``G``. Once you perform the chord to call up the :doc:`GTM`, your CharaChorder will type out the menu and its options. It will look something like this: @@ -282,7 +282,7 @@ The CharaChorder Lite's layout is mostly traditional QWERTY. All of the letters Earlier, we explained that the CharaChorder Lite is a 60% keyboard. It's been named that because it's missing the navigation keys usually present on 65% keyboards, though it still has four arrow keys. Therefore, it is accurate to refer to the CCL as a 60%+6 keyboard, where the 6 refers to keys that aren't usually on a 60% keyboard. Additionally, the CCL has 67 keys, instead of the 61 keys that 60% keyboards traditionally have. -Keys that are included are on the CharaChorder Lite are the 26 letters of the English alphabet, the 10 number keys (along with their SHIFT variants), a single backspace, one ``TAB`` key, opening (``[``) and closing (``]``) bracket keys as well as their SHIFT variants, a backslash (``\``) and its SHIFT variant, a CAPSLOCK key, a colon (``:``) key and its SHIFT variant, an apostrophe (``'``) and its SHIFT variant, an ``ENTER`` key, a full-size ``SHIFT`` key on the left as well as a smaller ``SHIFT`` key on the right side, comma (``,``), period (``.``), and forward slash (``/``) keys and their SHIFT variants, a small ``DELETE`` key, a ``GUI`` key on the left and one on the right (Windows key, Command key, Super key, etc), a single ``CONTROL`` key, ``LEFT ALT`` and ``RIGHT ALT`` keys, two space keys, two :ref:`A2 layer access keys` labeled ``Fn``, and four arrow keys. +Keys that are included are on the CharaChorder Lite are the 26 letters of the English alphabet, the 10 number keys (along with their SHIFT variants), a single ``BACKSPACE``, one ``TAB`` key, opening (``[``) and closing (``]``) bracket keys as well as their SHIFT variants, a backslash (``\``) and its SHIFT variant, a CAPSLOCK key, a colon (``:``) key and its SHIFT variant, an apostrophe (``'``) and its SHIFT variant, an ``ENTER`` key, a full-size ``SHIFT`` key on the left as well as a smaller ``SHIFT`` key on the right side, comma (``,``), period (``.``), and forward slash (``/``) keys and their SHIFT variants, a small ``DELETE`` key, a ``GUI`` key on the left and one on the right (Windows key, Command key, Super key, etc), a single ``CONTROL`` key, ``LEFT ALT`` and ``RIGHT ALT`` keys, two space keys, two :ref:`A2 layer access keys` labeled ``Fn``, and four arrow keys. Layers ~~~~~~ @@ -352,34 +352,34 @@ while the target key is pressed. :alt: The default A3 layer on the CharaChorder Lite -Shift Modifier +SHIFT Modifier ^^^^^^^^^^^^^^ -On top of the three aforementioned layers, the :doc:`Shift key`, which is a :doc:`keyboard modifier`, can be used to access some extra keys. The Shift key press works just like it +On top of the three aforementioned layers, the :doc:`SHIFT key`, which is a :doc:`keyboard modifier`, can be used to access some extra keys. The SHIFT key press works just like it would on a traditional keyboard. You can capitalize letters and access symbols attached to numbers. This works with any key on any layer, just -like other keyboard modifiers (such as Ctrl and Alt). The Shift modifier output +like other keyboard modifiers (such as CTRL and ALT). The SHIFT modifier output is currently controlled by the Operating System that your CharaChorder is plugged to, and it is not possible to customize their outputs. On the :doc:`CharaChorder Device Manager`, -this key has the name “Left_Shift” and “Right_Shift”, one for each side +this key has the name “LEFT_SHIFT” and “RIGHT_SHIFT”, one for each side of the CharaChorder. -By default, the Shift is accessible by pressing and holding either Shift Key. You do not have to hold them both, only one is required. Any key -that requires the Shift Modifier can only be accessed by pressing and -holding the Shift key along with the target key. You do not need to -:doc:`chord` the keys together; it’s only required that the Shift +By default, the SHIFT is accessible by pressing and holding either SHIFT Key. You do not have to hold them both, only one is required. Any key +that requires the SHIFT Modifier can only be accessed by pressing and +holding the SHIFT key along with the target key. You do not need to +:doc:`chord` the keys together; it’s only required that the SHIFT key is pressed while the target key is pressed. AltGraph Modifier ^^^^^^^^^^^^^^^^^ -While using the US INTL OS layout on your computer, you can take advantage of a modifier known as AltGraph, AltGr, or right alt. This keyboard modifier is used to provide additional graphemes for most keys. You can use the AltGraph modifier to create accented characters such as á, é, í, ó, ú, among others. +While using the US INTL OS layout on your computer, you can take advantage of a modifier known as AltGraph, AltGr, or RIGHT ALT. This keyboard modifier is used to provide additional graphemes for most keys. You can use the AltGraph modifier to create accented characters such as á, é, í, ó, ú, among others. The AltGraph modifier output is currently controlled by the Operating System that your CharaChorder is plugged into, and it is not possible to customize their outputs. Those outputs are determined by the computer's OS. -By default, the right alt is accessible by pressing and holding the right alt. You do not need to +By default, the RIGHT ALT is accessible by pressing and holding the RIGHT ALT. You do not need to :doc:`chord` the keys together; it’s only required that the AltGraph key is pressed while the target key is pressed. On the :doc:`CharaChorder Device Manager`, this key has the name “AltGraph”. diff --git a/docs/Chords.rst b/docs/Chords.rst index f8a37ff..d562064 100644 --- a/docs/Chords.rst +++ b/docs/Chords.rst @@ -162,11 +162,11 @@ OUTPUT 5. CONFIRM INPUT coded chord ``i+DUP``. 3. Follow the prompt and type your output in character entry mode. (example: >IIIIII`) and replace them with the intended chord. +This feature allows users to misfire chords, yet be able to correct them by quickly performing the chord correctly, without having to BACKSPACE manually to erase the misfired chord. The result is that the timeout will automatically BACKSPACE all of the preceding characters (up to the last :doc:`breaking character `) and replace them with the intended chord. You can set this setting to be as low as 0.0 seconds (s) or as high as 25.0 seconds (s), being able to adapt it to your individual :doc:`chording` style. @@ -494,7 +494,7 @@ Arpeggiate Timeout The arpeggiate timeout is a window of time after a chord is performed during which CCOS will expect arpeggiates to be performed. After this timer runs out, CCOS will NO LONGER modify the preceding chord. -A common issue that users may run into while having arpeggiates enabled is the shift key modifying the preceding chord instead of the next key. For this reason, some users lower the arpeggiate timeout to a really low amount of time in order to reduce the possibility of this happening unintentionally. +A common issue that users may run into while having arpeggiates enabled is the SHIFT key modifying the preceding chord instead of the next key. For this reason, some users lower the arpeggiate timeout to a really low amount of time in order to reduce the possibility of this happening unintentionally. Display ------- diff --git a/docs/Layout.rst b/docs/Layout.rst index aefe109..746ee3a 100644 --- a/docs/Layout.rst +++ b/docs/Layout.rst @@ -40,10 +40,10 @@ TL;DR, so what does this mean for me? First of all, here are some pitfalls -* If you set for example `$`, the CCOS types this as "hold shift press 4 release shift". +* If you set for example `$`, the CCOS types this as "hold SHIFT press 4 release SHIFT". Meaning if you press `$` and `3` together, **you'll actually type "$#" instead of "$3"** - because the CCOS needs to hold shift for typing the `$` sign - - *Avoid putting characters that need shift and normal characters on the same layer* + because the CCOS needs to hold SHIFT for typing the `$` sign + - *Avoid putting characters that need SHIFT and normal characters on the same layer* * Using for example a German layout on the OS will swap z and y, just like on a normal keyboard. * Using any non-ASCII, non-Chara, non-keyboard characters will *only* work on Windows. * The hacks used by Chara can have unexpected consequences in some programs which intercept raw input @@ -51,8 +51,8 @@ First of all, here are some pitfalls .. tip:: The easiest solution is use `US-Intl `_ on your OS. - You can use right-alt to access special characters. - Holding right-alt and pressing `q` will give you an `ä`. + 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) @@ -78,10 +78,10 @@ If you set a layout on the CCOS, it moves the key-code locations around. 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. +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. .. warning:: - Setting the letter `ä` on a switch means the device sends "hold alt press 0 press 2 press 2 press 8 release alt". + Setting the letter `ä` on a switch means the device sends "hold ALT press 0 press 2 press 2 press 8 release ALT". Because this is a Windows feature, this only works on Windows. However even this is *not* layout agnostic. Using a layout that moves letters around, like Programmer Dvorak, will completely mess up this hack as well. diff --git a/docs/Master Forge.rst b/docs/Master Forge.rst index 881cb18..25da247 100644 --- a/docs/Master Forge.rst +++ b/docs/Master Forge.rst @@ -55,7 +55,7 @@ The front of each digitizer has a slotted rail which allows :doc:`bolt-ons`. In order to perform a chord, you must press all of the :ref:`input keys` at the same time, within the :ref:`press time limit`. Additionally, you must release all of the keys at the same time, that is, within the :ref:`release time limit`. Once these steps are performed accurately, your CCOS device will, very quickly, type the keys pressed, backspace them, and then output the predetermined chord. + A chord is a type of input that allows you to press multiple keys at a time in order to achieve a predetermined :ref:`output`. In order to perform a chord, you must press all of the :ref:`input keys` at the same time, within the :ref:`press time limit`. Additionally, you must release all of the keys at the same time, that is, within the :ref:`release time limit`. Once these steps are performed accurately, your CCOS device will, very quickly, type the keys pressed, BACKSPACE them, and then output the predetermined chord. We can test out your preloaded chords, of which there are 500, by :doc:`chording` both index fingers South, towards your body. You might need to play around with the timing a bit. Just remember that you have to press both switches together, at the same time, and then release them at the same time. As mentioned before, it might take a bit of playing around with the timing, but, eventually, you should see the word "the" output onto your typing space. Congratulations! You just performed a chord! @@ -568,7 +568,7 @@ By default, the A3 Layer is accessible by [INFO]. You do not have to hold them b pressing and holding [INFO] and adding the letter ``a`` or ``r`` (location of number 1 on the default layout) to it. -Shift Modifier +SHIFT Modifier ^^^^^^^^^^^^^^ .. dropdown:: List of shifted key actions @@ -603,23 +603,23 @@ Shift Modifier -On top of the three aforementioned layers, the :doc:`Shift key`, which is a :doc:`modifier`, can be used to access some extra keys. The Shift keypress works just like it +On top of the three aforementioned layers, the :doc:`SHIFT key`, which is a :doc:`modifier`, can be used to access some extra keys. The SHIFT keypress works just like it would on a traditional keyboard. You can capitalize letters and access symbols attached to numbers. This works with any key on any layer, just -like other modifiers (such as Ctrl and Alt). The Shift modifier output +like other modifiers (such as CTRL and ALT). The SHIFT modifier output is currently controlled by the Operating System that your Forge is plugged into, and it is not possible to customize their outputs. In the above graphic, you’ll see -the Shift key labeled as “Shift”. In the `Device Manager `__, +the SHIFT key labeled as “Shift”. In the `Device Manager `__, this key has the name “Shift Keyboard Modifier (Left)” and “Shift Keyboard Modifier (Right)”, one for each :ref:`digitizer`. -By default, the Shift is accessible by pressing and holding either pinky +By default, the SHIFT is accessible by pressing and holding either pinky finger inwards, that is, east on the left pinky or west on the right pinky. You do not have to hold them both, only one is required. Any key -that requires the Shift Modifier can only be accessed by pressing and -holding the Shift key along with the target key. You do not need to -:doc:`chord` the keys together; it’s only required that the Shift +that requires the SHIFT Modifier can only be accessed by pressing and +holding the SHIFT key along with the target key. You do not need to +:doc:`chord` the keys together; it’s only required that the SHIFT key is pressed while the target key is pressed. .. note:: @@ -644,7 +644,7 @@ works and how to remap your device, visit the :ref:`remapping section`__ in November of 2023, CharaChorder began taking pre-orders offering everyone the same bundle. In September of 2024, CharaChorder ran a `Kickstarter `__ campaign for the Master Forge for 5 weeks, offering three different tiers, each with a different configuration. After the Kickstarter campaign finished, the Master Forge went on back-order sale on the `Forge website `__. The following section identifies what each of these 5 bundles included. +When the Master Forge was `unveiled `__ in November of 2023, CharaChorder began taking pre-orders offering everyone the same bundle. In September of 2024, CharaChorder ran a `Kickstarter `__ campaign for the Master Forge for 5 weeks, offering three different tiers, each with a different configuration. After the Kickstarter campaign finished, the Master Forge went on back-order sale on the `Forge website `__. The following section identifies what each of these 5 bundles included. Forge Website Pre-Orders ------------------------ diff --git a/docs/SerialAPI.rst b/docs/SerialAPI.rst index f1f71d9..8142338 100644 --- a/docs/SerialAPI.rst +++ b/docs/SerialAPI.rst @@ -448,7 +448,7 @@ 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 CAPSLOCKS and BACKSPACE-X chords." RAM