sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename text_replacement.md to string_substitution.md

Browse Source
This commit is contained in:
James Fitzgerald 2022-07-09 11:31:41 -04:00 committed by xs5871
parent c2a3a1895f
commit ca719faa29
1 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/text_replacement.md → docs/string_substitution.md
View File

@ -1,37 +1,37 @@
# String Substitution # String Substitution
The String Substitution module lets a user replace one typed sequence of characters with another. If a string of characters you type matches an entry in your dictionary, it gets deleted and replaced with the corresponding replacement string. The String Substitution module lets a user replace one typed sequence of characters with another. If a string of characters you type matches an entry in your dictionary, it gets deleted and replaced with the corresponding replacement string.
Potential uses: Potential uses:
- Rudimentary auto-correct: replace `yuo` with `you` - Rudimentary auto-correct: replace `yuo` with `you`
- Text expansion, à la [espanso](https://github.com/federico-terzi/espanso): when `:sig` is typed, replace it with `John Doe`, or turn `idk` into `I don't know` - Text expansion, à la [espanso](https://github.com/federico-terzi/espanso): when `:sig` is typed, replace it with `John Doe`, or turn `idk` into `I don't know`
## Usage ## Usage
The String Substitution module takes a single argument to be passed during initialization: a user-defined dictionary where the keys are the text to be replaced and the values are the replacement text. The String Substitution module takes a single argument to be passed during initialization: a user-defined dictionary where the keys are the text to be replaced and the values are the replacement text.
Example is as follows: Example is as follows:
```python ```python
from kmk.modules.string_substitution import StringSubstitution from kmk.modules.string_substitution import StringSubstitution
my_dictionary = { my_dictionary = {
'yuo': 'you', 'yuo': 'you',
':sig': 'John Doe', ':sig': 'John Doe',
'idk': "I don't know" 'idk': "I don't know"
} }
string_substitution = StringSubstitution(dictionary=my_dictionary) string_substitution = StringSubstitution(dictionary=my_dictionary)
keyboard.modules.append(string_substitution) keyboard.modules.append(string_substitution)
``` ```
### Recommendations ### Recommendations
1. Consider prefixing text expansion entries with a symbol to prevent accidental activations: `:sig`, `!email`, etc. 1. Consider prefixing text expansion entries with a symbol to prevent accidental activations: `:sig`, `!email`, etc.
2. If you want multiple similar replacements, consider adding a number to prevent unreachable matches: `replaceme1`, `replaceme2`, etc. 2. If you want multiple similar replacements, consider adding a number to prevent unreachable matches: `replaceme1`, `replaceme2`, etc.
### Limitations ### Limitations
1. Currently supports characters for which there is a corresponding keycode in KMK - support for international characters is not implemented. 1. Currently supports characters for which there is a corresponding keycode in KMK - support for international characters is not implemented.
2. Since this runs on your keyboard, it is not context-aware. It can't tell if you are typing in a valid text field or not. 2. Since this runs on your keyboard, it is not context-aware. It can't tell if you are typing in a valid text field or not.
3. In the interest of a responsive typing experience, the first valid match will be used as soon as it is found. If your dictionary contains "abc" and "abcd", "abcd" will not be matchable. 3. In the interest of a responsive typing experience, the first valid match will be used as soon as it is found. If your dictionary contains "abc" and "abcd", "abcd" will not be matchable.