Remove the "Kaleidoscope-" prefix from the titles of plugin docs

pull/784/head
Jesse Vincent 5 years ago
parent d3e0252a75
commit ba47ccf4e5
No known key found for this signature in database
GPG Key ID: CC228463465E40BC

@ -1,4 +1,4 @@
# Kaleidoscope-Colormap
# Colormap
The `Colormap` extension provides an easier way to set up a different - static -
color map per-layer. This means that we can set up a map of colors for each key,

@ -1,4 +1,4 @@
# Kaleidoscope-Cycle
# Cycle
If you ever wanted a key that works like keys on old cell phones, when you press
a key and it cycles through a number of options in a sequence, then the cycling

@ -1,4 +1,4 @@
# Kaleidoscope-CycleTimeReport
# CycleTimeReport
A development and debugging aid, this plugin will measure average mainloop times
(in microseconds) and print it to `Serial` periodically. While not the most

@ -1,4 +1,4 @@
# Kaleidoscope-DynamicMacros
# DynamicMacros
Dynamic macros are similar to [Macros][plugin:macros], but unlike them, they can
be re-defined without compiling and flashing new firmware: one can change

@ -1,4 +1,4 @@
# Kaleidoscope-DynamicTapDance
# DynamicTapDance
The `DynamicTapDance` plugin allows one to set up [TapDance][plugin:tapdance] keys
without the need to compile and flash new firmware: one can change dynamic

@ -1,4 +1,4 @@
# Kaleidoscope-EEPROM-Keymap-Programmer
# EEPROM-Keymap-Programmer
Inspired by a similar feature on other keyboards, the `EEPROM-Keymap-Programmer`
plugin implements an on-device keymap re-arrangement / re-coding system. There

@ -1,4 +1,4 @@
# Kaleidoscope-EEPROM-Keymap
# EEPROM-Keymap
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 additional layers there.

@ -1,4 +1,4 @@
# Kaleidoscope-EEPROM-Settings
# EEPROM-Settings
To be able to reliably store persistent configuration in `EEPROM`, we need to be
able to split up the available space for plugins to use. We also want to make

@ -1,4 +1,4 @@
# Kaleidoscope-Escape-OneShot
# Escape-OneShot
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, or if any of them

@ -1,4 +1,4 @@
# Kaleidoscope-FingerPainter
# FingerPainter
The `FingerPainter` plugin provides an elaborate `LED` mode, in which one's able
to paint with their fingers: when edit mode is toggled on, keys will - instead

@ -1,4 +1,4 @@
# Kaleidoscope-FirmwareDump
# FirmwareDump
This plugin provides a single Focus command: `firmware.dump`, which dumps the
firmware's executable code. One might rightfully wonder what purpose this serves

@ -1,4 +1,4 @@
# Kaleidoscope-FocusSerial
# FocusSerial
Bidirectional communication for Kaleidoscope. With this plugin enabled, plugins that implement the `onFocusEvent` hook will start responding to Focus commands sent via `Serial`, allowing bidirectional communication between firmware and host.

@ -1,4 +1,4 @@
# Kaleidoscope-GhostInTheFirmware
# GhostInTheFirmware
Born out of the desire to demo LED effects on the keyboard without having to
touch it by hand (which would obstruct the video), the `GhostInTheFirmware`

@ -1,4 +1,4 @@
# Kaleidoscope-Heatmap
# Heatmap
The `Heatmap` plugin provides a LED effect, that displays a heatmap on the
keyboard. The LEDs under each key will have a color according to how much use

@ -1,4 +1,4 @@
# Kaleidoscope-HostOS
# HostOS
The `HostOS` extension is not all that useful in itself, rather, it is a
building block other plugins and extensions can use to not repeat the same

@ -1,4 +1,4 @@
# Kaleidoscope-HostPowerManagement
# HostPowerManagement
Support performing custom actions whenever the host suspends, resumes, or is
sleeping.

@ -1,4 +1,4 @@
# Kaleidoscope-IdleLEDs
# IdleLEDs
Having LED effects on the keyboard can be exceptionally helpful. However, having
the effects - or lights, in general - on all the time, even when the keyboard is

@ -1,4 +1,4 @@
# Kaleidoscope-LED-ActiveLayerColor
# 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

