Merge pull request #494 from keyboardio/doc/example-link-fixups

doc/plugin/: Update all the example references
pull/260/head
Jesse Vincent 6 years ago committed by GitHub
commit 922fd75dc1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

@ -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

Loading…
Cancel
Save