From 81ae19a7ec20e014d6a8f7f03f01f070e901b9a2 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 2 Jan 2021 00:51:41 -0800 Subject: [PATCH] Cleanups for typos and broken links across the documentation --- docs/NEWS.md | 36 +++++++++--------- docs/UPGRADING.md | 28 +++++++------- .../copy-plugin-readmes.cpython-39.pyc | Bin 502 -> 502 bytes docs/build_default_firmware.md | 2 - docs/customization/core-plugins.md | 30 ++++++--------- ...DControl.md => Kaleidoscope-LEDControl.md} | 0 .../{TriColor.md => Kaleidoscope-TriColor.md} | 2 +- plugins/Kaleidoscope-Colormap/README.md | 10 ++--- plugins/Kaleidoscope-Cycle/README.md | 2 +- plugins/Kaleidoscope-DynamicMacros/README.md | 10 ++--- .../Kaleidoscope-DynamicTapDance/README.md | 10 ++--- .../README.md | 2 +- plugins/Kaleidoscope-EEPROM-Keymap/README.md | 8 ++-- .../Kaleidoscope-EEPROM-Settings/README.md | 4 +- plugins/Kaleidoscope-Escape-OneShot/README.md | 2 +- plugins/Kaleidoscope-FingerPainter/README.md | 8 ++-- plugins/Kaleidoscope-FirmwareDump/README.md | 4 +- plugins/Kaleidoscope-FocusSerial/README.md | 2 +- plugins/Kaleidoscope-Heatmap/README.md | 2 +- plugins/Kaleidoscope-HostOS/README.md | 4 +- .../README.md | 2 +- plugins/Kaleidoscope-IdleLEDs/README.md | 8 ++-- .../README.md | 4 +- .../Kaleidoscope-LED-ActiveModColor/README.md | 4 +- .../Kaleidoscope-LED-AlphaSquare/README.md | 2 +- .../Kaleidoscope-LED-Palette-Theme/README.md | 6 +-- plugins/Kaleidoscope-LED-Stalker/README.md | 2 +- plugins/Kaleidoscope-LED-Wavepool/README.md | 4 +- .../README.md | 2 +- .../README.md | 2 +- .../Kaleidoscope-LEDEffect-Breathe/README.md | 2 +- .../Kaleidoscope-LEDEffect-Chase/README.md | 2 +- .../Kaleidoscope-LEDEffect-Rainbow/README.md | 2 +- .../README.md | 2 +- plugins/Kaleidoscope-LEDEffects/README.md | 2 +- plugins/Kaleidoscope-LayerFocus/README.md | 4 +- plugins/Kaleidoscope-Leader/README.md | 2 +- plugins/Kaleidoscope-OneShot/README.md | 4 +- plugins/Kaleidoscope-Redial/README.md | 4 +- plugins/Kaleidoscope-ShapeShifter/README.md | 2 +- plugins/Kaleidoscope-SpaceCadet/README.md | 8 ++-- plugins/Kaleidoscope-Steno/README.md | 4 +- plugins/Kaleidoscope-Syster/README.md | 2 +- plugins/Kaleidoscope-TapDance/README.md | 2 +- plugins/Kaleidoscope-Turbo/README.md | 4 +- plugins/Kaleidoscope-TypingBreaks/README.md | 2 +- plugins/Kaleidoscope-USB-Quirks/README.md | 2 +- plugins/Kaleidoscope-Unicode/README.md | 4 +- 48 files changed, 123 insertions(+), 133 deletions(-) rename docs/plugins/{LEDControl.md => Kaleidoscope-LEDControl.md} (100%) rename docs/plugins/{TriColor.md => Kaleidoscope-TriColor.md} (96%) diff --git a/docs/NEWS.md b/docs/NEWS.md index d6c7bdef..d745af99 100644 --- a/docs/NEWS.md +++ b/docs/NEWS.md @@ -86,23 +86,23 @@ See the [Kaleidoscope-USB-Quirks][plugin:USB-Quirks] plugin for a use-case. ### Finer stickability controls for OneShot -The [OneShot plugin](plugins/OneShot.md) gained finer stickability controls, one can now control whether the double-tap stickiness is enabled on a per-key basis. See [UPGRADING.md](UPGRADING.md#finer-oneshot-stickability-control) for more information. +The [OneShot plugin](plugins/Kaleidoscope-OneShot.md) gained finer stickability controls, one can now control whether the double-tap stickiness is enabled on a per-key basis. See [UPGRADING.md](UPGRADING.md#finer-oneshot-stickability-control) for more information. ### A way to slow down Unicode input -In certain cases we need to delay the unicode input sequence, otherwise the host is unable to process the input properly. For this reason, the [Unicode](plugins/Unicode.md) gained an `.input_delay()` method that lets us do just that. It still defaults to no delay. +In certain cases we need to delay the unicode input sequence, otherwise the host is unable to process the input properly. For this reason, the [Unicode](plugins/Kaleidoscope-Unicode.md) gained an `.input_delay()` method that lets us do just that. It still defaults to no delay. ### Better support for modifiers in the Cycle plugin -The [Cycle](plugins/Cycle.md) plugin has much better support for cycling through keys with modifiers applied to them, such as `LSHIFT(Key_A)`. Please see the documentation and the updated example for more information. +The [Cycle](plugins/Kaleidoscope-Cycle.md) plugin has much better support for cycling through keys with modifiers applied to them, such as `LSHIFT(Key_A)`. Please see the documentation and the updated example for more information. ### More control over when to send reports during Macro playback -There are situations where one would like to disable sending a report after each and every step of a macro, and rather have direct control over when reports are sent. The new `WITH_EXPLICIT_REPORT`, `WITH_IMPLICIT_REPORT` and `SEND_REPORT` steps help with that. Please see the [Macros](plugins/Macros.md) documentation for more information. +There are situations where one would like to disable sending a report after each and every step of a macro, and rather have direct control over when reports are sent. The new `WITH_EXPLICIT_REPORT`, `WITH_IMPLICIT_REPORT` and `SEND_REPORT` steps help with that. Please see the [Macros](plugins/Kaleidoscope-Macros.md) documentation for more information. ### LED-ActiveModColor can be asked to not highlight normal modifiers -The plugin was intended to work with OneShot primarily, and that's where it is most useful. To make it less surprising, and more suitable to include it in default-like firmware, we made it possible to ask it not to highlight normal modifiers. Please see the [LED-ActiveModColor](plugins/LED-ActiveModColor.md) documentation for more information. +The plugin was intended to work with OneShot primarily, and that's where it is most useful. To make it less surprising, and more suitable to include it in default-like firmware, we made it possible to ask it not to highlight normal modifiers. Please see the [LED-ActiveModColor](plugins/Kaleidoscope-LED-ActiveModColor.md) documentation for more information. ### Events now trigger on layer changes @@ -132,39 +132,39 @@ Kaleidoscope has been ported to the following devices: For more information, please see the hardware plugins' documentation. -To make it easier to port Kaleidoscope, we introduced the [ATMegaKeyboard](plugins/ATMegaKeyboard.md) base class. For any board that's based on the ATMega MCU and a simple matrix, this might be a good foundation to develop the hardware plugin upon. +To make it easier to port Kaleidoscope, we introduced the `ATMegaKeyboard` base class. For any board that's based on the ATMega MCU and a simple matrix, this might be a good foundation to develop the hardware plugin upon. ## New plugins ### DynamicMacros -The [DynamicMacros](plugins/DynamicMacros.md) plugin provides a way to use and update macros via the Focus API, through Chrysalis. +The [DynamicMacros](plugins/Kaleidoscope-DynamicMacros.md) plugin provides a way to use and update macros via the Focus API, through Chrysalis. ### IdleLEDs -The [IdleLEDs](plugins/IdleLEDs.md) plugin is a simple, yet, useful one: it will turn the keyboard LEDs off after a period of inactivity, and back on upon the next key event. +The [IdleLEDs](plugins/Kaleidoscope-IdleLEDs.md) plugin is a simple, yet, useful one: it will turn the keyboard LEDs off after a period of inactivity, and back on upon the next key event. ### LEDActiveLayerColor -The [LEDActiveLayerColor][plugins/LEDActiveLayerColor.md] plugin makes it possible to set the color of all LEDs to the same color, depending on which layer is active topmost. +The [LEDActiveLayerColor][plugins/Kaleidoscope-LEDActiveLayerColor.md] plugin makes it possible to set the color of all LEDs to the same color, depending on which layer is active topmost. ### LED-Wavepool -We integrated the [LEDWavepool](plugins/LED-Wavepool.md) plugin by [ToyKeeper][wavepool:origin], with a few updates and new features added. +We integrated the [LEDWavepool](plugins/Kaleidoscope-LED-Wavepool.md) plugin by [ToyKeeper][wavepool:origin], with a few updates and new features added. [wavepool:origin]: https://github.com/ToyKeeper/Kaleidoscope-LED-Wavepool ### Turbo -The [Turbo](plugins/Turbo.md) plugin provides a way to send keystrokes in very quick succession while holding down a key. +The [Turbo](plugins/Kaleidoscope-Turbo.md) plugin provides a way to send keystrokes in very quick succession while holding down a key. ### WinKeyToggle -The [WinKeyToggle](plugins/WinKeyToggle.md) plugin assists with toggling the Windows key on and off - a little something for those of us who game under Windows and are tired of accidentally popping up the start menu. +The [WinKeyToggle](plugins/Kaleidoscope-WinKeyToggle.md) plugin assists with toggling the Windows key on and off - a little something for those of us who game under Windows and are tired of accidentally popping up the start menu. ### FirmwareDump -The [FirmwareDump](plugins/FirmwareDump.md) plugin makes it possible to dump one's firmware over Focus. +The [FirmwareDump](plugins/Kaleidoscope-FirmwareDump.md) plugin makes it possible to dump one's firmware over Focus. ## Breaking changes @@ -197,29 +197,29 @@ The `NumPad` plugin used to toggle `NumLock` when switching to the NumPad layer. ### The `RxCy` macros and peeking into the keyswitch state -The `RxCy` macros changed from being indexes into a per-hand bitmap to being an index across the whole keyboard. This mostly affected the [MagicCombo](plugins/MagicCombo.md) plugin. +The `RxCy` macros changed from being indexes into a per-hand bitmap to being an index across the whole keyboard. This mostly affected the [MagicCombo](plugins/Kaleidoscope-MagicCombo.md) plugin. Please see the [relevant upgrade notes](UPGRADING.md#the-rxcy-macros-and-peeking-into-the-keyswitch-state) for more information. ### The `Redial` plugin had a breaking API change -The [Redial](plugins/Redial.md) plugin was simplified, one no longer needs to define `Key_Redial` on their own, the plugin defines it itself. See the [upgrade notes](UPGRADING.md#Redial) for more information about how to upgrade. +The [Redial](plugins/Kaleidoscope-Redial.md) plugin was simplified, one no longer needs to define `Key_Redial` on their own, the plugin defines it itself. See the [upgrade notes](UPGRADING.md#Redial) for more information about how to upgrade. ### Color palette storage has changed -The [LED-Palette-Theme](plugins/LED-Palette-Theme.md) had to be changed to store the palette colors in reverse. This change had to be made in order to not default to a bright white palette, that would draw so much power that most operating systems would disconnect the keyboard due to excessive power usage. With inverting the colors, we now default to a black palette instead. This sadly breaks existing palettes, and you will have to re-set the colors. +The [LED-Palette-Theme](plugins/Kaleidoscope-LED-Palette-Theme.md) had to be changed to store the palette colors in reverse. This change had to be made in order to not default to a bright white palette, that would draw so much power that most operating systems would disconnect the keyboard due to excessive power usage. With inverting the colors, we now default to a black palette instead. This sadly breaks existing palettes, and you will have to re-set the colors. We also changed when we reserve space for the palette in EEPROM: we used to do it as soon as possible, but that made it impossible to go from a firmware that does not use the plugin to one that does, and still have a compatible EEPROM layout. We now reserve space as late as possible. This breaks existing EEPROM layouts however. ### EEPROM-Keymap changed Focus commands -The [EEPROMKeymap](plugins/EEPROM-Keymap.md) plugin was changed to treat built-in (default) and EEPROM-stored (custom) layers separately, because that's less surprising, and easier to work with from Chrysalis. The old `keymap.map` and `keymap.roLayers` commands are gone, the new `keymap.default` and `keymap.custom` commands should be used instead. +The [EEPROMKeymap](plugins/Kaleidoscope-EEPROM-Keymap.md) plugin was changed to treat built-in (default) and EEPROM-stored (custom) layers separately, because that's less surprising, and easier to work with from Chrysalis. The old `keymap.map` and `keymap.roLayers` commands are gone, the new `keymap.default` and `keymap.custom` commands should be used instead. ### EEPROMSettings' version() setter has been deprecated We're repurposing the `version` setting: instead of it being something end-users can set, we'll be using it internally to track changes made to -[EEPROMSettings](plugins/EEPROM-Settings.md) itself, with the goal of +[EEPROMSettings](plugins/Kaleidoscope-EEPROM-Settings.md) itself, with the goal of allowing external tools to aid in migrations. The setting wasn't widely used - if at all -, which is why we chose to repurpose it instead of adding a new field. diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 421c43be..983c733d 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -48,7 +48,7 @@ For end users, this doesn't come with any breaking changes. A few things have be #### For developers -For those wishing to port Kaleidoscope to devices it doesn't support yet, the new API should make most things considerably easier. Please see the (work in progress) documentation in [doc/device-apis.md](doc/device-apis.md). +For those wishing to port Kaleidoscope to devices it doesn't support yet, the new API should make most things considerably easier. Please see the documentation in [device-apis.md](api-reference/device-apis.md). The old symbols and APIs are no longer available. @@ -464,7 +464,7 @@ The new API is much shorter, and is inspired by the way the [Leader][leader] plugin works: instead of having a list, and a dispatching function like `magicComboActions`, we include the action method in the list too! - [leader]: plugins/Leader.md + [leader]: plugins/Kaleidoscope-Leader.md We also don't make a difference between left- and right-hand anymore, you can just list keys for either in the same list. This will be very handy for @@ -565,19 +565,19 @@ With the move towards a monorepo-based source, some headers have moved to a new The following headers and names have changed: - `layers.h`, `key_defs_keymaps.h` and `macro_helpers.h` are obsolete, and should not be included in the first place, as `Kaleidoscope.h` will pull them in. In the rare case that one needs them, prefixing them with `kaleidoscope/` is the way to go. Of the various headers provided under the `kaleidoscope/` space, only `kaleidoscope/macro_helpers.h` should be included directly, and only by hardware plugins that can't pull `Kaleidoscope.h` in due to circular dependencies. -- `LED-Off.h`, provided by [LEDControl](plugins/LEDControl.md) is obsolete, the `LEDOff` LED mode is automatically provided by `Kaleidoscope-LEDControl.h`. The `LED-Off.h` includes can be safely removed. +- `LED-Off.h`, provided by [LEDControl](plugins/Kaleidoscope-LEDControl.md) is obsolete, the `LEDOff` LED mode is automatically provided by `Kaleidoscope-LEDControl.h`. The `LED-Off.h` includes can be safely removed. - `LEDUtils.h` is automatically pulled in by `Kaleiodscope-LEDControl.h`, too, and there's no need to directly include it anymore. - Plugins that implement LED modes should subclass `kaleidoscope::plugin::LEDMode` instead of `kaleidoscope::LEDMode`. -- [GhostInTheFirmware](plugins/GhostInTheFirmware.md) had the `kaleidoscope::GhostInTheFirmware::GhostKey` type replaced by `kaleidoscope::plugin::GhostInTheFirmware::GhostKey`. -- [HostOS](plugins/HostOS.md) no longer provides the `Kaleidoscope/HostOS-select.h` header, and there is no backwards compatibility header either. -- [Leader](plugins/Leader.md) had the `kaleidoscope::Leader::dictionary_t` type replaced by `kaleidoscope::plugin::Leader::dictionary_t`. -- [LED-AlphaSquare](plugins/LED-AlphaSquare.md) used to provide extra symbol graphics in the `kaleidoscope::alpha_square::symbols` namespace. This is now replaced by `kaleidoscope::plugin::alpha_square::symbols`. -- [LEDEffect-SolidColor](plugins/LEDEffect-SolidColor.md) replaced the base class - `kaleidoscope::LEDSolidColor` - with `kaleidoscope::plugin::LEDSolidColor`. -- [Qukeys](plugins/Qukeys.md) had the `kaleidoscope::Qukey` type replaced by `kaleidoscope::plugin::Qukey`. -- [ShapeShifter](plugins/ShateShifter.md) had the `kaleidoscope::ShapeShifter::dictionary_t` type replaced by `kaleidoscope::plugin::ShapeShifter::dictionary_t`. -- [SpaceCadet](plugins/SpaceCadet.md) had the `kaleidoscope::SpaceCadet::KeyBinding` type replaced by `kaleidoscope::plugin::SpaceCadet::KeyBinding`. -- [Syster](plugins/Syster.md) had the `kaleidoscope::Syster::action_t` type replaced by `kaleidoscope::plugin::Syster::action_t`. -- [TapDance](plugins/TapDance.md) had the `kaleidoscope::TapDance::ActionType` type replaced by `kaleidoscope::plugin::TapDance::ActionType`. +- [GhostInTheFirmware](plugins/Kaleidoscope-GhostInTheFirmware.md) had the `kaleidoscope::GhostInTheFirmware::GhostKey` type replaced by `kaleidoscope::plugin::GhostInTheFirmware::GhostKey`. +- [HostOS](plugins/Kaleidoscope-HostOS.md) no longer provides the `Kaleidoscope/HostOS-select.h` header, and there is no backwards compatibility header either. +- [Leader](plugins/Kaleidoscope-Leader.md) had the `kaleidoscope::Leader::dictionary_t` type replaced by `kaleidoscope::plugin::Leader::dictionary_t`. +- [LED-AlphaSquare](plugins/Kaleidoscope-LED-AlphaSquare.md) used to provide extra symbol graphics in the `kaleidoscope::alpha_square::symbols` namespace. This is now replaced by `kaleidoscope::plugin::alpha_square::symbols`. +- [LEDEffect-SolidColor](plugins/Kaleidoscope-LEDEffect-SolidColor.md) replaced the base class - `kaleidoscope::LEDSolidColor` - with `kaleidoscope::plugin::LEDSolidColor`. +- [Qukeys](plugins/Kaleidoscope-Qukeys.md) had the `kaleidoscope::Qukey` type replaced by `kaleidoscope::plugin::Qukey`. +- [ShapeShifter](plugins/Kaleidoscope-ShapeShifter.md) had the `kaleidoscope::ShapeShifter::dictionary_t` type replaced by `kaleidoscope::plugin::ShapeShifter::dictionary_t`. +- [SpaceCadet](plugins/Kaleidoscope-SpaceCadet.md) had the `kaleidoscope::SpaceCadet::KeyBinding` type replaced by `kaleidoscope::plugin::SpaceCadet::KeyBinding`. +- [Syster](plugins/Kaleidoscope-Syster.md) had the `kaleidoscope::Syster::action_t` type replaced by `kaleidoscope::plugin::Syster::action_t`. +- [TapDance](plugins/Kaleidoscope-TapDance.md) had the `kaleidoscope::TapDance::ActionType` type replaced by `kaleidoscope::plugin::TapDance::ActionType`. # Removed APIs @@ -658,7 +658,7 @@ The deprecated row/col based indexing APIs have been removed on **2020-06-16**. #### EEPROMKeymap mode -The [EEPROM-Keymap](plugins/EEPROM-Keymap.md) plugin had its `setup()` method changed, the formerly optional `method` argument is now obsolete and unused. It can be safely removed. +The [EEPROM-Keymap](plugins/Kaleidoscope-EEPROM-Keymap.md) plugin had its `setup()` method changed, the formerly optional `method` argument is now obsolete and unused. It can be safely removed. ##### keymaps array and KEYMAPS and KEYMAPS_STACKED macros diff --git a/docs/_sphinx/__pycache__/copy-plugin-readmes.cpython-39.pyc b/docs/_sphinx/__pycache__/copy-plugin-readmes.cpython-39.pyc index 905460aaa08fe7512e55bcce47a0f0de2edc23ed..eaacf83ddd31fd1283e8cec257b18b46f1bf5e2b 100644 GIT binary patch delta 20 acmeyy{EeAAk(ZZ?0SH9+KWyZF%?JQDj0HXb delta 20 acmeyy{EeAAk(ZZ?0SLC~KG?|pnh^jzUIp#| diff --git a/docs/build_default_firmware.md b/docs/build_default_firmware.md index 112d30d9..7d4a652a 100644 --- a/docs/build_default_firmware.md +++ b/docs/build_default_firmware.md @@ -42,8 +42,6 @@ If something goes wrong, the status bar turns orange and displays an error messa ![](images/arduino-setup/verify-failed.png) -If you see errors, refer to [Getting help](Getting-help) for troubleshooting tips and useful resources. - # Install the firmware If your keyboard has a programming interlock key, you'll need to hold it down now. On the Keyboardio Model 01, this is the `Prog` key. On the Keyboardio Atreus, this is the `Esc` key. diff --git a/docs/customization/core-plugins.md b/docs/customization/core-plugins.md index d575a6ce..b0257f7a 100644 --- a/docs/customization/core-plugins.md +++ b/docs/customization/core-plugins.md @@ -7,7 +7,7 @@ You can find a list of third-party plugins not distributed as part of Kaleidosco ## EEPROM-Keymap -[EEPROM-Keymap Documentation](../plugins/EEPROM-Keymap.md) +[EEPROM-Keymap Documentation](../plugins/Kaleidoscope-EEPROM-Keymap.md) While keyboards usually ship with a keymap programmed in, to be able to change that keymap, without flashing new firmware, we need a way to place the keymap into a place we can update at run-time, and which persists across reboots. Fortunately, we have a bit of EEPROM on the keyboard, and can use it to store either the full keymap (and saving space in the firmware then), or store an overlay there. In the latter case, whenever there is a non-transparent key on the overlay, we will use that instead of the keyboard default. @@ -15,21 +15,13 @@ In short, this plugin allows us to change our keymaps, without having to compile ## Escape-OneShot -[Escape-OneShot Documentation](../plugins/Escape-OneShot.md) +[Escape-OneShot Documentation](../plugins/Kaleidoscope-Escape-OneShot.md) Turn the Esc key into a special key, that can cancel any active OneShot effect - or act as the normal Esc key if none are active. For those times when one accidentally presses a one-shot key, or change their minds. -## KeyLogger - -[KeyLogger Documentation](../plugins/KeyLogger.md) - -The KeyLogger plugin, as the name suggests, implements a key logger for the Kaleidoscope firmware. It logs the row and column of every key press and release, along with the event, and the layer number, in a format that is reasonably easy to parse, to the Serial interface. - -**A word of warning**: Having a key logger is as dangerous as it sounds. Anyone who can read the serial events from the keyboard, will know exactly what keys you press, and when. Unless you know what you are doing, and can secure your keyboard, do not enable this plugin. - ## Leader -[Leader Documentation](../plugins/Leader.md) +[Leader Documentation](../plugins/Kaleidoscope-Leader.md) Leader keys are a kind of key where when they are tapped, all following keys are swallowed, until the plugin finds a matching sequence in the dictionary, it times out, or fails to find any possibilities. When a sequence is found, the corresponding action is executed, but the processing still continues. If any key is pressed that is not the continuation of the existing sequence, processing aborts, and the key is handled normally. @@ -39,7 +31,7 @@ So we put ``LEAD u`` and ``LEAD u h e a r t`` in the dictionary only. The first ## Macros -[Macros Documentation](../plugins/Macros.md) +[Macros Documentation](../plugins/Kaleidoscope-Macros.md) Macros are a standard feature on many keyboards and powered ones are no exceptions. Macros are a way to have a single key-press do a whole lot of things under the hood: conventionally, macros play back a key sequence, but with Kaleidoscope, there is much more we can do. Nevertheless, playing back a sequence of events is still the primary use of macros. @@ -47,7 +39,7 @@ Playing back a sequence means that when we press a macro key, we can have it pla ## MagicCombo -[MagicCombo Documentation](../plugins/MagicCombo.md) +[MagicCombo Documentation](../plugins/Kaleidoscope-MagicCombo.md) The MagicCombo extension provides a way to perform custom actions when a particular set of keys are held down together. The functionality assigned to these keys are not changed, and the custom action triggers as long as all keys within the set are pressed. The order in which they were pressed do not matter. @@ -55,7 +47,7 @@ This can be used to tie complex actions to key chords. ## OneShot -[OneShot Documentation](../plugins/OneShot.md) +[OneShot Documentation](../plugins/Kaleidoscope-OneShot.md) One-shots are a new kind of behaviour for your standard modifier and momentary layer keys: instead of having to hold them while pressing other keys, they can be tapped and released, and will remain active until any other key is pressed. In short, they turn ``Shift, A`` into ``Shift+A``, and ``Fn, 1`` to ``Fn+1``. The main advantage is that this allows us to place the modifiers and layer keys to positions that would otherwise be awkward when chording. Nevertheless, they still act as normal when held, that behaviour is not lost. @@ -65,7 +57,7 @@ To make multi-modifier, or multi-layer shortcuts possible, one-shot keys remain ## Qukeys -[Qukeys Documentation](../plugins/Qukeys.md) +[Qukeys Documentation](../plugins/Kaleidoscope-Qukeys.md) A Qukey is a key that has two possible values, usually a modifier and a printable character. The name is a play on the term "qubit" (short for "quantum bit") from quantum computing. The value produced depends on how long the key press lasts, and how it is used in combination with other keys (roughly speaking, whether the key is "tapped" or "held"). @@ -77,7 +69,7 @@ It is also possible to use Qukeys like SpaceCadet (see below), by setting the pr ## ShapeShifter -[ShapeShifter Documentation](../plugins/ShapeShifter.md) +[ShapeShifter Documentation](../plugins/Kaleidoscope-ShapeShifter.md) ShapeShifter is a plugin that makes it considerably easier to change what symbol is input when a key is pressed together with ``Shift``. If one wants to rearrange the symbols on the number row for example, without modifying the layout on the operating system side, this plugin is where one can turn to. @@ -85,7 +77,7 @@ What it does, is very simple: if any key in its dictionary is found pressed whil ## SpaceCadet -[SpaceCadet Documentation](../plugins/SpaceCadet.md) +[SpaceCadet Documentation](../plugins/Kaleidoscope-SpaceCadet.md) Space Cadet is a way to make it more convenient to input parens - those ``(`` and ``)`` things -, symbols that a lot of programming languages use frequently. If you are working with Lisp, you are using these all the time. @@ -97,7 +89,7 @@ After getting used to the Space Cadet style of typing, you may wish to enable th ## TapDance -[TapDance Documentation](../plugins/TapDance.md) +[TapDance Documentation](../plugins/Kaleidoscope-TapDance.md) Tap-dance keys are general purpose, multi-use keys, which trigger a different action based on the number of times they were tapped in sequence. As an example to make this clearer, one can have a key that inputs ``A`` when tapped once, inputs ``B`` when tapped twice, and lights up the keyboard in Christmas colors when tapped a third time. @@ -119,7 +111,7 @@ There is one additional value the tapDanceAction parameter can ``take: kaleidosc ## TopsyTurvy -[TopsyTurvy Documentation](../plugins/TopsyTurvy.md) +[TopsyTurvy Documentation](../plugins/Kaleidoscope-TopsyTurvy.md) 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. diff --git a/docs/plugins/LEDControl.md b/docs/plugins/Kaleidoscope-LEDControl.md similarity index 100% rename from docs/plugins/LEDControl.md rename to docs/plugins/Kaleidoscope-LEDControl.md diff --git a/docs/plugins/TriColor.md b/docs/plugins/Kaleidoscope-TriColor.md similarity index 96% rename from docs/plugins/TriColor.md rename to docs/plugins/Kaleidoscope-TriColor.md index 168cf9e0..da2437e9 100644 --- a/docs/plugins/TriColor.md +++ b/docs/plugins/Kaleidoscope-TriColor.md @@ -4,7 +4,7 @@ The `TriColor` effect extension is a part of the [`LEDEffects`][plugin:ledeffects] library, not a stand-alone base library of its own. It is used to implement the effects in that library. - [plugin:ledeffects]: LEDEffects.md + [plugin:ledeffects]: Kaleidoscope-LEDEffects.md It is a class that can be used to create LED effects that all follow a similar pattern: alphas and similar in one color; modifiers, special keys, and half the diff --git a/plugins/Kaleidoscope-Colormap/README.md b/plugins/Kaleidoscope-Colormap/README.md index 7eb1e463..930aa430 100644 --- a/plugins/Kaleidoscope-Colormap/README.md +++ b/plugins/Kaleidoscope-Colormap/README.md @@ -8,8 +8,8 @@ the [LED-Palette-Theme][plugin:l-p-t] plugin. The color map is stored in `EEPROM`, and can be easily changed via the [FocusSerial][plugin:focusserial] plugin, which also provides palette editing capabilities. - [plugin:focusserial]: FocusSerial.md - [plugin:l-p-t]: LED-Palette-Theme.md + [plugin:focusserial]: Kaleidoscope-FocusSerial.md + [plugin:l-p-t]: Kaleidoscope-LED-Palette-Theme.md ## Using the extension @@ -57,9 +57,9 @@ The extension provides an `ColormapEffect` singleton object, with a single metho ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [Kaleidoscope-FocusSerial](FocusSerial.md) -* [Kaleidoscope-LED-Palette-Theme](LED-Palette-Theme.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) +* [Kaleidoscope-LED-Palette-Theme](Kaleidoscope-LED-Palette-Theme.md) ## Further reading diff --git a/plugins/Kaleidoscope-Cycle/README.md b/plugins/Kaleidoscope-Cycle/README.md index b49dca69..ef99614d 100644 --- a/plugins/Kaleidoscope-Cycle/README.md +++ b/plugins/Kaleidoscope-Cycle/README.md @@ -89,7 +89,7 @@ method explained below. ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-DynamicMacros/README.md b/plugins/Kaleidoscope-DynamicMacros/README.md index 05ee74d7..ec667bab 100644 --- a/plugins/Kaleidoscope-DynamicMacros/README.md +++ b/plugins/Kaleidoscope-DynamicMacros/README.md @@ -5,8 +5,8 @@ be re-defined without compiling and flashing new firmware: one can change dynamic macros via [Focus][plugin:focus], using a tool like [Chrysalis][chrysalis]. - [plugin:macros]: Macros.md - [plugin:focus]: FocusSerial.md + [plugin:macros]: Kaleidoscope-Macros.md + [plugin:focus]: Kaleidoscope-FocusSerial.md [chrysalis]: https://github.com/keyboardio/Chrysalis Dynamic macros come with certain limitations, however: unlike the built-in @@ -69,7 +69,7 @@ The plugin provides a `DynamicMacros` object, with the following methods and pro The plugin supports the same [macro steps][doc:steps] as the Macros plugin, please refer to the documentation therein. - [doc:steps]: Macros.md#macro-steps + [doc:steps]: (Kaleidoscope-Macros.md#macro-steps) ## Focus commands @@ -96,5 +96,5 @@ The plugin provides two Focus commands: `macros.map` and `macros.trigger`. ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [Kaleidoscope-FocusSerial](FocusSerial.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) diff --git a/plugins/Kaleidoscope-DynamicTapDance/README.md b/plugins/Kaleidoscope-DynamicTapDance/README.md index 2cf5d6b3..0ba28277 100644 --- a/plugins/Kaleidoscope-DynamicTapDance/README.md +++ b/plugins/Kaleidoscope-DynamicTapDance/README.md @@ -4,8 +4,8 @@ The `DynamicTapDance` plugin allows one to set up [TapDance][plugin:tapdance] ke without the need to compile and flash new firmware: one can change dynamic dances via [Focus][plugin:focus], using a tool like [Chrysalis][chrysalis]. - [plugin:tapdance]: TapDance.md - [plugin:focus]: FocusSerial.md + [plugin:tapdance]: Kaleidoscope-TapDance.md + [plugin:focus]: Kaleidoscope-FocusSerial.md [chrysalis]: https://github.com/keyboardio/Chrysalis Dynamic dances come with certain limitations, however: unlike the built-in ones, @@ -96,6 +96,6 @@ The plugin provides one Focus command: `tapdance.ap`. ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [Kaleidoscope-FocusSerial](FocusSerial.md) -* [Kaleidoscope-TapDance](TapDance.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) +* [Kaleidoscope-TapDance](Kaleidoscope-TapDance.md) diff --git a/plugins/Kaleidoscope-EEPROM-Keymap-Programmer/README.md b/plugins/Kaleidoscope-EEPROM-Keymap-Programmer/README.md index ad61422b..18c7244e 100644 --- a/plugins/Kaleidoscope-EEPROM-Keymap-Programmer/README.md +++ b/plugins/Kaleidoscope-EEPROM-Keymap-Programmer/README.md @@ -114,7 +114,7 @@ in turn provides the following command: * [Kaleidoscope-EEPROM-Keymap][plugin:eeprom-keymap] - [plugin:eeprom-keymap]: EEPROM-Keymap.md + [plugin:eeprom-keymap]: Kaleidoscope-EEPROM-Keymap.md ## Further reading diff --git a/plugins/Kaleidoscope-EEPROM-Keymap/README.md b/plugins/Kaleidoscope-EEPROM-Keymap/README.md index 7dab63a3..6cafeffc 100644 --- a/plugins/Kaleidoscope-EEPROM-Keymap/README.md +++ b/plugins/Kaleidoscope-EEPROM-Keymap/README.md @@ -4,9 +4,9 @@ While keyboards usually ship with a keymap programmed in, to be able to change t In short, this plugin allows us to change our keymaps, without having to compile and flash new firmware. It does so through the use of the [FocusSerial][plugin:focusSerial] plugin. - [plugin:focusSerial]: FocusSerial.md + [plugin:focusSerial]: Kaleidoscope-FocusSerial.md -By default, the plugin extends the keymap in PROGMEM: it will only look for keys in EEPROM if looking up from a layer that's higher than the last one in PROGMEM. This behaviour can be changed either via `Focus` (see below), or by calling `EEPROMSettings.use_eeprom_layers_only` (see the [EEPROMSettings](EEPROM-Settings.md) documentation for more information). +By default, the plugin extends the keymap in PROGMEM: it will only look for keys in EEPROM if looking up from a layer that's higher than the last one in PROGMEM. This behaviour can be changed either via `Focus` (see below), or by calling `EEPROMSettings.use_eeprom_layers_only` (see the [EEPROMSettings](Kaleidoscope-EEPROM-Settings.md) documentation for more information). ## Using the plugin @@ -61,8 +61,8 @@ The plugin provides three Focus commands: `keymap.default`, `keymap.custom`, and ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [Kaleidoscope-FocusSerial](FocusSerial.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) ## Further reading diff --git a/plugins/Kaleidoscope-EEPROM-Settings/README.md b/plugins/Kaleidoscope-EEPROM-Settings/README.md index 79956e53..f622551e 100644 --- a/plugins/Kaleidoscope-EEPROM-Settings/README.md +++ b/plugins/Kaleidoscope-EEPROM-Settings/README.md @@ -136,7 +136,7 @@ The plugin provides two - optional - [Focus][FocusSerial] command plugins: to `KALEIDOSCOPE_INIT_PLUGINS` if one wishes to use them. They provide the following commands: - [FocusSerial]: FocusSerial.md + [FocusSerial]: Kaleidoscope-FocusSerial.md ### `settings.defaultLayer` @@ -174,7 +174,7 @@ following commands: ## Dependencies -* [Kaleidoscope-FocusSerial][FocusSerial] +* (Kaleidoscope-FocusSerial)[Kaleidoscope-FocusSerial.md] ## Further reading diff --git a/plugins/Kaleidoscope-Escape-OneShot/README.md b/plugins/Kaleidoscope-Escape-OneShot/README.md index db00a887..9db9ae65 100644 --- a/plugins/Kaleidoscope-Escape-OneShot/README.md +++ b/plugins/Kaleidoscope-Escape-OneShot/README.md @@ -31,7 +31,7 @@ The plugin provides the `EscapeOneShot` object, which has no public methods. ## Dependencies -* [Kaleidoscope-OneShot](OneShot.md) +* [Kaleidoscope-OneShot](Kaleidoscope-OneShot.md) ## Further reading diff --git a/plugins/Kaleidoscope-FingerPainter/README.md b/plugins/Kaleidoscope-FingerPainter/README.md index 62c09cfb..4f5c194a 100644 --- a/plugins/Kaleidoscope-FingerPainter/README.md +++ b/plugins/Kaleidoscope-FingerPainter/README.md @@ -47,12 +47,12 @@ The plugin provides the `FingerPainter` object, which provides no public methods ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [Kaleidoscope-FocusSerial](FocusSerial.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) * [Kaleidoscope-LED-Palette-Theme][plugin:l-p-t] -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) - [plugin:l-p-t]: LED-Palette-Theme.md + [plugin:l-p-t]: Kaleidoscope-LED-Palette-Theme.md ## Further reading diff --git a/plugins/Kaleidoscope-FirmwareDump/README.md b/plugins/Kaleidoscope-FirmwareDump/README.md index e2f7fdd5..b176a34c 100644 --- a/plugins/Kaleidoscope-FirmwareDump/README.md +++ b/plugins/Kaleidoscope-FirmwareDump/README.md @@ -32,7 +32,7 @@ void setup () { The plugin provides a single [Focus][FocusSerial] command: - [FocusSerial]: FocusSerial.md + [FocusSerial]: Kaleidoscope-FocusSerial.md ### `firmware.dump` @@ -40,4 +40,4 @@ The plugin provides a single [Focus][FocusSerial] command: ## Dependencies -* [Kaleidoscope-FocusSerial][FocusSerial] +* [Kaleidoscope-FocusSerial][Kaleidoscope-FocusSerial.md] diff --git a/plugins/Kaleidoscope-FocusSerial/README.md b/plugins/Kaleidoscope-FocusSerial/README.md index a76e4530..1c1fdceb 100644 --- a/plugins/Kaleidoscope-FocusSerial/README.md +++ b/plugins/Kaleidoscope-FocusSerial/README.md @@ -4,7 +4,7 @@ Bidirectional communication for Kaleidoscope. With this plugin enabled, plugins This plugin is an upgrade of the former [Kaleidoscope-Focus][kaleidoscope:focus] plugin. See the [UPGRADING.md][upgrading] document for information about how to transition to the new system. - [kaleidoscope:focus]: https://github.com/keyboardio/Kaleidoscope-Focus + [kaleidoscope:focus]: (Kaleidoscope-FocusSerial.md) [upgrading]: ../../UPGRADING.md#bidirectional-communication-for-plugins ## Using the plugin diff --git a/plugins/Kaleidoscope-Heatmap/README.md b/plugins/Kaleidoscope-Heatmap/README.md index a163cf47..5b2be8b3 100644 --- a/plugins/Kaleidoscope-Heatmap/README.md +++ b/plugins/Kaleidoscope-Heatmap/README.md @@ -79,7 +79,7 @@ and properties: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-HostOS/README.md b/plugins/Kaleidoscope-HostOS/README.md index 1376e1cf..35534c1b 100644 --- a/plugins/Kaleidoscope-HostOS/README.md +++ b/plugins/Kaleidoscope-HostOS/README.md @@ -11,7 +11,7 @@ can then be reused by other plugins. See the [Unicode][plugin:unicode] extension for an example about how to use `HostOS` in practice. - [plugin:unicode]: Unicode.md + [plugin:unicode]: Kaleidoscope-Unicode.md ## Using the extension @@ -74,7 +74,7 @@ provides the `hostos.type` Focus command. ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) ## Further reading diff --git a/plugins/Kaleidoscope-HostPowerManagement/README.md b/plugins/Kaleidoscope-HostPowerManagement/README.md index 6f159ce2..bfddcc2e 100644 --- a/plugins/Kaleidoscope-HostPowerManagement/README.md +++ b/plugins/Kaleidoscope-HostPowerManagement/README.md @@ -23,7 +23,7 @@ void setup () { The plugin provides the `HostPowerManagement` object, with no public methods. -## Overrideable methods +## Overridable methods ### `hostPowerManagementEventHandler(event)` diff --git a/plugins/Kaleidoscope-IdleLEDs/README.md b/plugins/Kaleidoscope-IdleLEDs/README.md index 8f4c0d0c..d2ab5ad8 100644 --- a/plugins/Kaleidoscope-IdleLEDs/README.md +++ b/plugins/Kaleidoscope-IdleLEDs/README.md @@ -96,7 +96,7 @@ the following properties and methods. The plugin provides a single [Focus][FocusSerial] command, but only when using the `PersistentIdleLEDs` variant: - [FocusSerial]: FocusSerial.md + [FocusSerial]: Kaleidoscope-FocusSerial.md ### `idleleds.time_limit [seconds]` @@ -108,12 +108,12 @@ the `PersistentIdleLEDs` variant: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ### Optional dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [FocusSerial](FocusSerial.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [FocusSerial](Kaleidoscope-FocusSerial.md) ## Further reading diff --git a/plugins/Kaleidoscope-LED-ActiveLayerColor/README.md b/plugins/Kaleidoscope-LED-ActiveLayerColor/README.md index ac7b7ead..6195f140 100644 --- a/plugins/Kaleidoscope-LED-ActiveLayerColor/README.md +++ b/plugins/Kaleidoscope-LED-ActiveLayerColor/README.md @@ -1,7 +1,7 @@ # LED-ActiveLayerColor A simple way to light up the keyboard in uniform colors, depending on what layer -one's on. Unlike [Colormap](Colormap.md), all keys will be the same color. But +one's on. Unlike [Colormap](Kaleidoscope-Colormap.md), all keys will be the same color. But this plugin uses considerably less resources, and is easier to set up as well. A perfect solution when one wants to quickly see what layer they're on, with minimal resources and time investment. @@ -43,7 +43,7 @@ method: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-LED-ActiveModColor/README.md b/plugins/Kaleidoscope-LED-ActiveModColor/README.md index 939074cb..16dc6ba2 100644 --- a/plugins/Kaleidoscope-LED-ActiveModColor/README.md +++ b/plugins/Kaleidoscope-LED-ActiveModColor/README.md @@ -53,8 +53,8 @@ The `ActiveModColorEffect` object provides the following methods: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) -* [Kaleidoscope-OneShot](OneShot.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) +* [Kaleidoscope-OneShot](Kaleidoscope-OneShot.md) ## Further reading diff --git a/plugins/Kaleidoscope-LED-AlphaSquare/README.md b/plugins/Kaleidoscope-LED-AlphaSquare/README.md index a0d9ac68..31da49c8 100644 --- a/plugins/Kaleidoscope-LED-AlphaSquare/README.md +++ b/plugins/Kaleidoscope-LED-AlphaSquare/README.md @@ -92,7 +92,7 @@ been an exaggeration, there is only one as of this writing: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-LED-Palette-Theme/README.md b/plugins/Kaleidoscope-LED-Palette-Theme/README.md index 46526de0..f92f249a 100644 --- a/plugins/Kaleidoscope-LED-Palette-Theme/README.md +++ b/plugins/Kaleidoscope-LED-Palette-Theme/README.md @@ -116,9 +116,9 @@ The plugin provides the `LEDPaletteTheme` object, which has the following method ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) -* [Kaleidoscope-FocusSerial](FocusSerial.md) -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-LED-Stalker/README.md b/plugins/Kaleidoscope-LED-Stalker/README.md index f7d19be3..6cbdb2a8 100644 --- a/plugins/Kaleidoscope-LED-Stalker/README.md +++ b/plugins/Kaleidoscope-LED-Stalker/README.md @@ -80,7 +80,7 @@ The plugin provides the following effects: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-LED-Wavepool/README.md b/plugins/Kaleidoscope-LED-Wavepool/README.md index 8aee3040..e1c4c5ab 100644 --- a/plugins/Kaleidoscope-LED-Wavepool/README.md +++ b/plugins/Kaleidoscope-LED-Wavepool/README.md @@ -51,11 +51,11 @@ properties: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: /examples/LEDS/LED-Wavepool/LED-Wavepool.ino + [plugin:example]: /examples/LEDs/LED-Wavepool/LED-Wavepool.ino diff --git a/plugins/Kaleidoscope-LEDEffect-BootAnimation/README.md b/plugins/Kaleidoscope-LEDEffect-BootAnimation/README.md index b2b25d90..c4bdafe3 100644 --- a/plugins/Kaleidoscope-LEDEffect-BootAnimation/README.md +++ b/plugins/Kaleidoscope-LEDEffect-BootAnimation/README.md @@ -42,4 +42,4 @@ properties: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) diff --git a/plugins/Kaleidoscope-LEDEffect-BootGreeting/README.md b/plugins/Kaleidoscope-LEDEffect-BootGreeting/README.md index a938340b..20ee0236 100644 --- a/plugins/Kaleidoscope-LEDEffect-BootGreeting/README.md +++ b/plugins/Kaleidoscope-LEDEffect-BootGreeting/README.md @@ -143,4 +143,4 @@ properties: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) diff --git a/plugins/Kaleidoscope-LEDEffect-Breathe/README.md b/plugins/Kaleidoscope-LEDEffect-Breathe/README.md index c5d5718c..a0a9033e 100644 --- a/plugins/Kaleidoscope-LEDEffect-Breathe/README.md +++ b/plugins/Kaleidoscope-LEDEffect-Breathe/README.md @@ -36,4 +36,4 @@ The plugin provides the `LEDBreatheEffect` object, which has a single property: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) diff --git a/plugins/Kaleidoscope-LEDEffect-Chase/README.md b/plugins/Kaleidoscope-LEDEffect-Chase/README.md index 1ccfb4c8..5cd94751 100644 --- a/plugins/Kaleidoscope-LEDEffect-Chase/README.md +++ b/plugins/Kaleidoscope-LEDEffect-Chase/README.md @@ -41,4 +41,4 @@ outside of those provided by all LED modes: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) diff --git a/plugins/Kaleidoscope-LEDEffect-Rainbow/README.md b/plugins/Kaleidoscope-LEDEffect-Rainbow/README.md index 8f524a4d..b596a4e4 100644 --- a/plugins/Kaleidoscope-LEDEffect-Rainbow/README.md +++ b/plugins/Kaleidoscope-LEDEffect-Rainbow/README.md @@ -48,4 +48,4 @@ both of which provide the following methods: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) diff --git a/plugins/Kaleidoscope-LEDEffect-SolidColor/README.md b/plugins/Kaleidoscope-LEDEffect-SolidColor/README.md index 1d767083..813f3513 100644 --- a/plugins/Kaleidoscope-LEDEffect-SolidColor/README.md +++ b/plugins/Kaleidoscope-LEDEffect-SolidColor/README.md @@ -23,4 +23,4 @@ void setup() { ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) diff --git a/plugins/Kaleidoscope-LEDEffects/README.md b/plugins/Kaleidoscope-LEDEffects/README.md index 54d11ee8..906db7ae 100644 --- a/plugins/Kaleidoscope-LEDEffects/README.md +++ b/plugins/Kaleidoscope-LEDEffects/README.md @@ -61,7 +61,7 @@ The plugin provides a single method on each of the included effect objects: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-LayerFocus/README.md b/plugins/Kaleidoscope-LayerFocus/README.md index 38fef8c6..6123389c 100644 --- a/plugins/Kaleidoscope-LayerFocus/README.md +++ b/plugins/Kaleidoscope-LayerFocus/README.md @@ -3,7 +3,7 @@ The `LayerFocus` plugin exposes a number of layer-related commands via [Focus][plugin:focus], to allow controlling layers from the host side. - [plugin:focus]: FocusSerial.md + [plugin:focus]: Kaleidoscope-FocusSerial.md ## Using the plugin @@ -43,4 +43,4 @@ The plugin provides the following Focus commands: ## Dependencies -* [Kaleidoscope-FocusSerial](FocusSerial.md) +* [Kaleidoscope-FocusSerial](Kaleidoscope-FocusSerial.md) diff --git a/plugins/Kaleidoscope-Leader/README.md b/plugins/Kaleidoscope-Leader/README.md index 7ab591d5..0643ae3e 100644 --- a/plugins/Kaleidoscope-Leader/README.md +++ b/plugins/Kaleidoscope-Leader/README.md @@ -90,7 +90,7 @@ The plugin provides the `Leader` object, with the following methods and properti ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-OneShot/README.md b/plugins/Kaleidoscope-OneShot/README.md index 88732462..539b997e 100644 --- a/plugins/Kaleidoscope-OneShot/README.md +++ b/plugins/Kaleidoscope-OneShot/README.md @@ -40,7 +40,7 @@ modifier will now stay on until you press it again. Continuing the Shift, d, e, f` will give you `ABCdef`. This can be a bit tricky; combining this plugin with -[LED-ActiveModColor](LED-ActiveModColor.md) +[LED-ActiveModColor](Kaleidoscope-LED-ActiveModColor.md) will help you understand what state your one-shot is in; when a one-shot key is active, it will have a white LED highlight; when sticky, a red highlight. (These colors are configurable.) @@ -195,7 +195,7 @@ properties too: ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-Redial/README.md b/plugins/Kaleidoscope-Redial/README.md index 26cce41e..91f4b142 100644 --- a/plugins/Kaleidoscope-Redial/README.md +++ b/plugins/Kaleidoscope-Redial/README.md @@ -23,7 +23,7 @@ void setup() { } ``` -## Overrideable plugin methods +## Overridable plugin methods ### `bool shouldRemember(Key mapped_key)` @@ -37,7 +37,7 @@ void setup() { ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-ShapeShifter/README.md b/plugins/Kaleidoscope-ShapeShifter/README.md index 08da50fc..9d4a9f73 100644 --- a/plugins/Kaleidoscope-ShapeShifter/README.md +++ b/plugins/Kaleidoscope-ShapeShifter/README.md @@ -47,7 +47,7 @@ properties: > Set this property to the dictionary `ShapeShifter` should use. The dictionary > is an array of `kaleidoscope::ShapeShifter::dictionary_t` elements, which is -> just a very verbose way of saying that its a pair of keys. The first one is +> just a very verbose way of saying that it is a pair of keys. The first one is > the one to replace, and the other is to replace it with. > > Be aware that the replacement key will be pressed with `Shift` held, so do diff --git a/plugins/Kaleidoscope-SpaceCadet/README.md b/plugins/Kaleidoscope-SpaceCadet/README.md index a85a590f..4b6a0574 100644 --- a/plugins/Kaleidoscope-SpaceCadet/README.md +++ b/plugins/Kaleidoscope-SpaceCadet/README.md @@ -88,7 +88,7 @@ properties: > Set the key map. This takes an array of > `kaleidoscope::plugin::SpaceCadet::KeyBinding` objects with the special -> `SPACECADET_MAP_END` sentinal to mark the end of the map. Each KeyBinding +> `SPACECADET_MAP_END` sentinel to mark the end of the map. Each KeyBinding > object takes, in order, the key that was pressed, the key that should be sent > instead, and an optional per-key timeout override > @@ -136,18 +136,18 @@ properties: ### `Key_SpaceCadetEnable` > This provides a key for placing on a keymap for enabling the SpaceCadet -> behavior. This is only triggered on initial downpress, and does not +> behavior. This is only triggered on initial press, and does not > trigger again if held down or when the key is released. ### `Key_SpaceCadetDisable` > This provides a key for placing on a keymap for disabling the SpaceCadet -> behavior. This is only triggered on initial downpress, and does not +> behavior. This is only triggered on initial press, and does not > trigger again if held down or when the key is released. ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-Steno/README.md b/plugins/Kaleidoscope-Steno/README.md index 2351d093..91362653 100644 --- a/plugins/Kaleidoscope-Steno/README.md +++ b/plugins/Kaleidoscope-Steno/README.md @@ -22,7 +22,7 @@ port, so any plugin that wants to use that port too, will run into conflicts with the Steno plugin. In other words, don't use it together with [Focus][k:focus]. - [k:focus]: FocusSerial.md + [k:focus]: Kaleidoscope-FocusSerial.md ## What is Steno? Why should I use it? How do I learn? @@ -86,7 +86,7 @@ The plugin provides a `GeminiPR` object, with no public methods or properties. ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-Syster/README.md b/plugins/Kaleidoscope-Syster/README.md index 45ad2f87..31735305 100644 --- a/plugins/Kaleidoscope-Syster/README.md +++ b/plugins/Kaleidoscope-Syster/README.md @@ -86,7 +86,7 @@ methods outside of the object, however, that can be overridden: ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-TapDance/README.md b/plugins/Kaleidoscope-TapDance/README.md index ed4616d8..dc8bc149 100644 --- a/plugins/Kaleidoscope-TapDance/README.md +++ b/plugins/Kaleidoscope-TapDance/README.md @@ -136,7 +136,7 @@ property only: ## Dependencies -* [Kaleidoscope-Ranges](Ranges.md) +* [Kaleidoscope-Ranges](Kaleidoscope-Ranges.md) ## Further reading diff --git a/plugins/Kaleidoscope-Turbo/README.md b/plugins/Kaleidoscope-Turbo/README.md index 646d1254..cfbe1141 100644 --- a/plugins/Kaleidoscope-Turbo/README.md +++ b/plugins/Kaleidoscope-Turbo/README.md @@ -2,7 +2,7 @@ The `Turbo` plugin provides an extra key one can place on their keymap. While the key is pressed or toggled, pressing other keys will generate quick repeated -inputs independent of the OS key repeation mechanics. +inputs independent of the OS key repetition mechanics. ## Using the plugin @@ -73,7 +73,7 @@ The `Turbo` object has the following user-configurable properties: ## Dependencies -* [Kaleidoscope-LEDControl](LEDControl.md) +* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md) ## Further reading diff --git a/plugins/Kaleidoscope-TypingBreaks/README.md b/plugins/Kaleidoscope-TypingBreaks/README.md index ed69aecc..8a5ed733 100644 --- a/plugins/Kaleidoscope-TypingBreaks/README.md +++ b/plugins/Kaleidoscope-TypingBreaks/README.md @@ -98,7 +98,7 @@ properties. All times are in seconds. ## Dependencies -* [Kaleidoscope-EEPROM-Settings](EEPROM-Settings.md) +* [Kaleidoscope-EEPROM-Settings](Kaleidoscope-EEPROM-Settings.md) ## Further reading diff --git a/plugins/Kaleidoscope-USB-Quirks/README.md b/plugins/Kaleidoscope-USB-Quirks/README.md index 41f96147..dcd3f960 100644 --- a/plugins/Kaleidoscope-USB-Quirks/README.md +++ b/plugins/Kaleidoscope-USB-Quirks/README.md @@ -31,7 +31,7 @@ The plugin provides one object, `USBQuirks`, which provides the following method > Toggle between `Boot` and `Report` protocol by detaching, and then > re-attaching the USB devices, and setting the `BootKeyboard` protocol -> inbetween. +> in between. > > This is most useful when one needs to have a boot keyboard, when one's in a > BIOS, boot loader, or early password prompt or the like, and the host does not diff --git a/plugins/Kaleidoscope-Unicode/README.md b/plugins/Kaleidoscope-Unicode/README.md index 932743c1..912a5ff4 100644 --- a/plugins/Kaleidoscope-Unicode/README.md +++ b/plugins/Kaleidoscope-Unicode/README.md @@ -75,7 +75,7 @@ functionality. > > Defaults to zero, no delay. -## Overrideable methods +## Overridable methods ### `hexToKey(hex_digit)` @@ -108,7 +108,7 @@ functionality. ## Dependencies -* [Kaleidoscope-HostOS](HostOS.md) +* [Kaleidoscope-HostOS](Kaleidoscope-HostOS.md) ## Other Configuration