From 717626ad1845293c6ff6dfef9c4b25a3fea10067 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 7 Dec 2018 12:17:50 +0100 Subject: [PATCH] doc/plugin/: Update all the example references The examples were recently reorganized, but the documentation was not updated, so some of them were pointing to dangling, obsolete places. This updates them all to point to the correct locations. Signed-off-by: Gergely Nagy --- doc/plugin/Colormap.md | 2 +- doc/plugin/Cycle.md | 2 +- doc/plugin/CycleTimeReport.md | 2 +- doc/plugin/EEPROM-Keymap-Programmer.md | 2 +- doc/plugin/EEPROM-Keymap.md | 2 +- doc/plugin/EEPROM-Settings.md | 2 +- doc/plugin/Escape-OneShot.md | 2 +- doc/plugin/FingerPainter.md | 2 +- doc/plugin/FocusSerial.md | 2 +- doc/plugin/GhostInTheFirmware.md | 2 +- doc/plugin/Heatmap.md | 2 +- doc/plugin/HostOS.md | 2 +- doc/plugin/HostPowerManagement.md | 2 +- doc/plugin/IdleLEDs.md | 2 +- doc/plugin/LED-ActiveModColor.md | 2 +- doc/plugin/LED-AlphaSquare.md | 2 +- doc/plugin/LED-Palette-Theme.md | 2 +- doc/plugin/LED-Stalker.md | 2 +- doc/plugin/LEDEffects.md | 2 +- doc/plugin/Leader.md | 2 +- doc/plugin/MagicCombo.md | 2 +- doc/plugin/OneShot.md | 2 +- doc/plugin/Qukeys.md | 2 +- doc/plugin/Redial.md | 2 +- doc/plugin/ShapeShifter.md | 2 +- doc/plugin/SpaceCadet.md | 2 +- doc/plugin/Steno.md | 2 +- doc/plugin/Syster.md | 2 +- doc/plugin/TapDance.md | 2 +- doc/plugin/TopsyTurvy.md | 2 +- doc/plugin/TypingBreaks.md | 2 +- doc/plugin/Unicode.md | 2 +- doc/plugin/WinKeyToggle.md | 2 +- 33 files changed, 33 insertions(+), 33 deletions(-) diff --git a/doc/plugin/Colormap.md b/doc/plugin/Colormap.md index 008e679f..bbcc42e8 100644 --- a/doc/plugin/Colormap.md +++ b/doc/plugin/Colormap.md @@ -66,4 +66,4 @@ The extension provides an `ColormapEffect` singleton object, with a single metho Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Colormap/Colormap.ino + [plugin:example]: ../../examples/LEDs/Colormap/Colormap.ino diff --git a/doc/plugin/Cycle.md b/doc/plugin/Cycle.md index ac3e1224..57550441 100644 --- a/doc/plugin/Cycle.md +++ b/doc/plugin/Cycle.md @@ -96,4 +96,4 @@ method explained below. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Cycle/Cycle.ino + [plugin:example]: ../../examples/Keystrokes/Cycle/Cycle.ino diff --git a/doc/plugin/CycleTimeReport.md b/doc/plugin/CycleTimeReport.md index 67edd99e..ef594022 100644 --- a/doc/plugin/CycleTimeReport.md +++ b/doc/plugin/CycleTimeReport.md @@ -50,4 +50,4 @@ property. All times are in milliseconds. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/CycleTimeReport/CycleTimeReport.ino + [plugin:example]: ../../examples/Features/CycleTimeReport/CycleTimeReport.ino diff --git a/doc/plugin/EEPROM-Keymap-Programmer.md b/doc/plugin/EEPROM-Keymap-Programmer.md index e8509a72..ec393934 100644 --- a/doc/plugin/EEPROM-Keymap-Programmer.md +++ b/doc/plugin/EEPROM-Keymap-Programmer.md @@ -121,4 +121,4 @@ in turn provides the following command: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/EEPROM-Keymap-Programmer/EEPROM-Keymap-Programmer.ino + [plugin:example]: ../../examples/Features/EEPROM/EEPROM-Keymap-Programmer/EEPROM-Keymap-Programmer.ino diff --git a/doc/plugin/EEPROM-Keymap.md b/doc/plugin/EEPROM-Keymap.md index be343bec..6e01a116 100644 --- a/doc/plugin/EEPROM-Keymap.md +++ b/doc/plugin/EEPROM-Keymap.md @@ -62,4 +62,4 @@ The plugin provides the `keymap.map` and a `keymap.roLayers` commands. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/EEPROM-Keymap/EEPROM-Keymap.ino + [plugin:example]: ../../examples/Features/EEPROM/EEPROM-Keymap/EEPROM-Keymap.ino diff --git a/doc/plugin/EEPROM-Settings.md b/doc/plugin/EEPROM-Settings.md index 598e7ae3..c781fd46 100644 --- a/doc/plugin/EEPROM-Settings.md +++ b/doc/plugin/EEPROM-Settings.md @@ -165,4 +165,4 @@ following commands: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/EEPROM-Settings/EEPROM-Settings.ino + [plugin:example]: ../../examples/Features/EEPROM/EEPROM-Settings/EEPROM-Settings.ino diff --git a/doc/plugin/Escape-OneShot.md b/doc/plugin/Escape-OneShot.md index 4a6ab137..7a2c9e1c 100644 --- a/doc/plugin/Escape-OneShot.md +++ b/doc/plugin/Escape-OneShot.md @@ -38,4 +38,4 @@ The plugin provides the `EscapeOneShot` object, which has no public methods. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Escape-OneShot/Escape-OneShot.ino + [plugin:example]: ../../examples/Keystrokes/Escape-OneShot/Escape-OneShot.ino diff --git a/doc/plugin/FingerPainter.md b/doc/plugin/FingerPainter.md index c2b512ec..064b385c 100644 --- a/doc/plugin/FingerPainter.md +++ b/doc/plugin/FingerPainter.md @@ -59,4 +59,4 @@ The plugin provides the `FingerPainter` object, which provides no public methods Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/FingerPainter/FingerPainter.ino + [plugin:example]: ../../examples/LEDs/FingerPainter/FingerPainter.ino diff --git a/doc/plugin/FocusSerial.md b/doc/plugin/FocusSerial.md index 2ff89069..9687fdb8 100644 --- a/doc/plugin/FocusSerial.md +++ b/doc/plugin/FocusSerial.md @@ -123,4 +123,4 @@ the keyboard responds. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/FocusSerial/FocusSerial.ino + [plugin:example]: ../../examples/Features/FocusSerial/FocusSerial.ino diff --git a/doc/plugin/GhostInTheFirmware.md b/doc/plugin/GhostInTheFirmware.md index cfded92a..93e6e89c 100644 --- a/doc/plugin/GhostInTheFirmware.md +++ b/doc/plugin/GhostInTheFirmware.md @@ -74,4 +74,4 @@ methods and properties: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/GhostInTheFirmware/GhostInTheFirmware.ino + [plugin:example]: ../../examples/Features/GhostInTheFirmware/GhostInTheFirmware.ino diff --git a/doc/plugin/Heatmap.md b/doc/plugin/Heatmap.md index 2e3d0402..f00c7238 100644 --- a/doc/plugin/Heatmap.md +++ b/doc/plugin/Heatmap.md @@ -86,4 +86,4 @@ and properties: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Heatmap/Heatmap.ino + [plugin:example]: ../../examples/LEDs/Heatmap/Heatmap.ino diff --git a/doc/plugin/HostOS.md b/doc/plugin/HostOS.md index 8b7f6884..4a333e37 100644 --- a/doc/plugin/HostOS.md +++ b/doc/plugin/HostOS.md @@ -81,4 +81,4 @@ provides the `hostos.type` Focus command. Starting from the [example][plugin:example] is the recommended way of getting started with the extension. - [plugin:example]: ../../examples/HostOS/HostOS.ino + [plugin:example]: ../../examples/Features/HostOS/HostOS.ino diff --git a/doc/plugin/HostPowerManagement.md b/doc/plugin/HostPowerManagement.md index bd9973f3..e5035a13 100644 --- a/doc/plugin/HostPowerManagement.md +++ b/doc/plugin/HostPowerManagement.md @@ -44,4 +44,4 @@ The plugin provides the `HostPowerManagement` object, with no public methods. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/HostPowerManagement/HostPowerManagement.ino + [plugin:example]: ../../examples/Features/HostPowerManagement/HostPowerManagement.ino diff --git a/doc/plugin/IdleLEDs.md b/doc/plugin/IdleLEDs.md index 548df5da..48ebd797 100644 --- a/doc/plugin/IdleLEDs.md +++ b/doc/plugin/IdleLEDs.md @@ -55,4 +55,4 @@ properties. All times are in seconds. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/IdleLEDs/IdleLEDs.ino + [plugin:example]: ../../examples/LEDs/IdleLEDs/IdleLEDs.ino diff --git a/doc/plugin/LED-ActiveModColor.md b/doc/plugin/LED-ActiveModColor.md index 2776ec84..46e1000f 100644 --- a/doc/plugin/LED-ActiveModColor.md +++ b/doc/plugin/LED-ActiveModColor.md @@ -53,4 +53,4 @@ properties: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/LED-ActiveModColor/LED-ActiveModColor.ino + [plugin:example]: ../../examples/LEDs/LED-ActiveModColor/LED-ActiveModColor.ino diff --git a/doc/plugin/LED-AlphaSquare.md b/doc/plugin/LED-AlphaSquare.md index 12eced9a..e24795d3 100644 --- a/doc/plugin/LED-AlphaSquare.md +++ b/doc/plugin/LED-AlphaSquare.md @@ -99,4 +99,4 @@ been an exaggeration, there is only one as of this writing: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/LED-AlphaSquare/LED-AlphaSquare.ino + [plugin:example]: ../../examples/LEDs/LED-AlphaSquare/LED-AlphaSquare.ino diff --git a/doc/plugin/LED-Palette-Theme.md b/doc/plugin/LED-Palette-Theme.md index 34789469..b2f99b8e 100644 --- a/doc/plugin/LED-Palette-Theme.md +++ b/doc/plugin/LED-Palette-Theme.md @@ -125,4 +125,4 @@ The plugin provides the `LEDPaletteTheme` object, which has the following method Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/LED-Palette-Theme/LED-Palette-Theme.ino + [plugin:example]: ../../examples/LEDs/LED-Palette-Theme/LED-Palette-Theme.ino diff --git a/doc/plugin/LED-Stalker.md b/doc/plugin/LED-Stalker.md index 85a6fe8d..8a0d74b6 100644 --- a/doc/plugin/LED-Stalker.md +++ b/doc/plugin/LED-Stalker.md @@ -87,4 +87,4 @@ The plugin provides the following effects: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/LED-Stalker/LED-Stalker.ino + [plugin:example]: ../../examples/LEDs/LED-Stalker/LED-Stalker.ino diff --git a/doc/plugin/LEDEffects.md b/doc/plugin/LEDEffects.md index b6e358c2..b0a53b68 100644 --- a/doc/plugin/LEDEffects.md +++ b/doc/plugin/LEDEffects.md @@ -68,4 +68,4 @@ The plugin provides a single method on each of the included effect objects: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/LEDEffects/LEDEffects.ino + [plugin:example]: ../../examples/LEDs/LEDEffects/LEDEffects.ino diff --git a/doc/plugin/Leader.md b/doc/plugin/Leader.md index 26b62b1b..3feef1cd 100644 --- a/doc/plugin/Leader.md +++ b/doc/plugin/Leader.md @@ -97,4 +97,4 @@ The plugin provides the `Leader` object, with the following methods and properti Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Leader/Leader.ino + [plugin:example]: ../../examples/Keystrokes/Leader/Leader.ino diff --git a/doc/plugin/MagicCombo.md b/doc/plugin/MagicCombo.md index 139ca26f..a3acbb58 100644 --- a/doc/plugin/MagicCombo.md +++ b/doc/plugin/MagicCombo.md @@ -67,4 +67,4 @@ started with the plugin. ![rxcy layout](../model01_coordinates.png) - [plugin:example]: ../../examples/MagicCombo/MagicCombo.ino + [plugin:example]: ../../examples/Keystrokes/MagicCombo/MagicCombo.ino diff --git a/doc/plugin/OneShot.md b/doc/plugin/OneShot.md index d04ab1b6..226dc89c 100644 --- a/doc/plugin/OneShot.md +++ b/doc/plugin/OneShot.md @@ -203,4 +203,4 @@ properties too: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/OneShot/OneShot.ino + [plugin:example]: ../../examples/Keystrokes/OneShot/OneShot.ino diff --git a/doc/plugin/Qukeys.md b/doc/plugin/Qukeys.md index 7ec30bf5..0a5079e0 100644 --- a/doc/plugin/Qukeys.md +++ b/doc/plugin/Qukeys.md @@ -149,4 +149,4 @@ limit, you won't get any unintended alternate keycodes. The [example][plugin:example] can help to learn how to use this plugin. - [plugin:example]: ../../examples/Qukeys/Qukeys.ino + [plugin:example]: ../../examples/Keystrokes/Qukeys/Qukeys.ino diff --git a/doc/plugin/Redial.md b/doc/plugin/Redial.md index 67cd56b2..38206e20 100644 --- a/doc/plugin/Redial.md +++ b/doc/plugin/Redial.md @@ -60,4 +60,4 @@ The `Redial` object has only one property, the key to trigger it. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Redial/Redial.ino + [plugin:example]: ../../examples/Keystrokes/Redial/Redial.ino diff --git a/doc/plugin/ShapeShifter.md b/doc/plugin/ShapeShifter.md index f5874fb1..74bd008f 100644 --- a/doc/plugin/ShapeShifter.md +++ b/doc/plugin/ShapeShifter.md @@ -58,4 +58,4 @@ properties: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/ShapeShifter/ShapeShifter.ino + [plugin:example]: ../../examples/Keystrokes/ShapeShifter/ShapeShifter.ino diff --git a/doc/plugin/SpaceCadet.md b/doc/plugin/SpaceCadet.md index 6906f73f..ac7e17da 100644 --- a/doc/plugin/SpaceCadet.md +++ b/doc/plugin/SpaceCadet.md @@ -154,4 +154,4 @@ properties: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/SpaceCadet/SpaceCadet.ino + [plugin:example]: ../../examples/Keystrokes/SpaceCadet/SpaceCadet.ino diff --git a/doc/plugin/Steno.md b/doc/plugin/Steno.md index 949f808e..272a85fd 100644 --- a/doc/plugin/Steno.md +++ b/doc/plugin/Steno.md @@ -93,4 +93,4 @@ The plugin provides a `GeminiPR` object, with no public methods or properties. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Steno/Steno.ino + [plugin:example]: ../../examples/Features/Steno/Steno.ino diff --git a/doc/plugin/Syster.md b/doc/plugin/Syster.md index 9eee3a07..6345b20a 100644 --- a/doc/plugin/Syster.md +++ b/doc/plugin/Syster.md @@ -94,4 +94,4 @@ methods outside of the object, however, that can be overridden: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Syster/Syster.ino + [plugin:example]: ../../examples/Keystrokes/Syster/Syster.ino diff --git a/doc/plugin/TapDance.md b/doc/plugin/TapDance.md index 45e7ae2a..1ee710c2 100644 --- a/doc/plugin/TapDance.md +++ b/doc/plugin/TapDance.md @@ -143,4 +143,4 @@ property only: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/TapDance/TapDance.ino + [plugin:example]: ../../examples/Keystrokes/TapDance/TapDance.ino diff --git a/doc/plugin/TopsyTurvy.md b/doc/plugin/TopsyTurvy.md index c4370c48..dc4df213 100644 --- a/doc/plugin/TopsyTurvy.md +++ b/doc/plugin/TopsyTurvy.md @@ -48,4 +48,4 @@ The plugin provides the `TopsyTurvy` object, without any public methods or prope Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/TopsyTurvy/TopsyTurvy.ino + [plugin:example]: ../../examples/Keystrokes/TopsyTurvy/TopsyTurvy.ino diff --git a/doc/plugin/TypingBreaks.md b/doc/plugin/TypingBreaks.md index c8ad6d31..b9c8e72b 100644 --- a/doc/plugin/TypingBreaks.md +++ b/doc/plugin/TypingBreaks.md @@ -105,4 +105,4 @@ properties. All times are in seconds. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/TypingBreaks/TypingBreaks.ino + [plugin:example]: ../../examples/Features/TypingBreaks/TypingBreaks.ino diff --git a/doc/plugin/Unicode.md b/doc/plugin/Unicode.md index 9021d0cf..e2eacfb4 100644 --- a/doc/plugin/Unicode.md +++ b/doc/plugin/Unicode.md @@ -121,4 +121,4 @@ the `+` button, selecting it from the list, then setting it as the active input Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/Unicode/Unicode.ino + [plugin:example]: ../../examples/Keystrokes/Unicode/Unicode.ino diff --git a/doc/plugin/WinKeyToggle.md b/doc/plugin/WinKeyToggle.md index 8995177e..f784adb9 100644 --- a/doc/plugin/WinKeyToggle.md +++ b/doc/plugin/WinKeyToggle.md @@ -52,4 +52,4 @@ method: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: ../../examples/WinKeyToggle/WinKeyToggle.ino + [plugin:example]: ../../examples/Keystrokes/WinKeyToggle/WinKeyToggle.ino