Helix-serial.c configuration improvement (#4370)

[qmk_firmware.git] / docs / feature_tap_dance.md

diff --git a/docs/feature_tap_dance.md b/docs/feature_tap_dance.md
index 99298fbda83bb66ee14ab5217ef6fd3bd0f290cd..b2b567f1d07dfc70b2044d755d95030f3c1e07fa 100644 (file)
--- a/docs/feature_tap_dance.md
+++ b/docs/feature_tap_dance.md
@@ -26,6 +26,8 @@ This array specifies what actions shall be taken when a tap-dance key is in acti
 
 The first option is enough for a lot of cases, that just want dual roles. For example, `ACTION_TAP_DANCE_DOUBLE(KC_SPC, KC_ENT)` will result in `Space` being sent on single-tap, `Enter` otherwise.
 
 
 The first option is enough for a lot of cases, that just want dual roles. For example, `ACTION_TAP_DANCE_DOUBLE(KC_SPC, KC_ENT)` will result in `Space` being sent on single-tap, `Enter` otherwise.
 

+!> Keep in mind that only [basic keycodes](keycodes_basic.md) are supported here. Custom keycodes are not supported.
+

 And that's the bulk of it!
 
 And now, on to the explanation of how it works!
 And that's the bulk of it!
 
 And now, on to the explanation of how it works!


@@ -196,22 +198,20 @@ SRC += your_name.c
 Pretty simple. It is a nice way to keep some rules common on all your keymaps.
 
 
 Pretty simple. It is a nice way to keep some rules common on all your keymaps.
 
 

-### In `/qmk_firmware/users/<your_name>/<you_name>.h`
+### In `/qmk_firmware/users/<your_name>/<your_name>.h`

 
 You will need a few things in this file:
 
 ```c
 
 You will need a few things in this file:
 
 ```c

-#ifndef YOUR_NAME
-#define YOUR_NAME
+#pragma once

 
 #include "quantum.h"
 #include "process_keycode/process_tap_dance.h"
 
 
 #include "quantum.h"
 #include "process_keycode/process_tap_dance.h"
 

-

 typedef struct {
   bool is_press_action;
   int state;
 typedef struct {
   bool is_press_action;
   int state;

-} xtap;
+} tap;

 
 enum {
   SINGLE_TAP = 1,
 
 enum {
   SINGLE_TAP = 1,


@@ -225,9 +225,9 @@ enum {
 
 //Tap dance enums
 enum {
 
 //Tap dance enums
 enum {

-    CTL_X = 0,
-    SOME_OTHER_DANCE
-}
+  X_CTL = 0,
+  SOME_OTHER_DANCE
+};

 
 int cur_dance (qk_tap_dance_state_t *state);
 
 
 int cur_dance (qk_tap_dance_state_t *state);
 


@@ -241,7 +241,7 @@ void x_reset (qk_tap_dance_state_t *state, void *user_data);
 And then in your user's `.c` file you implement the functions above:
 
 ```c
 And then in your user's `.c` file you implement the functions above:
 
 ```c

-#include "gordon.h"
+#include "<your_name>.h"

 #include "quantum.h"
 #include "action.h"
 #include "process_keycode/process_tap_dance.h"
 #include "quantum.h"
 #include "action.h"
 #include "process_keycode/process_tap_dance.h"


@@ -335,4 +335,4 @@ qk_tap_dance_action_t tap_dance_actions[] = {
 };
 ```
 
 };
 ```
 

-And then simply use TD(X_CTL) anywhere in your keymap.
+And then simply use `TD(X_CTL)` anywhere in your keymap after including `<your_name>.h`.