Browse Source

Docs: Format Space Cadet documentation (#3540)

* Format Space Cadet documentation

* Fix page filenames

* Move Caveats section up
pjones-keymap
fauxpark 11 months ago
parent
commit
03ad6927cb

+ 2
- 2
docs/_sidebar.md View File

@@ -44,8 +44,8 @@
44 44
   * [PS/2 Mouse](feature_ps2_mouse.md)
45 45
   * [RGB Lighting](feature_rgblight.md)
46 46
   * [RGB Matrix](feature_rgb_matrix.md)
47
-  * [Space Cadet Shift](feature_space_cadet.md)
48
-  * [Space Cadet Shift Enter](feature_space_shift_cadet.md)
47
+  * [Space Cadet Shift](feature_space_cadet_shift.md)
48
+  * [Space Cadet Shift Enter](feature_space_cadet_shift_enter.md)
49 49
   * [Stenography](feature_stenography.md)
50 50
   * [Swap Hands](feature_swap_hands.md)
51 51
   * [Tap Dance](feature_tap_dance.md)

+ 2
- 2
docs/_summary.md View File

@@ -44,8 +44,8 @@
44 44
   * [PS/2 Mouse](feature_ps2_mouse.md)
45 45
   * [RGB Lighting](feature_rgblight.md)
46 46
   * [RGB Matrix](feature_rgb_matrix.md)
47
-  * [Space Cadet Shift](feature_space_cadet.md)
48
-  * [Space Cadet Shift Enter](feature_space_shift_cadet.md)
47
+  * [Space Cadet Shift](feature_space_cadet_shift.md)
48
+  * [Space Cadet Shift Enter](feature_space_cadet_shift_enter.md)
49 49
   * [Stenography](feature_stenography.md)
50 50
   * [Swap Hands](feature_swap_hands.md)
51 51
   * [Tap Dance](feature_tap_dance.md)

+ 0
- 24
docs/feature_space_cadet.md View File

@@ -1,24 +0,0 @@
1
-## Space Cadet Shift: The Future, Built In
2
-
3
-Steve Losh [described](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) the Space Cadet Shift quite well. Essentially, you hit the left Shift on its own, and you get an opening parenthesis; hit the right Shift on its own, and you get the closing one. When hit with other keys, the Shift key keeps working as it always does. Yes, it's as cool as it sounds.
4
-
5
-To use it, use `KC_LSPO` (Left Shift, Parenthesis Open) for your left Shift on your keymap, and `KC_RSPC` (Right Shift, Parenthesis Close) for your right Shift.
6
-
7
-It's defaulted to work on US keyboards, but if your layout uses different keys for parenthesis, you can define those in your `config.h` like this:
8
-
9
-    #define LSPO_KEY KC_9
10
-    #define RSPC_KEY KC_0
11
-
12
-You can also choose between different rollover behaviors of the shift keys by defining:
13
-
14
-    #define DISABLE_SPACE_CADET_ROLLOVER
15
-
16
-in your `config.h`. Disabling rollover allows you to use the opposite shift key to cancel the space cadet state in the event of an erroneous press instead of emitting a pair of parentheses when the keys are released.
17
-
18
-The only other thing you're going to want to do is create a `Makefile` in your keymap directory and set the following:
19
-
20
-```
21
-COMMAND_ENABLE   = no  # Commands for debug and configuration
22
-```
23
-
24
-This is just to keep the keyboard from going into command mode when you hold both Shift keys at the same time.

+ 33
- 0
docs/feature_space_cadet_shift.md View File

@@ -0,0 +1,33 @@
1
+# Space Cadet Shift: The Future, Built In
2
+
3
+Steve Losh described the [Space Cadet Shift](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) quite well. Essentially, when you tap Left Shift on its own, you get an opening parenthesis; tap Right Shift on its own and you get the closing one. When held, the Shift keys function as normal. Yes, it's as cool as it sounds.
4
+
5
+## Usage
6
+
7
+Replace the Left Shift key in your keymap with `KC_LSPO` (Left Shift, Parenthesis Open), and Right Shift with `KC_RSPC` (Right Shift, Parenthesis Close).
8
+
9
+## Keycodes
10
+
11
+|Keycode  |Description                           |
12
+|---------|--------------------------------------|
13
+|`KC_LSPO`|Left Shift when held, `(` when tapped |
14
+|`KC_RSPC`|Right Shift when held, `)` when tapped|
15
+
16
+## Caveats
17
+
18
+Space Cadet's functionality can conflict with the default Command functionality when both Shift keys are held at the same time. Make sure that Command is disabled in your `rules.mk` with:
19
+
20
+```make
21
+COMMAND_ENABLE = no
22
+```
23
+
24
+## Configuration
25
+
26
+By default Space Cadet assumes a US ANSI layout, but if your layout uses different keys for parentheses, you can redefine them in your `config.h`.
27
+You can also disable the rollover, allowing you to use the opposite Shift key to cancel the Space Cadet state in the event of an erroneous press, instead of emitting a pair of parentheses when the keys are released.
28
+
29
+|Define                        |Default      |Description                                                 |
30
+|------------------------------|-------------|------------------------------------------------------------|
31
+|`LSPO_KEY`                    |`KC_9`       |The keycode to send when Left Shift is tapped               |
32
+|`RSPC_KEY`                    |`KC_0`       |The keycode to send when Right Shift is tapped              |
33
+|`DISABLE_SPACE_CADET_ROLLOVER`|*Not defined*|If defined, use the opposite Shift key to cancel Space Cadet|

+ 31
- 0
docs/feature_space_cadet_shift_enter.md View File

@@ -0,0 +1,31 @@
1
+# Space Cadet Shift Enter
2
+
3
+Based on the [Space Cadet Shift](feature_space_cadet_shift.md) feature. Tap the Shift key on its own, and it behaves like Enter. When held, the Shift functions as normal.
4
+
5
+## Usage
6
+
7
+Replace any Shift key in your keymap with `KC_SFTENT` (Shift, Enter), and you're done.
8
+
9
+## Keycodes
10
+
11
+|Keycode    |Description                             |
12
+|-----------|----------------------------------------|
13
+|`KC_SFTENT`|Right Shift when held, Enter when tapped|
14
+
15
+## Caveats
16
+
17
+As with Space Cadet Shift, this feature may conflict with Command, so it should be disabled in your `rules.mk` with:
18
+
19
+```make
20
+COMMAND_ENABLE = no
21
+```
22
+
23
+This feature also uses the same timers as Space Cadet Shift, so using them in tandem may produce strange results.
24
+
25
+## Configuration
26
+
27
+By default Space Cadet assumes a US ANSI layout, but if you'd like to use a different key for Enter, you can redefine it in your `config.h`:
28
+
29
+|Define      |Default |Description                                     |
30
+|------------|--------|------------------------------------------------|
31
+|`SFTENT_KEY`|`KC_ENT`|The keycode to send when the Shift key is tapped|

+ 0
- 26
docs/feature_space_shift_cadet.md View File

@@ -1,26 +0,0 @@
1
-## Space Cadet Shift Enter: The future, built in
2
-
3
-Based on the Space Cadet Shift by Steve Losh [described](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) 
4
-Essentially, you hit the Shift on its own, and it acts as the enter key. When hit with other keys, the Shift key keeps working as it always does. Yes, it's as cool as it sounds. This solution works better than using a macro since the timers defined in quantum allow us to tell when another key is pressed, rather than just having a janky timer than results in accidental endlines. 
5
-
6
-To use it, use `KC_SFTENT` (Shift, Enter) for any Shift on your keymap.
7
-
8
-It's defaulted to work on US keyboards, but if you'd like to use a different key for Enter, you can define those in your `config.h` like this:
9
-
10
-    #define SFTENT_KEY KC_ENT
11
-
12
-
13
-The only other thing you're going to want to do is create a `rules.mk` in your keymap directory and set the following:
14
-
15
-```
16
-COMMAND_ENABLE   = no  # Commands for debug and configuration
17
-```
18
-
19
-This is just to keep the keyboard from going into command mode when you hold both Shift keys at the same time.
20
-
21
-
22
-
23
-
24
-
25
-PLEASE NOTE: this feature uses the same timers as the Space Cadet Shift feature, so using them in tandem may produce unwanted results. 
26
-

+ 1
- 1
docs/features.md View File

@@ -19,7 +19,7 @@ QMK has a staggering number of features for building your keyboard. It can take
19 19
 * [PS2 Mouse](feature_ps2_mouse.md) - Driver for connecting a PS/2 mouse directly to your keyboard.
20 20
 * [RGB Light](feature_rgblight.md) - RGB lighting for your keyboard.
21 21
 * [RGB Matrix](feature_rgb_matrix.md) - RGB Matrix lights for per key lighting.
22
-* [Space Cadet](feature_space_cadet.md) - Use your left/right shift keys to type parenthesis and brackets.
22
+* [Space Cadet](feature_space_cadet_shift.md) - Use your left/right shift keys to type parenthesis and brackets.
23 23
 * [Stenography](feature_stenography.md) - Put your keyboard into Plover mode for stenography use.
24 24
 * [Swap Hands](feature_swap_hands.md) - Mirror your keyboard for one handed usage.
25 25
 * [Tap Dance](feature_tap_dance.md) - Make a single key do as many things as you want.

+ 1
- 1
docs/redirects.json View File

@@ -34,7 +34,7 @@
34 34
             },
35 35
             {
36 36
                 "from": "space_cadet_shift.html",
37
-                "to": "feature_space_cadet.html"
37
+                "to": "feature_space_cadet_shift.html"
38 38
             },
39 39
             {
40 40
                 "from": "tap_dance.html",

+ 1
- 1
docs/reference_glossary.md View File

@@ -133,7 +133,7 @@ A 1 byte number that is sent as part of a HID report over USB that represents a
133 133
 ## Space Cadet Shift
134 134
 A special set of shift keys which allow you to type various types of braces by tapping the left or right shift one or more times.
135 135
 
136
-* [Space Cadet Shift Documentation](feature_space_cadet.md)
136
+* [Space Cadet Shift Documentation](feature_space_cadet_shift.md)
137 137
 
138 138
 ## Tap
139 139
 Pressing and releasing a key. In some situations you will need to distinguish between a key down and a key up event, and Tap always refers to both at once.

Loading…
Cancel
Save