@ -1,4 +1,4 @@
# Kaleidoscope-LED-ActiveModColor
# LED-ActiveModColor
With this plugin, any active modifier on the keyboard will have the LED under it
highlighted. No matter how the modifier got activated (a key press, a macro,

@ -1,4 +1,4 @@
# Kaleidoscope-LED-AlphaSquare
# LED-AlphaSquare
An alphabet for your per-key LEDs, `AlphaSquare` provides a way to display 4x4
"pixel" symbols on your keyboard. With this building block, one can build some

@ -1,4 +1,4 @@
# Kaleidoscope-LED-Palette-Theme
# LED-Palette-Theme
A common base for plugins that want to provide themes, or theme-related
capabilities, using a 16 color palette. In other words, this is for plugin

@ -1,4 +1,4 @@
# Kaleidoscope-LED-Stalker
# LED-Stalker
The `StalkerEffect` plugin provides an interesting new typing experience: the
LEDs light up as you tap keys and play one of the selected effects: a haunting

@ -1,4 +1,4 @@
# Kaleidoscope-LED-Wavepool
# LED-Wavepool
The `WavepoolEffect` plugin makes waves of light splash out from each keypress.
When idle, it will also simulate gentle rainfall on the keyboard.

@ -1,4 +1,4 @@
# Kaleidoscope-LEDControl
# LEDControl
This is a plugin for [Kaleidoscope][fw], for controlling the LEDs, and LED
effects.

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffect-BootAnimation
# LEDEffect-BootAnimation
With this plugin enabled, the keyboard will play a little boot animation when
starting up (this animation does not inhibit typing, you can still use the

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffect-BootGreeting
# LEDEffect-BootGreeting
If you want to have your keyboard signal when it turns on, but you don't want to
use any more complicated LED modes, this plugin is for you. It will make the

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffect-Breathe
# LEDEffect-Breathe
Provides a breathing effect for the keyboard. Breathe in, breathe out.

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffect-Chase
# LEDEffect-Chase
A simple LED effect where one color chases another across the keyboard and back,
over and over again. Playful colors they are.

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffect-Rainbow
# LEDEffect-Rainbow
Two colorful rainbow effects are implemented by this plugin: one where the
rainbow waves through the keys, and another where the LEDs breathe though the

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffect-SolidColor
# LEDEffect-SolidColor
This plugin provides tools to build LED effects that set the entire keyboard to
a single color. For show, and for backlighting purposes.

@ -1,4 +1,4 @@
# Kaleidoscope-LEDEffects
# LEDEffects
The `LEDEffects` plugin provides a selection of LED effects, each of them fairly
simple, simple enough to not need a plugin of their own.

@ -1,4 +1,4 @@
# Kaleidoscope-Leader
# Leader
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

@ -1,4 +1,4 @@
# Kaleidoscope-Macros
# Macros
Macros are a standard feature on many keyboards and Kaleidoscope-powered ones
are no exceptions. Macros are a way to have a single key-press do a whole lot of

@ -1,4 +1,4 @@
# Kaleidoscope-MagicCombo
# MagicCombo
The `MagicCombo` extension provides a way to perform custom actions when a
particular set of keys are held down together. The functionality assigned to

@ -1,4 +1,4 @@
# Kaleidoscope-MouseKeys
# MouseKeys
Have you ever wanted to control the mouse cursor from the comfort of your
keyboard? With this plugin, you can. While it may not replace the mouse in all

@ -1,4 +1,4 @@
# Kaleidoscope-NumPad
# NumPad
This is a plugin for [Kaleidoscope][fw], that adds a NumPad-specific LED
effect and applies it when the numpad layer is active.

@ -1,4 +1,4 @@
# Kaleidoscope-OneShot
# OneShot
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

@ -1,4 +1,4 @@
# Kaleidoscope-Qukeys
# Qukeys
## Concept

@ -1,4 +1,4 @@
# Kaleidoscope-Ranges
# Ranges
## kaleidoscope::ranges enum

@ -1,4 +1,4 @@
# Kaleidoscope-Redial
# Redial
If you ever wanted to just repeat the last key pressed, no matter what it was,
this plugin is made for you. It allows you to configure a key that will repeat

@ -1,4 +1,4 @@
# Kaleidoscope-ShapeShifter
# ShapeShifter
`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

@ -1,4 +1,4 @@
# Kaleidoscope-SpaceCadet
# SpaceCadet
[Space Cadet][space-cadet] is a way to make it more convenient to input
parens - those `(` and `)` things -, symbols that a lot of programming languages

@ -1,4 +1,4 @@
# Kaleidoscope-Steno
# Steno
Stenography is a way to write in shorthand, a chorded input system that allows
very fast input (considerably higher than normal touch typing), by using

@ -1,4 +1,4 @@
# Kaleidoscope-Syster
# Syster
Syster is a way to input symbols in a different way: instead of macros, Leader
sequences or the like, we trigger the special input mode, and enter the symbol's

@ -1,4 +1,4 @@
# Kaleidoscope-TapDance
# TapDance
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

@ -1,4 +1,4 @@
# Kaleidoscope-TopsyTurvy
# 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,4 +1,4 @@
# Kaleidoscope-TriColor
# TriColor
The `TriColor` effect extension is a part of
the [`LEDEffects`][plugin:ledeffects] library, not a stand-alone base library of

@ -1,4 +1,4 @@
# Kaleidoscope-Turbo
# Turbo
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

@ -1,4 +1,4 @@
# Kaleidoscope-TypingBreaks
# TypingBreaks
Typing on the keyboard for an extended period of time may lead to injuries,
which is why it is highly recommended to take frequent breaks from the

@ -1,4 +1,4 @@
# Kaleidoscope-USB-Quirks
# USB-Quirks
USB-Quirks provides a few methods to deal with more obscure parts of the USB spec, such as changing between `Boot` and `Report` protocols. These are in a separate plugin, because these features are not part of the USB spec, and are often workarounds for various issues. See the provided methods for more information about what they're useful for.

@ -1,4 +1,4 @@
# Kaleidoscope-Unicode
# Unicode
The `Unicode` extension makes it easier to write plugins that input Unicode
symbols on the host. Because inputting Unicode varies from OS to OS, this helper

@ -1,4 +1,4 @@
# Kaleidoscope-WinKeyToggle
# WinKeyToggle
If you ever played games on Windows on a traditional keyboard, you likely ran
into the issue of the Windows key: in the heat of the moment, you accidentally

Loading…
Cancel
Save