Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move description of host_language from Macros to Language-specific Keycodes #24584

Merged
merged 10 commits into from
Nov 15, 2024
Merged

docs: move description of host_language from Macros to Language-specific Keycodes #24584

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
910599f
docs: mention host_language in Language-specific Keycodes
tenstad Nov 10, 2024
bbe17cf
docs: move language example from macros over to host language page
tenstad Nov 10, 2024
53c4a0b
docs: fix hyphen
tenstad Nov 11, 2024
a41bb6f
docs: improve host_language example
tenstad Nov 11, 2024
236cab5
docS: include keymap.c example
tenstad Nov 11, 2024
762d343
docs: use SE_ARNG (a with ring over) in code example as well
tenstad Nov 11, 2024
af42fed
docs: fix md ref
tenstad Nov 13, 2024
8fde302
docs: fix c example include
tenstad Nov 13, 2024
e6ecf19
docs: focus example on relevant host_language line
tenstad Nov 13, 2024
42ab287
docs: QMK_KEYBOARD_H
tenstad Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docS: include keymap.c example
  • Loading branch information
@tenstad
tenstad committed Nov 11, 2024
commit 236cab55bc9ab5ece6cf0e1a0a9951896a7a9d94
6 changes: 5 additions & 1 deletion docs/reference_keymap_extras.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ Obviously, this can get confusing, so QMK provides language-specific keycode ali

## Selecting Your Host Keyboard Layout

To select a host keyboard layout, simply `#include` one of the [keycode headers](#header-files) below at the top of your `keymap.c`.
To select a host keyboard layout, simply `#include` one of the [keycode headers](#header-files) below at the top of your `keymap.c`. Example:

```c
#include keymap_japanese.h
tenstad marked this conversation as resolved.
Show resolved Hide resolved
```

Alternatively, if using `keymap.json`, add the `host_language` key as shown in the following example. The available languages are those with a _Sendstring LUT Header_ entry in one of the [Header Files](#header-files) tables.

Expand Down