From 45183dd4545e7988bb26c9fea87299af979e8dfb Mon Sep 17 00:00:00 2001 From: duianto Date: Fri, 24 Oct 2025 22:04:09 +0200 Subject: [PATCH 1/3] New page, chord modifiers Moved from the Chord Modifiers section on the Device Manager page. --- docs/Chord Modifiers.rst | 49 +++++++++++++++++++++++++++++++++-- docs/Device Manager.rst | 55 ++-------------------------------------- docs/index.rst | 1 + 3 files changed, 50 insertions(+), 55 deletions(-) diff --git a/docs/Chord Modifiers.rst b/docs/Chord Modifiers.rst index c79edaa..a9d7be1 100644 --- a/docs/Chord Modifiers.rst +++ b/docs/Chord Modifiers.rst @@ -1,5 +1,50 @@ -.. only:: internal_build Chord Modifiers =============== -WIP +.. dropdown:: What are chord modifiers? + + Chord modifiers are actions that change a chord when :ref:`chorded` at the same time as the :ref:`chord input`, or when pressed immediately after (arpeggiately) the :ref:`chord`, provided that :ref:`arpeggiates` are enabled. + + As of February of 2024, only the CharaChorder One and CharaChorder Lite support the use of chord modifiers. Additionally, as of that same time, chord modifiers only work in English. + + .. note:: + Chord modifiers are NOT the same as keyboard modifiers. Keyboard modifiers affect keys pressed on a keyboard. Those keys include ``CTRL``, ``ALT``, and ``FN``. Chord modifiers affect chords. + +.. image:: /assets/images/ManagerSettingsModifiers.png + :width: 1200 + :alt: The Chord Modifiers settings box + +In this box, you can read a brief explanation of chord modifiers and how to access them. + +Capitalization +~~~~~~~~~~~~~~ +The capitalization modifier modifies any chord so that the first letter is capitalized on :ref:`output`. This modifier can be performed together with a :ref:`chord` or :ref:`arpeggiately`. + +The capitalization modifier is located on the ``SHIFT`` key. In the :ref:`layout editor`, this key can be either "Shift Keyboard Modifier (Left)" or "Shift Keyboard Modifier (Right)". + +.. note:: + If you have ``CAPS LOCK`` active, all letters in a chord will be capitalized except the first one when using this modifier. + +Present Tense +~~~~~~~~~~~~~ +The present tense modifier modifies supported chords so that they turn into their present tense variants. The word "run" would be modified into "running" and the word "work" would be turned into "working". This modifier can be performed together with a :ref:`chord` or :ref:`arpeggiately`. + +The present tense modifier has different locations depending on your device. On the CharaChorder One, this modifier is linked to the "AMBIDEXTROUS THROWOVER (LEFT)" key. On the CharaChorder Lite, it's linked to the "NUMERIC LAYER (LEFT)" key. + +Pluralizer +~~~~~~~~~~ +The pluralizer modifier makes supported chords plural. It will add an "s" or "es" to the end of supported chords. "Box" will turn into "boxes" and "dog" will become "dogs". This modifier can be performed together with a :ref:`chord` or :ref:`arpeggiately`. + +The pluralizer modifier has different locations depending on your device. On the CharaChorder One, it's linked to the "AMBIDEXTROUS THROWOVER (RIGHT)" key. On the CharaChorder Lite, it's linked to the "RIGHT SPACEBAR" key, not to be confused with the "SPACE" key. + +Past Tense +~~~~~~~~~~ +The past tense modifier modifies supported chords so that they turn into their past tense variants. The word "run" would be modified into "ran". The word "work" would be turned into "worked". This modifier can be performed together with a :ref:`chord` or :ref:`arpeggiately`. + +The past tense modifier has different locations depending on your device. On the CharaChorder One, it's linked to the "NUMERIC LAYER (LEFT)" key. On the CharaChorder Lite, it's linked to the "SPACE" key, not to be confused with the "RIGHT SPACEBAR" key. + +Comparative +~~~~~~~~~~~ +The comparative modifier modifies supported chords so that they turn into their comparative variant. "Big" becomes "bigger" and "small" turns into "smaller". This modifier can be performed together with a :ref:`chord` or :ref:`arpeggiately`. + +The comparative modifier is located on the "NUMERIC LAYER (RIGHT)" key on both the CharaChorder One and the CharaChorder Lite. diff --git a/docs/Device Manager.rst b/docs/Device Manager.rst index 50479f8..81736c8 100644 --- a/docs/Device Manager.rst +++ b/docs/Device Manager.rst @@ -211,9 +211,9 @@ Arpeggiates ----------- .. dropdown:: What are 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. + 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 :doc:`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 @@ -221,57 +221,6 @@ Arpeggiates In this box, ou can enable or disable arpeggiates as well as increase or decrease the :ref:`arpeggiate timeout setting`. -Chord Modifiers ---------------- -.. dropdown:: What are chord modifiers? - - Chord modifiers are actions that change a chord when :ref:`chorded` at the same time as the :ref:`chord input`, or when pressed immediately after (arpeggiately) the :ref:`chord`, provided that :ref:`arpeggiates` are enabled. - - As of February of 2024, only the CharaChorder One and CharaChorder Lite support the use of chord modifiers. Additionally, as of that same time, chord modifiers only work in English. - - .. note:: - Chord modifiers are NOT the same as keyboard modifiers. Keyboard modifiers affect keys pressed on a keyboard. Those keys include ``CTRL``, ``ALT``, and ``FN``. Chord modifiers affect chords. - -.. image:: /assets/images/ManagerSettingsModifiers.png - :width: 1200 - :alt: The Chord Modifiers settings box - -In this box, you can read a brief explanation of chord modifiers and how to access them. - -Capitalization -~~~~~~~~~~~~~~ -The capitalization modifier modifies any chord so that the first letter is capitalized on :ref:`output`. This :ref:`modifier` can be performed together with a :ref:`chord` or :ref:`arpeggiately`. - -The capitalization modifier is located on the ``SHIFT`` key. In the :ref:`layout editor`, this key can be either "Shift Keyboard Modifier (Left)" or "Shift Keyboard Modifier (Right)". - -.. note:: - If you have ``CAPS LOCK`` active, all letters in a chord will be capitalized except the first one when using this modifier. - -Present Tense -~~~~~~~~~~~~~ -The present tense modifier modifies supported chords so that they turn into their present tense variants. The word "run" would be modified into "running" and the word "work" would be turned into "working". This :ref:`modifier` can be performed together with a :ref:`chord` or :ref:`arpeggiately`. - -The present tense modifier has different locations depending on your device. On the CharaChorder One, this modifier is linked to the "AMBIDEXTROUS THROWOVER (LEFT)" key. On the CharaChorder Lite, it's linked to the "NUMERIC LAYER (LEFT)" key. - -Pluralizer -~~~~~~~~~~ -The pluralizer modifier makes supported chords plural. It will add an "s" or "es" to the end of supported chords. "Box" will turn into "boxes" and "dog" will become "dogs". This :ref:`modifier` can be performed together with a :ref:`chord` or :ref:`arpeggiately`. - -The pluralizer modifier has different locations depending on your device. On the CharaChorder One, it's linked to the "AMBIDEXTROUS THROWOVER (RIGHT)" key. On the CharaChorder Lite, it's linked to the "RIGHT SPACEBAR" key, not to be confused with the "SPACE" key. - -Past Tense -~~~~~~~~~~ -The past tense modifier modifies supported chords so that they turn into their past tense variants. The word "run" would be modified into "ran". The word "work" would be turned into "worked". This :ref:`modifier` can be performed together with a :ref:`chord` or :ref:`arpeggiately`. - -The past tense modifier has different locations depending on your device. On the CharaChorder One, it's linked to the "NUMERIC LAYER (LEFT)" key. On the CharaChorder Lite, it's linked to the "SPACE" key, not to be confused with the "RIGHT SPACEBAR" key. - -Comparative -~~~~~~~~~~~ -The comparative modifier modifies supported chords so that they turn into their comparative variant. "Big" becomes "bigger" and "small" turns into "smaller". This :ref:`modifier` can be performed together with a :ref:`chord` or :ref:`arpeggiately`. - -The comparative modifier is located on the "NUMERIC LAYER (RIGHT)" key on both the CharaChorder One and the CharaChorder Lite. - - Character Entry --------------- .. dropdown:: What is Character Entry? diff --git a/docs/index.rst b/docs/index.rst index ec883f9..1effaff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,6 +31,7 @@ Table of Contents CharaChorder X.rst CCOS.rst Chords.rst + Chord Modifiers.rst Device Manager.rst FAQs.rst GenerativeTextMenu.rst From 3bdb184c7a15fc95471d66b72a2197344b5e20ce Mon Sep 17 00:00:00 2001 From: duianto Date: Fri, 24 Oct 2025 22:21:42 +0200 Subject: [PATCH 2/3] Add dropdown: Limitations --- docs/Chord Modifiers.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/Chord Modifiers.rst b/docs/Chord Modifiers.rst index a9d7be1..25dab44 100644 --- a/docs/Chord Modifiers.rst +++ b/docs/Chord Modifiers.rst @@ -5,11 +5,20 @@ Chord Modifiers Chord modifiers are actions that change a chord when :ref:`chorded` at the same time as the :ref:`chord input`, or when pressed immediately after (arpeggiately) the :ref:`chord`, provided that :ref:`arpeggiates` are enabled. - As of February of 2024, only the CharaChorder One and CharaChorder Lite support the use of chord modifiers. Additionally, as of that same time, chord modifiers only work in English. - .. note:: Chord modifiers are NOT the same as keyboard modifiers. Keyboard modifiers affect keys pressed on a keyboard. Those keys include ``CTRL``, ``ALT``, and ``FN``. Chord modifiers affect chords. +.. dropdown:: Limitations + + **As of October 2025** + + Chord modifiers don't work on: + + - CharaChorder X + - CharaChorder Engine + + Chord modifiers only work in English. + .. image:: /assets/images/ManagerSettingsModifiers.png :width: 1200 :alt: The Chord Modifiers settings box From 1addd267513d4ada5dcdd5469a1e703393077468 Mon Sep 17 00:00:00 2001 From: duianto Date: Fri, 24 Oct 2025 22:36:31 +0200 Subject: [PATCH 3/3] Fix chord modifiers link --- docs/Device Manager.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Device Manager.rst b/docs/Device Manager.rst index 81736c8..b7f10cc 100644 --- a/docs/Device Manager.rst +++ b/docs/Device Manager.rst @@ -211,7 +211,7 @@ Arpeggiates ----------- .. dropdown:: What are 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 :doc:`chord modifiers` after you perform the chord. you can read that section for information on how the chord modifiers work. + 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 :doc:`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.