Move the documentation to `doc/plugin/TopsyTurvy.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>pull/389/head
parent
b73588055e
commit
265cbde980
@ -0,0 +1,51 @@
|
||||
# Kaleidoscope-TopsyTurvy
|
||||
|
||||
`TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some
|
||||
selected keys. That is, if configured so, it will input `!` when pressing the
|
||||
`1` key without `Shift`, but with the modifier pressed, it will input the
|
||||
original `1` symbol.
|
||||
|
||||
## Using the plugin
|
||||
|
||||
To use the plugin, one needs to include the header, mark keys to apply plugin
|
||||
effects to, and use the plugin:
|
||||
|
||||
```c++
|
||||
#include <Kaleidoscope.h>
|
||||
#include <Kaleidoscope-TopsyTurvy.h>
|
||||
|
||||
// In the keymap:
|
||||
TOPSY(1), TOPSY(2), TOPSY(3)
|
||||
|
||||
KALEIDOSCOPE_INIT_PLUGINS(TopsyTurvy);
|
||||
|
||||
void setup () {
|
||||
Kaleidoscope.setup ();
|
||||
}
|
||||
```
|
||||
|
||||
## Keymap markup
|
||||
|
||||
There is only one macro that the plugin provides, which one can use in keymap definitions:
|
||||
|
||||
### `TOPSY(key)`
|
||||
|
||||
> Mark the specified `key` (without the `Key_` prefix!) for TopsyTurvy, and swap
|
||||
> the effect of `Shift` when the key is used. One can have any number of
|
||||
> topsy-turvy keys on a keymap.
|
||||
>
|
||||
> The keys must be plain old keys, modifiers or anything other augmentation
|
||||
> cannot be applied.
|
||||
|
||||
The plugin provides a number of macros one can use in keymap definitions:
|
||||
|
||||
## Plugin methods
|
||||
|
||||
The plugin provides the `TopsyTurvy` object, without any public methods or properties.
|
||||
|
||||
## Further reading
|
||||
|
||||
Starting from the [example][plugin:example] is the recommended way of getting
|
||||
started with the plugin.
|
||||
|
||||
[plugin:example]: https://github.com/keyboardio/Kaleidoscope-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino
|
Loading…
Reference in new issue