gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-04 00:45:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docusaurus' of github.com:qmk/qmk_firmware into docusaurus

Browse Source
This commit is contained in:
Jack Humbert 2023-05-02 18:44:10 -04:00
commit 711e8b968b
154 changed files with 3513 additions and 505 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/docs.yml vendored
View File

@ -26,7 +26,7 @@ jobs:
- uses: actions/checkout@v3
with:
fetch-depth: 1
- uses: actions/setup-node@v3
with:
node-version: 16
@ -35,7 +35,6 @@ jobs:
- name: Install dependencies
run: |
apt-get update && apt-get install -y rsync nodejs npm doxygen
npm install -g moxygen
- name: Build doxygen docs
run: |

0
docs/.gitignore → builddefs/docs/.gitignore vendored
View File

0
docs/babel.config.js → builddefs/docs/babel.config.js
View File

11
docs/docusaurus.config.js → builddefs/docs/docusaurus.config.js
View File

@ -27,13 +27,22 @@ const config = {
customCss: require.resolve("./src/css/custom.css"),
}
],
[
require.resolve("@easyops-cn/docusaurus-search-local"),
{
indexBlog: false,
docsRouteBasePath: '/',
searchResultLimits: 12,
searchBarShortcut: false,
},
],
],
plugins: [
[
"@docusaurus/plugin-content-docs",
{
sidebarPath: require.resolve("./sidebars.js"),
path: ".",
path: "../../docs",
routeBasePath: "/",
exclude: [
"node_modules",

291
docs/package-lock.json → builddefs/docs/package-lock.json generated
View File

@ -11,6 +11,7 @@
"@docusaurus/core": "2.4.0",
"@docusaurus/plugin-client-redirects": "^2.4.0",
"@docusaurus/preset-classic": "2.4.0",
"@easyops-cn/docusaurus-search-local": "^0.35.0",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
@ -2625,6 +2626,46 @@
"node": ">=16.14"
}
},
"node_modules/@easyops-cn/autocomplete.js": {
"version": "0.38.1",
"resolved": "https://registry.npmjs.org/@easyops-cn/autocomplete.js/-/autocomplete.js-0.38.1.tgz",
"integrity": "sha512-drg76jS6syilOUmVNkyo1c7ZEBPcPuK+aJA7AksM5ZIIbV57DMHCywiCr+uHyv8BE5jUTU98j/H7gVrkHrWW3Q==",
"dependencies": {
"cssesc": "^3.0.0",
"immediate": "^3.2.3"
}
},
"node_modules/@easyops-cn/docusaurus-search-local": {
"version": "0.35.0",
"resolved": "https://registry.npmjs.org/@easyops-cn/docusaurus-search-local/-/docusaurus-search-local-0.35.0.tgz",
"integrity": "sha512-sHQ8jxsVgHH8MNXJlj20nZZfP/Q0peNTAJwKCN2aPuBwfRIoO0i7LmZFaYKenZmVAW/BD2MtfVd65SREmm3zxg==",
"dependencies": {
"@docusaurus/plugin-content-docs": "^2.0.0-rc.1",
"@docusaurus/theme-translations": "^2.0.0-rc.1",
"@docusaurus/utils": "^2.0.0-rc.1",
"@docusaurus/utils-common": "^2.0.0-rc.1",
"@docusaurus/utils-validation": "^2.0.0-rc.1",
"@easyops-cn/autocomplete.js": "^0.38.1",
"@node-rs/jieba": "^1.6.0",
"cheerio": "^1.0.0-rc.3",
"clsx": "^1.1.1",
"debug": "^4.2.0",
"fs-extra": "^10.0.0",
"klaw-sync": "^6.0.0",
"lunr": "^2.3.9",
"lunr-languages": "^1.4.0",
"mark.js": "^8.11.1",
"tslib": "^2.4.0"
},
"engines": {
"node": ">=12"
},
"peerDependencies": {
"@docusaurus/theme-common": "^2.0.0-rc.1",
"react": "^16.14.0 || ^17.0.0 || ^18.0.0",
"react-dom": "^16.14.0 || ^17.0.0 || ^18.0.0"
}
},
"node_modules/@hapi/hoek": {
"version": "9.3.0",
"resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz",
@ -2852,6 +2893,228 @@
"url": "https://opencollective.com/unified"
}
},
"node_modules/@node-rs/jieba": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba/-/jieba-1.7.0.tgz",
"integrity": "sha512-Hm1JIlejxkWe1FSFZRns/g1j5hZmp357n+0n2BluABA4KLZ8EraHfPmPRmVMW6vbdMZObTYIVu5aVrPnUfBOxg==",
"engines": {
"node": ">= 10"
},
"funding": {
"type": "github",
"url": "https://github.com/sponsors/Brooooooklyn"
},
"optionalDependencies": {
"@node-rs/jieba-android-arm-eabi": "1.7.0",
"@node-rs/jieba-android-arm64": "1.7.0",
"@node-rs/jieba-darwin-arm64": "1.7.0",
"@node-rs/jieba-darwin-x64": "1.7.0",
"@node-rs/jieba-freebsd-x64": "1.7.0",
"@node-rs/jieba-linux-arm-gnueabihf": "1.7.0",
"@node-rs/jieba-linux-arm64-gnu": "1.7.0",
"@node-rs/jieba-linux-arm64-musl": "1.7.0",
"@node-rs/jieba-linux-x64-gnu": "1.7.0",
"@node-rs/jieba-linux-x64-musl": "1.7.0",
"@node-rs/jieba-win32-arm64-msvc": "1.7.0",
"@node-rs/jieba-win32-ia32-msvc": "1.7.0",
"@node-rs/jieba-win32-x64-msvc": "1.7.0"
}
},
"node_modules/@node-rs/jieba-android-arm-eabi": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm-eabi/-/jieba-android-arm-eabi-1.7.0.tgz",
"integrity": "sha512-XF4OYcZCyDiBK+jm1Zmt2o+xEO7K2K5OvUC3MTc9jd3Lwvy3EdHp8tpGvEp8PxfVFe2/JxNzX4OQQQP3Dhmk9A==",
"cpu": [
"arm"
],
"optional": true,
"os": [
"android"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-android-arm64": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-android-arm64/-/jieba-android-arm64-1.7.0.tgz",
"integrity": "sha512-9oWwFVr/37T89WC+jjiI9A6u0zUJNTJl5ZC4CMxX45MVMokWI7bBXU7t7qBmMdFBzj+OFwDd3sm1fh4vl7NSWA==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"android"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-darwin-arm64": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-arm64/-/jieba-darwin-arm64-1.7.0.tgz",
"integrity": "sha512-9gBuxJCNITNI/gU5l8eeVGQ9MAf0BV86lfeo9TeU61vJCy6sqyx26wFMLODQgLNdiMP+q/fZme/G0hfZUjfPVA==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"darwin"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-darwin-x64": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-darwin-x64/-/jieba-darwin-x64-1.7.0.tgz",
"integrity": "sha512-FFUSMY4tl0Prpxa1SHy7Yzze2KfV/bZzccpO5nd+a8zCKbiX6gVkJ89FfxSAD2QrXUGkZvJYiPmu5nkZItqRZQ==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"darwin"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-freebsd-x64": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-freebsd-x64/-/jieba-freebsd-x64-1.7.0.tgz",
"integrity": "sha512-QFz2pz0Br+621QbKkgQPqTn90j1kcCD9jaI++qTLNHJGlWLRn6sFoAjb+jQEQEy9aE7VqfIV56eaVcCoU5VO2w==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"freebsd"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-linux-arm-gnueabihf": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm-gnueabihf/-/jieba-linux-arm-gnueabihf-1.7.0.tgz",
"integrity": "sha512-kHJxO2sd7gMKqI1YS5DjABEcRwRemaCtgbKSuUqEaHGmUz9nAaUF6FSY8U4rXwr7HXt+kQa4NgyYDjgz+Pscrw==",
"cpu": [
"arm"
],
"optional": true,
"os": [
"linux"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-linux-arm64-gnu": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-gnu/-/jieba-linux-arm64-gnu-1.7.0.tgz",
"integrity": "sha512-3qoCV9pF6llPBGDMu7K8JdHjI10WPkrq6P2gpZESqekcE4DatV6DcU9FWR+QL7MK/7meoE3/Zhjm7OK+qBd8gg==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"linux"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-linux-arm64-musl": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-arm64-musl/-/jieba-linux-arm64-musl-1.7.0.tgz",
"integrity": "sha512-xv6hvzOV7iTCq7mM8SWhC3zEk6CqmBwhOSlfbb3gvPkc4U1UA1hmvcrD7oO5Qn+U+nuswysGCdVU6Z5AypLDfg==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"linux"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-linux-x64-gnu": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-gnu/-/jieba-linux-x64-gnu-1.7.0.tgz",
"integrity": "sha512-NpelWidMSNLoFTw+ov3y5jhJZjapHwEnh0Fyfm/7mvqkdwzVyedqNj22etRGum+nsAosMotCUWUznIMAD075gQ==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"linux"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-linux-x64-musl": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-linux-x64-musl/-/jieba-linux-x64-musl-1.7.0.tgz",
"integrity": "sha512-yG4F8sy+fW4RbhyKXmEMT/JGuQuKH0TGymCEGYgT0km2I60iys63jWf2VTzCtrx583wxN5XoHv5HN60nhtIBtw==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"linux"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-win32-arm64-msvc": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-arm64-msvc/-/jieba-win32-arm64-msvc-1.7.0.tgz",
"integrity": "sha512-R6l/BSMs6R6BwpZS6DIDZuAEjUIPdAHgyi+xptP3mICjm6U+GMsvsRTeZkIJ7a/yzYUfqvz54VpQsfE5f0psBQ==",
"cpu": [
"arm64"
],
"optional": true,
"os": [
"win32"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-win32-ia32-msvc": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-ia32-msvc/-/jieba-win32-ia32-msvc-1.7.0.tgz",
"integrity": "sha512-FwibbuizEjzom02K2JM2T8tL0VlxW5xGDDy3L3dgx46xIGE85PwGYjgju+eDt4UODgxDsxGC4DUMMZf3XvCc7A==",
"cpu": [
"ia32"
],
"optional": true,
"os": [
"win32"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@node-rs/jieba-win32-x64-msvc": {
"version": "1.7.0",
"resolved": "https://registry.npmjs.org/@node-rs/jieba-win32-x64-msvc/-/jieba-win32-x64-msvc-1.7.0.tgz",
"integrity": "sha512-pJv7nluB6azhsOWvJB86Dyfg/M7n9k49bs9Bwmsylz9uhdZX9QnEShDW934RdmnjPYQ5aPgsSFrY6NXP/aovUA==",
"cpu": [
"x64"
],
"optional": true,
"os": [
"win32"
],
"engines": {
"node": ">= 10"
}
},
"node_modules/@nodelib/fs.scandir": {
"version": "2.1.5",
"resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
@ -7045,6 +7308,11 @@
"node": ">=14.0.0"
}
},
"node_modules/immediate": {
"version": "3.3.0",
"resolved": "https://registry.npmjs.org/immediate/-/immediate-3.3.0.tgz",
"integrity": "sha512-HR7EVodfFUdQCTIeySw+WDRFJlPcLOJbXfwwZ7Oom6tjsvZ3bOkCDJHehQC3nxJrv7+f9XecwazynjU8e4Vw3Q=="
},
"node_modules/immer": {
"version": "9.0.21",
"resolved": "https://registry.npmjs.org/immer/-/immer-9.0.21.tgz",
@ -7600,6 +7868,14 @@
"node": ">=0.10.0"
}
},
"node_modules/klaw-sync": {
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz",
"integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==",
"dependencies": {
"graceful-fs": "^4.1.11"
}
},
"node_modules/kleur": {
"version": "3.0.3",
"resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
@ -7754,6 +8030,16 @@
"yallist": "^3.0.2"
}
},
"node_modules/lunr": {
"version": "2.3.9",
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
"integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow=="
},
"node_modules/lunr-languages": {
"version": "1.11.0",
"resolved": "https://registry.npmjs.org/lunr-languages/-/lunr-languages-1.11.0.tgz",
"integrity": "sha512-V9cvFv3bWKWSb7ucbg9QeNpOiuhglR9F9KipjE8CpVXgqLIwgLrskNNtj2ock7AAcVcSZiFVXeTfgVKCGBf1jg=="
},
"node_modules/make-dir": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz",
@ -7782,6 +8068,11 @@
"integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
"peer": true
},
"node_modules/mark.js": {
"version": "8.11.1",
"resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz",
"integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ=="
},
"node_modules/markdown-escapes": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/markdown-escapes/-/markdown-escapes-1.0.4.tgz",

5
docs/package.json → builddefs/docs/package.json
View File

@ -4,12 +4,12 @@
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"start": "docusaurus start --host 0.0.0.0 --port 8936",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"serve": "docusaurus serve --host 0.0.0.0 --port 8936",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
},
@ -17,6 +17,7 @@
"@docusaurus/core": "2.4.0",
"@docusaurus/plugin-client-redirects": "^2.4.0",
"@docusaurus/preset-classic": "2.4.0",
"@easyops-cn/docusaurus-search-local": "^0.35.0",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",

6
docs/sidebars.js → builddefs/docs/sidebars.js
View File

@ -251,9 +251,9 @@ const sidebars = {
type: 'category',
label: "Past Breaking Changes",
link: {
type: 'generated-index',
title: 'Past Breaking Changes',
slug: '/breaking_changes/all',
type: 'generated-index',
title: 'Past Breaking Changes',
slug: '/breaking_changes/all',
},
items: [
{

0
docs/src/components/DocsifyForwarder.js → builddefs/docs/src/components/DocsifyForwarder.js
View File

0
docs/src/css/custom.css → builddefs/docs/src/css/custom.css
View File

0
docs/src/pages/index.module.css → builddefs/docs/src/pages/index.module.css
View File

0
docs/static/.nojekyll → builddefs/docs/static/.nojekyll vendored
View File

0
docs/static/CNAME → builddefs/docs/static/CNAME vendored
View File

0
docs/static/img/favicon.ico → builddefs/docs/static/img/favicon.ico vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

0
docs/static/img/favicon.png → builddefs/docs/static/img/favicon.png vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 793 B

After

Width:  |  Height:  |  Size: 793 B

0
docs/static/img/qmk-new-dark.svg → builddefs/docs/static/img/qmk-new-dark.svg vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

0
docs/static/img/qmk-new-light.svg → builddefs/docs/static/img/qmk-new-light.svg vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

0
docs/static/img/qmk-social-card.jpg → builddefs/docs/static/img/qmk-social-card.jpg vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

18
docs/ChangeLog/20200829.md
View File

@ -3,9 +3,9 @@
Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Relocated Keyboards :id=relocated-keyboards
### Relocated Keyboards {#relocated-keyboards}
#### The Key Company project consolidation ([#9547](https://github.com/qmk/qmk_firmware/pull/9547))
#### relocating boards by flehrad to flehrad/ folder ([#9635](https://github.com/qmk/qmk_firmware/pull/9635))
@ -24,7 +24,7 @@ handwired/numbrero | flehrad/numbrero
snagpad | flehrad/snagpad
handwired/tradestation | flehrad/tradestation
### Updated Keyboard Codebases :id=keyboard-updates
### Updated Keyboard Codebases {#keyboard-updates}
#### Keebio RGB wiring update ([#7754](https://github.com/qmk/qmk_firmware/pull/7754))
@ -46,7 +46,7 @@ This change affects:
* Quefrency rev1
* Viterbi, revs. 1 and 2
### Changes to Core Functionality :id=core-updates
### Changes to Core Functionality {#core-updates}
* Bigger Combo index ([#9318](https://github.com/qmk/qmk_firmware/pull/9318))
@ -58,14 +58,14 @@ Any fork that uses `process_combo_event` needs to update the function's first ar
* New function: `void process_combo_event(uint16_t combo_index, bool pressed)`
## Core Changes :id=core-changes
## Core Changes {#core-changes}
### Fixes :id=core-fixes
### Fixes {#core-fixes}
* Mousekeys: scrolling acceleration is no longer coupled to mouse movement acceleration ([#9174](https://github.com/qmk/qmk_firmware/pull/9174))
* Keymap Extras: correctly assign Question Mark in Czech layout ([#9987](https://github.com/qmk/qmk_firmware/pull/9987))
### Additions and Enhancements :id=core-additions
### Additions and Enhancements {#core-additions}
* allow for WS2812 PWM to work on DMAMUX-capable devices ([#9471](https://github.com/qmk/qmk_firmware/pull/9471))
* Newer STM32 MCUs have a DMAMUX peripheral, which allows mapping of DMAs to different DMA streams, rather than hard-defining the target streams in silicon.
@ -109,7 +109,7 @@ Any fork that uses `process_combo_event` needs to update the function's first ar
* The K-Type has been refactored to use QMK's native matrix scanning routine, and now has partial support for the RGB Matrix feature.
* Joysticks can now be used without defining analog pins ([#10169](https://github.com/qmk/qmk_firmware/pull/10169))
### Clean-ups and Optimizations :id=core-optimizations
### Clean-ups and Optimizations {#core-optimizations}
* iWRAP protocol removed ([#9284](https://github.com/qmk/qmk_firmware/pull/9284))
* work begun for consolidation of ChibiOS platform files ([#8327](https://github.com/qmk/qmk_firmware/pull/8327) and [#9315](https://github.com/qmk/qmk_firmware/pull/9315))
@ -140,7 +140,7 @@ Any fork that uses `process_combo_event` needs to update the function's first ar
* remove support for Adafruit EZ Key Bluetooth controller ([#10103](https://github.com/qmk/qmk_firmware/pull/10103))
## QMK Infrastructure and Internals :id=qmk-internals
## QMK Infrastructure and Internals {#qmk-internals}
* Attempt to fix CI for non-master branches. ([#9308](https://github.com/qmk/qmk_firmware/pull/9308))
* Actually fetch the branch we're attempting to compare against.

16
docs/ChangeLog/20201128.md
View File

@ -3,9 +3,9 @@
Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Relocated Keyboards :id=relocated-keyboards
### Relocated Keyboards {#relocated-keyboards}
#### Reduce Helix keyboard build variation ([#8669](https://github.com/qmk/qmk_firmware/pull/8669))
@ -88,21 +88,21 @@ The Valor and Dawn60 keyboards by Xelus22 both now require their revisions to be
| xelus/valor | xelus/valor/rev1 |
### Updated Keyboard Codebases :id=keyboard-updates
### Updated Keyboard Codebases {#keyboard-updates}
#### AEboards EXT65 Refactor ([#10820](https://github.com/qmk/qmk_firmware/pull/10820))
The EXT65 codebase has been reworked so keymaps can be used with either revision.
## Core Changes :id=core-changes
## Core Changes {#core-changes}
### Fixes :id=core-fixes
### Fixes {#core-fixes}
* Reconnect the USB if users wake up a computer from the keyboard to restore the USB state ([#10088](https://github.com/qmk/qmk_firmware/pull/10088))
* Fix cursor position bug in oled_write_raw functions ([#10800](https://github.com/qmk/qmk_firmware/pull/10800))
### Additions and Enhancements :id=core-additions
### Additions and Enhancements {#core-additions}
* Allow MATRIX_ROWS to be greater than 32 ([#10183](https://github.com/qmk/qmk_firmware/pull/10183))
* Add support for soft serial to ATmega32U2 ([#10204](https://github.com/qmk/qmk_firmware/pull/10204))
@ -119,7 +119,7 @@ The EXT65 codebase has been reworked so keymaps can be used with either revision
* Add AT90USB support for serial.c ([#10706](https://github.com/qmk/qmk_firmware/pull/10706))
* Auto shift: support repeats and early registration (#9826)
### Clean-ups and Optimizations :id=core-optimizations
### Clean-ups and Optimizations {#core-optimizations}
* Haptic and solenoid cleanup ([#9700](https://github.com/qmk/qmk_firmware/pull/9700))
* XD75 cleanup ([#10524](https://github.com/qmk/qmk_firmware/pull/10524))
@ -129,7 +129,7 @@ The EXT65 codebase has been reworked so keymaps can be used with either revision
* Remove references to HD44780 ([#10735](https://github.com/qmk/qmk_firmware/pull/10735))
## QMK Infrastructure and Internals :id=qmk-internals
## QMK Infrastructure and Internals {#qmk-internals}
* Add ability to build a subset of all keyboards based on platform. ([#10420](https://github.com/qmk/qmk_firmware/pull/10420))
* Initialise EEPROM drivers at startup, instead of upon first execution ([#10438](https://github.com/qmk/qmk_firmware/pull/10438))

32
docs/ChangeLog/20210529.md
View File

@ -1,30 +1,30 @@
# QMK Breaking Changes - 2021 May 29 Changelog
## Notable Changes :id=notable-changes
## Notable Changes {#notable-changes}
### RGB Matrix support for split common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) :id=rgb-matrix-split-common
### RGB Matrix support for split common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) {#rgb-matrix-split-common}
Split boards can now use RGB Matrix without defining a custom matrix.
### Teensy 3.6 support ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) :id=teensy-3-6-support
### Teensy 3.6 support ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) {#teensy-3-6-support}
Added support for MK66F18 (Teensy 3.6) microcontroller.
### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) :id=new-command-qmk-console
### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) {#new-command-qmk-console}
A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages.
### Improved command: qmk config :id=improve-command-qmk-config
### Improved command: qmk config {#improve-command-qmk-config}
We've updated the `qmk config` command to show only the configuration items you have actually set. You can now display (almost) all of the available configuration options, along with their default values, using `qmk config -a`.
### LED Matrix Improvements ([#12509](https://github.com/qmk/qmk_firmware/pull/12509), [#12580](https://github.com/qmk/qmk_firmware/pull/12580), [#12588](https://github.com/qmk/qmk_firmware/pull/12588), [#12633](https://github.com/qmk/qmk_firmware/pull/12633), [#12651](https://github.com/qmk/qmk_firmware/pull/12651), [#12685](https://github.com/qmk/qmk_firmware/pull/12685)) :id=led-matrix-improvements
### LED Matrix Improvements ([#12509](https://github.com/qmk/qmk_firmware/pull/12509), [#12580](https://github.com/qmk/qmk_firmware/pull/12580), [#12588](https://github.com/qmk/qmk_firmware/pull/12588), [#12633](https://github.com/qmk/qmk_firmware/pull/12633), [#12651](https://github.com/qmk/qmk_firmware/pull/12651), [#12685](https://github.com/qmk/qmk_firmware/pull/12685)) {#led-matrix-improvements}
LED Matrix has been improved with effects, CIE1931 curves, and a task system.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978))
* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613))
@ -52,7 +52,7 @@ The codebase for the [Durgod K320](https://github.com/qmk/qmk_firmware/tree/0.13
Additionally, the `crkbd/rev1/legacy` keyboard has been removed.
### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) :id=bootmagic-deprecation-and-refactor
### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) {#bootmagic-deprecation-and-refactor}
QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
@ -68,11 +68,11 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`:
- From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
- From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
### Removal of LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) :id=removal-of-layout-kc
### Removal of LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) {#removal-of-layout-kc}
We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro.
### Encoder callbacks are now boolean ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) :id=encoder-callback-boolean
### Encoder callbacks are now boolean ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) {#encoder-callback-boolean}
To allow for keyboards to override (or not) keymap level code the `encoder_update_kb` function has been changed from `void` to `bool`. You will need to update your function definition to reflect this and ensure that you return a `true` or `false` value.
@ -127,9 +127,9 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
}
```
## Core Changes :id=core-changes
## Core Changes {#core-changes}
### Fixes :id=core-fixes
### Fixes {#core-fixes}
* Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487))
* Terrazzo: Fix wrong LED Matrix function names ([#12561](https://github.com/qmk/qmk_firmware/pull/12561))
@ -147,7 +147,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
* [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977))
* Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864))
### Additions and Enhancements :id=core-additions
### Additions and Enhancements {#core-additions}
* ARM - Refactor SLEEP_LED to support more platforms ([#8403](https://github.com/qmk/qmk_firmware/pull/8403))
* Add ability to toggle One Shot functionality ([#4198](https://github.com/qmk/qmk_firmware/pull/4198))
@ -193,7 +193,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560), [#13024](https://github.com/qmk/qmk_firmware/pull/13024))
* Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014))
### Clean-ups and Optimizations :id=core-optimizations
### Clean-ups and Optimizations {#core-optimizations}
* Overhaul bootmagic logic to have single entrypoint ([#8532](https://github.com/qmk/qmk_firmware/pull/8532))
* Refactor of USB code within split_common ([#11890](https://github.com/qmk/qmk_firmware/pull/11890))
@ -218,7 +218,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
* Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602))
* [Keyboard] Remove redundant legacy and common headers for crkbd ([#13023](https://github.com/qmk/qmk_firmware/pull/13023))
### QMK Infrastructure and Internals :id=qmk-internals
### QMK Infrastructure and Internals {#qmk-internals}
* trivial change to trigger api update ([`b15288fb87`](https://github.com/qmk/qmk_firmware/commit/b15288fb87))
* fix some references to bin/qmk that slipped in ([#12832](https://github.com/qmk/qmk_firmware/pull/12832))

22
docs/ChangeLog/20210828.md
View File

@ -1,14 +1,14 @@
# QMK Breaking Changes - 2021 August 28 Changelog
## Notable Features :id=notable-features
## Notable Features {#notable-features}
### Combo processing improvements ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) :id=combo-processing-improvements
### Combo processing improvements ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) {#combo-processing-improvements}
Combo processing has been reordered with respect to keypress handling, allowing for much better compatibility with mod taps.
It is also now possible to define combos that have keys overlapping with other combos, triggering only one. For example, a combo of `A`, `B` can coexist with a longer combo of `A`, `B`, `C` -- previous functionality would trigger both combos if all three keys were pressed.
### Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) :id=key-overrides
### Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) {#key-overrides}
QMK now has a new feature: [key overrides](https://docs.qmk.fm/#/feature_key_overrides). This feature allows for overriding the output of key combinations involving modifiers. As an example, pressing <kbd>Shift+2</kbd> normally results in an <kbd>@</kbd> on US-ANSI keyboard layouts -- the new key overrides allow for adding similar functionality, but for any <kbd>modifier + key</kbd> press.
@ -20,9 +20,9 @@ There's far more to describe that what lives in this changelog, so head over to
QMK gained the ability to pretend to be a digitizer device -- much like a tablet device. A mouse uses delta-coordinates -- move up, move right -- but a digitizer works with absolute coordinates -- top left, bottom right.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -69,7 +69,7 @@ xd84pro | xiudi/xd84pro
xd87 | xiudi/xd87
xd96 | xiudi/xd96
### Bootmagic Full Removal ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) :id=bootmagic-full-removal
### Bootmagic Full Removal ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) {#bootmagic-full-removal}
As noted during last breaking changes cycle, QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
@ -85,7 +85,7 @@ This is the current roadmap for the behavior of `BOOTMAGIC_ENABLE`:
- (now) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
- (next) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
### DIP switch callbacks are now boolean ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) :id=dip-switch-boolean
### DIP switch callbacks are now boolean ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) {#dip-switch-boolean}
To match the encoder change last breaking changes cycle, DIP switch callbacks now return `bool`, too.
@ -149,9 +149,9 @@ bool dip_switch_update_mask_user(uint32_t state) {
}
```
## Notable core changes :id=notable-core
## Notable core changes {#notable-core}
### Split transport improvements :id=split-transport-improvements
### Split transport improvements {#split-transport-improvements}
Split keyboards gained a significant amount of improvements during this breaking changes cycle, specifically:
@ -166,7 +166,7 @@ If you're updating your split keyboard, you will need to flash both sides of the
:::
### Teensy 4.x support ([#13056](https://github.com/qmk/qmk_firmware/pull/13056), [#13076](https://github.com/qmk/qmk_firmware/pull/13076), [#13077](https://github.com/qmk/qmk_firmware/pull/13077)) :id=teensy-4-x-support
### Teensy 4.x support ([#13056](https://github.com/qmk/qmk_firmware/pull/13056), [#13076](https://github.com/qmk/qmk_firmware/pull/13076), [#13077](https://github.com/qmk/qmk_firmware/pull/13077)) {#teensy-4-x-support}
Updated ChibiOS and ChibiOS-Contrib, which brought in support for Teensy 4.x dev boards, running NXP i.MX1062.
@ -247,7 +247,7 @@ We've added dozens of new keys to `info.json` so that you can configure more tha
* `usb.force_nkro`, `usb.max_power`, `usb.no_startup_check`, `usb.polling_interval`, `usb.shared_endpoint.keyboard`, `usb.shared_endpoint.mouse`, `usb.suspend_wakeup_delay`, `usb.wait_for`
* `qmk.keys_per_scan`, `qmk.tap_keycode_delay`, `qmk.tap_capslock_delay`
### Codebase restructure and cleanup :id=codebase-restructure
### Codebase restructure and cleanup {#codebase-restructure}
QMK was originally based on TMK, and has grown in size considerably since its first inception. To keep moving things forward, restructure of some of the core areas of the code is needed to support new concepts and new hardware, and progress is happening along those lines:

34
docs/ChangeLog/20211127.md
View File

@ -1,6 +1,6 @@
# QMK Breaking Changes - 2021 November 27 Changelog
## 2000 keyboards! :id=qmk-2000th-keyboard
## 2000 keyboards! {#qmk-2000th-keyboard}
QMK had it's 2000th keyboard submitted during this breaking changes cycle.... and it only _just_ made the cut-off!
@ -11,9 +11,9 @@ QMK had it's 2000th keyboard submitted during this breaking changes cycle.... an
From the whole QMK team, a major thankyou to the community for embracing QMK as your preferred keyboard firmware!
## Notable Features :id=notable-features
## Notable Features {#notable-features}
### Expanded Pointing Device support ([#14343](https://github.com/qmk/qmk_firmware/pull/14343)) :id=expanded-pointing-device
### Expanded Pointing Device support ([#14343](https://github.com/qmk/qmk_firmware/pull/14343)) {#expanded-pointing-device}
Pointing device support has been reworked and reimplemented to allow for easier integration of new peripherals.
@ -33,7 +33,7 @@ QMK now has core-supplied support for the following pointing device peripherals:
See the new documentation for the [Pointing Device](../feature_pointing_device.md) feature for more information on specific configuration for each driver.
### Dynamic Tapping Term ([#11036](https://github.com/qmk/qmk_firmware/pull/11036)) :id=dynamic-tapping-term
### Dynamic Tapping Term ([#11036](https://github.com/qmk/qmk_firmware/pull/11036)) {#dynamic-tapping-term}
For people who are starting out with tapping keys, or for people who think tapping keys don't "feel right", it's sometimes quite difficult to determine what duration of tapping term to use to make things seem natural.
@ -47,7 +47,7 @@ If you're in this stage of discovery, you can now add `DYNAMIC_TAPPING_TERM_ENAB
Coupled with the use of `qmk console` or QMK Toolbox to show console output from your keyboard, you can tweak the tapping term dynamically in order to narrow down what "feels right" to you. Once you're happy, drop in the resulting number into your keymap's `config.h` and you're good to go!
### Macros in JSON keymaps ([#14374](https://github.com/qmk/qmk_firmware/pull/14374)) :id=macros-in-keymap-json
### Macros in JSON keymaps ([#14374](https://github.com/qmk/qmk_firmware/pull/14374)) {#macros-in-keymap-json}
You can now define up to 32 macros in your `keymap.json` file, as used by [QMK Configurator](newbs_building_firmware_configurator.md), and `qmk compile`. You can define these macros in a list under the `macros` keyword, like this:
@ -83,9 +83,9 @@ You can now define up to 32 macros in your `keymap.json` file, as used by [QMK C
In due course, [QMK Configurator](https://config.qmk.fm/) will pick up support for defining these in its UI, but for now the json is the only way to define macros.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -104,13 +104,13 @@ The following keyboards have had their source moved within QMK:
| signum/3_0/elitec | signum/3_0 |
| tgr/jane | tgr/jane/v2 |
### Squeezing space out of AVR ([#15243](https://github.com/qmk/qmk_firmware/pull/15243)) :id=squeezing-space-from-avr
### Squeezing space out of AVR ([#15243](https://github.com/qmk/qmk_firmware/pull/15243)) {#squeezing-space-from-avr}
The AVR platform has been problematic for some time, in the sense that it is severely resource-constrained -- this makes life difficult for anyone attempting to add new functionality such as display panels to their keymap code. The illustrious Drashna has contributed some newer documentation on how to attempt to free up some space on AVR-based keyboards that are in short supply.
Of course, there are much fewer constraints with ARM chips... ;)
### Require explicit enabling of RGB Matrix modes ([#15018](https://github.com/qmk/qmk_firmware/pull/15018)) :id=explicit-rgb-modes
### Require explicit enabling of RGB Matrix modes ([#15018](https://github.com/qmk/qmk_firmware/pull/15018)) {#explicit-rgb-modes}
Related to the previous section -- RGB Matrix modes have now been made to be opt-in, rather than opt-out. As these animations are now opt-in, you may find that your keyboard no longer has all the RGB modes you're expecting -- you may need to configure and recompile your firmware and enable your animations of choice... with any luck they'll still fit in the space available.
@ -118,7 +118,7 @@ Most keyboards keep their original functionality, but over time the QMK maintain
The full list of configurables to turn specific animations back on can be found at on the [RGB Matrix documentation](feature_rgb_matrix.md#rgb-matrix-effects) page.
### OLED task refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/14864)) :id=oled-task-refactor
### OLED task refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/14864)) {#oled-task-refactor}
OLED display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done.
@ -152,7 +152,7 @@ bool oled_task_kb(void) {
}
```
### Bootmagic Full Removal ([#15002](https://github.com/qmk/qmk_firmware/pull/15002)) :id=bootmagic-full-removal
### Bootmagic Full Removal ([#15002](https://github.com/qmk/qmk_firmware/pull/15002)) {#bootmagic-full-removal}
As noted during previous breaking changes cycles, QMK decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
@ -170,13 +170,13 @@ This is the historical timeline for the behavior of `BOOTMAGIC_ENABLE`:
- (done) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
- (now) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
### Remove QWIIC_DRIVERS ([#14174](https://github.com/qmk/qmk_firmware/pull/14174)) :id=remove-qwiic
### Remove QWIIC_DRIVERS ([#14174](https://github.com/qmk/qmk_firmware/pull/14174)) {#remove-qwiic}
Due to minimal QWIIC adoption and other options for similar functionality, the QWIIC drivers were removed from QMK. Existing OLED usages have been migrated across to the normal QMK OLED driver instead.
## Notable core changes :id=notable-core
## Notable core changes {#notable-core}
### New MCU Support :id=new-mcu-support
### New MCU Support {#new-mcu-support}
QMK firmware picked up support for a handful of new MCU families, potentially making it a bit easier to source components.
@ -187,7 +187,7 @@ QMK firmware is now no longer limited to AVR and ARM - it also picked up support
* Westberrytech pr ([#14422](https://github.com/qmk/qmk_firmware/pull/14422))
* Initial pass of F405 support ([#14584](https://github.com/qmk/qmk_firmware/pull/14584))
### EEPROM Changes :id=eeprom-changes
### EEPROM Changes {#eeprom-changes}
There were a few EEPROM-related changes that landed during this breaking changes cycle, most prominently the long-awaited ability for the Drop boards to gain persistent storage. Any users of the Drop CTRL or Drop ALT should update QMK Toolbox as well -- coupled with a QMK firmware update settings should now be saved.
@ -197,7 +197,7 @@ There were a few EEPROM-related changes that landed during this breaking changes
* Further tidy up of STM32 eeprom emulation ([#14591](https://github.com/qmk/qmk_firmware/pull/14591))
* Enable eeprom with F401xE ld ([#14752](https://github.com/qmk/qmk_firmware/pull/14752))
### Compilation Database :id=compile-commands
### Compilation Database {#compile-commands}
A clang-compatible compilation database generator has been added as an option in order to help development environments such as Visual Studio Code.
@ -208,7 +208,7 @@ Do note that switching keyboards will require re-generation of this file.
* New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) ([#14370](https://github.com/qmk/qmk_firmware/pull/14370))
* compiledb: query include paths from gcc directly. ([#14462](https://github.com/qmk/qmk_firmware/pull/14462))
### Codebase restructure and cleanup :id=codebase-restructure
### Codebase restructure and cleanup {#codebase-restructure}
QMK continues on its restructuring journey, in order to make it easier to integrate newer features and add support for new hardware. This quarter's batch of changes include:

10
docs/ChangeLog/20220226.md
View File

@ -1,6 +1,6 @@
# QMK Breaking Changes - 2022 February 26 Changelog
## Notable Features :id=notable-features
## Notable Features {#notable-features}
### Default USB Polling rate now 1kHz ([#15352](https://github.com/qmk/qmk_firmware/pull/15352))
@ -14,7 +14,7 @@ Pointing devices can now be shared across a split keyboard with support for a si
See the [Pointing Device](feature_pointing_device.md) documentation for further configuration options.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Legacy macro and action_function system removed ([#16025](https://github.com/qmk/qmk_firmware/pull/16025))
@ -31,7 +31,7 @@ Bootloader configuration is no longer assumed. Keyboards must now set either:
In preparation of future bluetooth work, the `AdafruitBLE` integration has been renamed to allow potential for any other Adafruit BLE products.
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -241,9 +241,9 @@ The following keyboards have had their source moved within QMK:
| zinc/rev1 | 25keys/zinc/rev1 |
| zinc/reva | 25keys/zinc/reva |
## Notable core changes :id=notable-core
## Notable core changes {#notable-core}
### New MCU Support :id=new-mcu-support
### New MCU Support {#new-mcu-support}
Building on previous cycles, QMK firmware picked up support for a couple extra MCU variants:

20
docs/ChangeLog/20220528.md
View File

@ -1,8 +1,8 @@
# QMK Breaking Changes - 2022 May 28 Changelog
## Notable Features :id=notable-features
## Notable Features {#notable-features}
### Caps Word ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) :id=caps-word
### Caps Word ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) {#caps-word}
This is a new feature that allows for capslock-like functionality that turns itself off at the end of the word.
@ -10,7 +10,7 @@ For instance, if you wish to type "QMK" without holding shift the entire time, y
There are other activation mechanisms as well as configurable options like timeout and the like -- see the [Caps Word documentation](feature_caps_word.md) for more information.
### Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) :id=quantum-painter
### Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) {#quantum-painter}
QMK has had support for small OLED displays for some time now, but hasn't really gained too much ability to draw to panels other than the SSD1306 or SH1106 panels.
@ -26,7 +26,7 @@ Quantum Painter is not supported on AVR due to complexity and size constraints.
:::
### Encoder Mapping ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) :id=encoder-mapping
### Encoder Mapping ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) {#encoder-mapping}
One of the long-standing complaints with Encoders is that there has been no easy way to configure them in user keymaps. [#13286](https://github.com/qmk/qmk_firmware/pull/13286) added support for [Encoder Mapping](feature_encoders.md#encoder-map), which allows users to define encoder functionality in a similar way to their normal keymap.
@ -36,17 +36,17 @@ This is not yet supported by QMK Configurator. It is also unlikely to ever be su
:::
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### `RESET` => `QK_BOOT` ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) :id=reset-2-qk_boot
### `RESET` => `QK_BOOT` ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) {#reset-2-qk_boot}
QMK is always in the process of picking up support for new hardware platforms. One of the side-effects for future integrations has shown that QMK's usage of `RESET` as a keycode is causing naming collisions. As a result, [#17037](https://github.com/qmk/qmk_firmware/pull/17037) changed usages of `RESET` to the new keycode `QK_BOOT` in the majority of default-like keymaps. At this stage the old keycode is still usable but will likely be removed in the next breaking changes cycle. Users with keymaps containing `RESET` should also move to `QK_BOOT`.
### Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) :id=sendstring-keycodes
### Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) {#sendstring-keycodes}
Some keycodes used with `SEND_STRING` and its relatives have been deprecated and may have their old keycode usages removed at a later date. The list of [deprecated keycodes](https://github.com/qmk/qmk_firmware/blob/ebd402788346aa6e88bde1486b2a835684d40d39/quantum/send_string_keycodes.h#L456-L505) should be consulted to determine if you're using one of the older names (the first identifier after `#define`) -- you should swap to the newer variant (the second identifier on the same line).
### Pillow Installation ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) :id=pillow-install
### Pillow Installation ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) {#pillow-install}
The merge of Quantum Painter added some new dependencies in the QMK CLI, most notably _Pillow_, which requires some installation in order for the CLI to function. If you've got an existing installation, you'll need to run some commands in order to get things working:
@ -70,7 +70,7 @@ On Linux or WSL:
python3 -m pip install --user --upgrade qmk
```
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -105,7 +105,7 @@ The following keyboards have had their source moved within QMK:
---
## Full changelist :id=full-changelist
## Full changelist {#full-changelist}
Core:
* Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174))

26
docs/ChangeLog/20220827.md
View File

@ -1,28 +1,28 @@
# QMK Breaking Changes - 2022 August 27 Changelog
## Notable Features :id=notable-features
## Notable Features {#notable-features}
### Add Raspberry Pi RP2040 support ([#14877](https://github.com/qmk/qmk_firmware/pull/14877), [#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17516](https://github.com/qmk/qmk_firmware/pull/17516), [#17519](https://github.com/qmk/qmk_firmware/pull/17519), [#17612](https://github.com/qmk/qmk_firmware/pull/17612), [#17512](https://github.com/qmk/qmk_firmware/pull/17512), [#17557](https://github.com/qmk/qmk_firmware/pull/17557), [#17817](https://github.com/qmk/qmk_firmware/pull/17817), [#17839](https://github.com/qmk/qmk_firmware/pull/17839), [#18100](https://github.com/qmk/qmk_firmware/pull/18100)) :id=rp2040-support
### Add Raspberry Pi RP2040 support ([#14877](https://github.com/qmk/qmk_firmware/pull/14877), [#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17516](https://github.com/qmk/qmk_firmware/pull/17516), [#17519](https://github.com/qmk/qmk_firmware/pull/17519), [#17612](https://github.com/qmk/qmk_firmware/pull/17612), [#17512](https://github.com/qmk/qmk_firmware/pull/17512), [#17557](https://github.com/qmk/qmk_firmware/pull/17557), [#17817](https://github.com/qmk/qmk_firmware/pull/17817), [#17839](https://github.com/qmk/qmk_firmware/pull/17839), [#18100](https://github.com/qmk/qmk_firmware/pull/18100)) {#rp2040-support}
QMK _finally_ picked up support for RP2040-based boards, such as the Raspberry Pi Pico, the Sparkfun Pro Micro RP2040, and the Adafruit KB2040. One of QMK's newest collaborators, _@KarlK90_, effectively did `/micdrop` with RP2040, with a massive set of changes to both QMK and the repository QMK uses for the base platform support, ChibiOS[-Contrib]. There has been a flurry of development this breaking changes cycle related to RP2040 from a large number of contributors -- so much so that almost all standard QMK hardware subsystems are supported.
Check the [RP2040 platform development page](platformdev_rp2040.md) for all supported peripherals and other hardware implementation details.
### Allow `qmk flash` to use prebuilt firmware binaries ([#16584](https://github.com/qmk/qmk_firmware/pull/16584)) :id=cli-flash-binaries
### Allow `qmk flash` to use prebuilt firmware binaries ([#16584](https://github.com/qmk/qmk_firmware/pull/16584)) {#cli-flash-binaries}
A long-requested capability of the QMK CLI has been the ability to flash binaries directly, without needing to build a firmware. QMK provides prebuilt `develop`-based default firmwares on our [CI page](https://qmk.tzarc.io/) -- normally people would need [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases/latest) to flash them. This new functionality written by _@Erovia_ allows `qmk flash` to be provided the prebuilt file instead, simplifying the workflow for people who haven't got Toolbox available.
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Default layers dropped from 32 to 16 ([#15286](https://github.com/qmk/qmk_firmware/pull/15286))
QMK allows for controlling the maximum number of layers it supports through `LAYER_STATE_(8|16|32)BIT`. Each definition allows for the same number of maximum layers -- `LAYER_STATE_8BIT` => 8 layers. There is also a corresponding firmware size decrease that goes along with smaller numbers -- given the vast majority of users don't use more than 16 layers the default has been swapped to 16. AVR users who were not previously specifying their max layer count may see some space freed up as a result.
### `RESET` => `QK_BOOT` ([#17940](https://github.com/qmk/qmk_firmware/pull/17940)) :id=reset-2-qk_boot
### `RESET` => `QK_BOOT` ([#17940](https://github.com/qmk/qmk_firmware/pull/17940)) {#reset-2-qk_boot}
Following the last breaking changes cycle, QMK has been migrating usages of `RESET` to `QK_BOOT` due to naming collisions with our upstream board support packages. [#17940](https://github.com/qmk/qmk_firmware/pull/17940) converts user keymaps across to use the new keycode name. `RESET` should also move to `QK_BOOT`.
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -33,7 +33,7 @@ The following keyboards have had their source moved within QMK:
| idobao/id80/v1/ansi | idobao/id80/v2/ansi |
| idobao/id80/v1/iso | idobao/id80/v2/iso |
### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) :id=usb-ids-Refactoring
### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) {#usb-ids-Refactoring}
QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, eventually leaving data-driven as the only method to specify USB information.
@ -67,25 +67,25 @@ Replaced by `info.json`:
- From 2022 Aug 27, specifying USB information in `config.h` will produce warnings during build but will still function as previously.
- From 2022 Nov 26, specifying USB information in `config.h` will cause compilation to fail.
## Notable core changes :id=notable-core
## Notable core changes {#notable-core}
### Board converters ([#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17603](https://github.com/qmk/qmk_firmware/pull/17603), [#17711](https://github.com/qmk/qmk_firmware/pull/17711), [#17827](https://github.com/qmk/qmk_firmware/pull/17827), [#17593](https://github.com/qmk/qmk_firmware/pull/17593), [#17652](https://github.com/qmk/qmk_firmware/pull/17652), [#17595](https://github.com/qmk/qmk_firmware/pull/17595)) :id=board-converters
### Board converters ([#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17603](https://github.com/qmk/qmk_firmware/pull/17603), [#17711](https://github.com/qmk/qmk_firmware/pull/17711), [#17827](https://github.com/qmk/qmk_firmware/pull/17827), [#17593](https://github.com/qmk/qmk_firmware/pull/17593), [#17652](https://github.com/qmk/qmk_firmware/pull/17652), [#17595](https://github.com/qmk/qmk_firmware/pull/17595)) {#board-converters}
Historically QMK had a `CONVERT_TO_PROTON_C` directive for `rules.mk` to allow people to replace an AVR-based Pro Micro with a QMK Proton C. Global parts shortages have prompted people to create their own pin-compatible boards -- QMK has made this conversion generic and now allows for drop-in replacements for a lot more boards. see the [Converters Feature](feature_converters.md) documentation for the full list of supported replacement boards -- in this breaking changes cycle we've gone from 1 to 7.
### Add cli command to import keyboard|keymap|kbfirmware ([#16668](https://github.com/qmk/qmk_firmware/pull/16668)) :id=cli-import
### Add cli command to import keyboard|keymap|kbfirmware ([#16668](https://github.com/qmk/qmk_firmware/pull/16668)) {#cli-import}
To help with importing keyboards and keymaps from other sources, _@zvecr_ added [#16668](https://github.com/qmk/qmk_firmware/pull/16668) which adds a new set of commands to the CLI to automatically import keyboards (`qmk import-keyboard -h`), keymaps (`qmk import-keymap -h`), and kbfirmware definitions (`qmk import-kbfirmware -h`) into QMK.
The now-EOL kbfirmware allowed people who aren't set up with QMK the ability to create keyboard firmwares without requiring a full installation of QMK. Unfortunately, it targets a 7-year-old version of QMK -- adding frustration for users who want the newest features, as well as for QMK maintainers who have to spend time explaining why QMK can't just accept a drive-by code drop from kbfirmware. With any luck, this new command helps both camps!
### Generic wear-leveling for EEPROM emulation ([#16996](https://github.com/qmk/qmk_firmware/pull/16996), [#17376](https://github.com/qmk/qmk_firmware/pull/17376), [#18102](https://github.com/qmk/qmk_firmware/pull/18102)) :id=wear-leveling
### Generic wear-leveling for EEPROM emulation ([#16996](https://github.com/qmk/qmk_firmware/pull/16996), [#17376](https://github.com/qmk/qmk_firmware/pull/17376), [#18102](https://github.com/qmk/qmk_firmware/pull/18102)) {#wear-leveling}
QMK has had the ability to write to internal MCU flash in order to emulate EEPROM for some time now, but it was only limited to a small number of MCUs. The base HAL used by QMK for a large number of ARM devices provides a "proper" embedded MCU flash driver, so _@tzarc_ decoupled the wear-leveling algorithm from the old flash writing code, improved it, wrote some tests, and enabled its use for a much larger number of other devices... including RP2040's XIP flash, and external SPI NOR Flash.
See the [EEPROM Driver](eeprom_driver.md) documentation for more information.
### Pointing Device Improvements ([#16371](https://github.com/qmk/qmk_firmware/pull/16371), [#17111](https://github.com/qmk/qmk_firmware/pull/17111), [#17176](https://github.com/qmk/qmk_firmware/pull/17176), [#17482](https://github.com/qmk/qmk_firmware/pull/17482), [#17776](https://github.com/qmk/qmk_firmware/pull/17776), [#17613](https://github.com/qmk/qmk_firmware/pull/17613)) :id=pointing-device-improvements
### Pointing Device Improvements ([#16371](https://github.com/qmk/qmk_firmware/pull/16371), [#17111](https://github.com/qmk/qmk_firmware/pull/17111), [#17176](https://github.com/qmk/qmk_firmware/pull/17176), [#17482](https://github.com/qmk/qmk_firmware/pull/17482), [#17776](https://github.com/qmk/qmk_firmware/pull/17776), [#17613](https://github.com/qmk/qmk_firmware/pull/17613)) {#pointing-device-improvements}
Ever since Pointing Device Driver support and Split Pointing Device support were added by _@drashna_ and _@daskygit_, there has been increased interest in the development of the pointing device subsystem and its associated code.
@ -102,7 +102,7 @@ Other related changes:
---
## Full changelist :id=full-changelist
## Full changelist {#full-changelist}
Core:
* Tentative Teensy 3.5 support ([#14420](https://github.com/qmk/qmk_firmware/pull/14420))

28
docs/ChangeLog/20221126.md
View File

@ -1,14 +1,14 @@
# QMK Breaking Changes - 2022 November 26 Changelog
## Notable Features :id=notable-features
## Notable Features {#notable-features}
### Autocorrect ([#15699](https://github.com/qmk/qmk_firmware/pull/15699)) :id=autocorrect
### Autocorrect ([#15699](https://github.com/qmk/qmk_firmware/pull/15699)) {#autocorrect}
_@getreuer_ in their infinite wisdom decided that autocorrect was a feature needed by QMK. As is customary, _@drashna_ adapted it to core and got it into a state that everyone else can use it. See [Feature: Autocorrect](feature_autocorrect.md) for more ifnormation (grin).
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -23,7 +23,7 @@ The following keyboards have had their source moved within QMK:
| handwired/hillside/52 | hillside/52 |
| maple_computing/christmas_tree/V2017 | maple_computing/christmas_tree/v2017 |
### Keycodes refactoring :id=keycodes-overhaul-user-action
### Keycodes refactoring {#keycodes-overhaul-user-action}
QMK's keycodes got a very significant overhaul this breaking changes cycle, with the bulk of the work done by _@zvecr_ and _@fauxpark_ -- renaming, reordering, removing has been their focus in this area. In an attempt to standardise interoperation with host applications, keycode values now have strong versioning so that any connected application has confidence that the keys it thinks exist on the board actually match up with what's compiled in. These strongly-versioned keycode definitions are now published online and will not change, so tools that remap keycodes have a reference to work with. In future versions of QMK, any new or changed keycodes will result in a new version specification. See [API docs](api_docs.md#qmk-constants) for more information on the published versions if you're writing a tool to manage keycodes.
@ -37,7 +37,7 @@ Keycode aliases have been put in place in most cases to cater for "old names" be
:::
### Configuration Item Refactoring :id=config-refactoring
### Configuration Item Refactoring {#config-refactoring}
A number of configuration items have been renamed for consistency.
@ -70,7 +70,7 @@ Joystick configuration:
| JOYSTICK_AXES_COUNT | JOYSTICK_AXIS_COUNT |
| JOYSTICK_AXES_RESOLUTION | JOYSTICK_AXIS_RESOLUTION |
### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) :id=usb-ids-Refactoring
### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) {#usb-ids-Refactoring}
QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, leaving data-driven as the only method to specify USB information. As per the deprecation schedule put forward last breaking changes cycle, USB information must be specified in `info.json` instead.
@ -96,7 +96,7 @@ Replaced by `info.json`:
}
```
### LED Indicator callback refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/18450)) :id=led-callback-refactor
### LED Indicator callback refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/18450)) {#led-callback-refactor}
_RGB Matrix_ and _LED Matrix_ Indicator display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done.
@ -132,15 +132,15 @@ bool rgb_matrix_indicators_kb(void) {
The equivalent transformations should be done for LED Matrix boards.
### Unicode mode refactoring :id=unicode-mode-renaming
### Unicode mode refactoring {#unicode-mode-renaming}
Unicode modes were renamed in order to prevent collision with equivalent keycodes. The available values for `UNICODE_SELECTED_MODES` changed -- see [Feature: Unicode](feature_unicode.md#setting-the-input-mode) for the new list of values and how to configure them.
## Notable core changes :id=notable-core
## Notable core changes {#notable-core}
This breaking changes cycle, a lot of the core changes are related to cleanup and refactoring -- commonly called "tech debt".
### Keycodes refactoring :id=keycodes-overhaul-core-changes
### Keycodes refactoring {#keycodes-overhaul-core-changes}
We aren't going to list each and every change -- they're far too numerous -- instead, we'll just list the related PRs in order to convey just how wide-reaching these changes were:
@ -185,7 +185,7 @@ We aren't going to list each and every change -- they're far too numerous -- ins
* Remove legacy sendstring keycodes ([#18749](https://github.com/qmk/qmk_firmware/pull/18749))
* Reworked backlight keycodes. ([#18961](https://github.com/qmk/qmk_firmware/pull/18961))
### Board Converters :id=board-converters
### Board Converters {#board-converters}
There was additional work in the space of board converters -- historically QMK allowed for "converting" a Pro Micro build to a QMK Proton-C build. The last few versions of QMK have added support for replacement boards much like the Proton-C, and this quarter was no exception:
@ -197,7 +197,7 @@ There was additional work in the space of board converters -- historically QMK a
See [Feature: Converters](feature_converters.md) for the full list of board conversions available.
### Pointing and Digitizer device updates :id=pointing-and-digitizer
### Pointing and Digitizer device updates {#pointing-and-digitizer}
Both pointing devices and digitizer got a host of updates this cycle. Inertia, automatic mouse layers, fixes for preventing sleep... you even get more buttons with digitizers!
@ -211,7 +211,7 @@ Both pointing devices and digitizer got a host of updates this cycle. Inertia, a
* Invert pointing device motion pin for cirque touchpads ([#18404](https://github.com/qmk/qmk_firmware/pull/18404))
* Refactor more host code (programmable button & digitizer) ([#18565](https://github.com/qmk/qmk_firmware/pull/18565))
## Full changelist :id=full-changelist
## Full changelist {#full-changelist}
Core:
* quantum: led: split out led_update_ports() for customization of led behaviour ([#14452](https://github.com/qmk/qmk_firmware/pull/14452))

14
docs/ChangeLog/20230226.md
View File

@ -1,8 +1,8 @@
# QMK Breaking Changes - 2023 February 26 Changelog
## Changes Requiring User Action :id=changes-requiring-user-action
## Changes Requiring User Action {#changes-requiring-user-action}
### `IGNORE_MOD_TAP_INTERRUPT` behaviour changes ([#15741](https://github.com/qmk/qmk_firmware/pull/15741)) :id=i-m-t-i
### `IGNORE_MOD_TAP_INTERRUPT` behaviour changes ([#15741](https://github.com/qmk/qmk_firmware/pull/15741)) {#i-m-t-i}
`IGNORE_MOD_TAP_INTERRUPT_PER_KEY` has been removed and `IGNORE_MOD_TAP_INTERRUPT` deprecated as a stepping stone towards making `IGNORE_MOD_TAP_INTERRUPT` the new default behavior for mod-taps in the future.
@ -48,7 +48,7 @@ bool get_hold_on_other_key_press(uint16_t keycode, keyrecord_t *record) {
For more information, you are invited to read the sections on [IGNORE_MOD_TAP_INTERRUPT](tap_hold.md#ignore-mod-tap-interrupt) and [HOLD_ON_OTHER_KEY_PRESS](tap_hold.md#hold-on-other-key-press) in the page on [Tap-Hold configuration options](tap_hold.md).
### `TAPPING_FORCE_HOLD` => `QUICK_TAP_TERM` ([#17007](https://github.com/qmk/qmk_firmware/pull/17007)) :id=quick-tap-term
### `TAPPING_FORCE_HOLD` => `QUICK_TAP_TERM` ([#17007](https://github.com/qmk/qmk_firmware/pull/17007)) {#quick-tap-term}
`TAPPING_FORCE_HOLD` feature is now replaced by `QUICK_TAP_TERM`. Instead of turning off auto-repeat completely, user will have the option to configure a `QUICK_TAP_TERM` in milliseconds. When the user holds a tap-hold key after tapping it within `QUICK_TAP_TERM`, QMK will send the tap keycode to the host, enabling auto-repeat.
@ -82,7 +82,7 @@ uint16_t get_quick_tap_term(uint16_t keycode, keyrecord_t *record) {
For more details, please read the updated documentation section on [Quick Tap Term](tap_hold.md#quick-tap-term).
### Leader Key Rework :id=leader-key-rework ([#19632](https://github.com/qmk/qmk_firmware/pull/19632))
### Leader Key Rework {#leader-key-rework} ([#19632](https://github.com/qmk/qmk_firmware/pull/19632))
The Leader Key feature API has been significantly improved, along with some bugfixes and added tests.
@ -108,7 +108,7 @@ void leader_end_user(void) {
For more information please see the [Leader Key documentation](feature_leader_key.md).
### Updated Keyboard Codebases :id=updated-keyboard-codebases
### Updated Keyboard Codebases {#updated-keyboard-codebases}
The following keyboards have had their source moved within QMK:
@ -130,7 +130,7 @@ The following keyboards have had their source moved within QMK:
| the_uni | stenothe_uni |
| xelus/xs60 | xelus/xs60/soldered |
## Notable core changes :id=notable-core
## Notable core changes {#notable-core}
As per last breaking changes cycle, there has been _a lot_ of emphasis on behind-the-scenes changes, mainly around consolidation of core subsystems and constant values, as well as addressing tech debt. Whilst not outwardly visible, this cleanup and refactoring should start paying dividends as it simplifies future development and maintenance.
@ -142,7 +142,7 @@ A handful of examples:
* Many more configuration options have moved into `info.json`, such as backlight, encoders
* Additional unit tests to ensure keycode behaviours don't accidentally change
## Full changelist :id=full-changelist
## Full changelist {#full-changelist}
Core:
* Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY ([#15741](https://github.com/qmk/qmk_firmware/pull/15741))

8
docs/feature_advanced_keycodes.md
View File

@ -37,9 +37,9 @@ For more information on bitwise operators in C, click [here](https://en.wikipedi
In practice, this means that you can check whether a given modifier is active with `get_mods() & MOD_BIT(KC_<modifier>)` (see the [list of modifier keycodes](keycodes_basic.md#modifiers)) or with `get_mods() & MOD_MASK_<modifier>` if the difference between left and right hand modifiers is not important and you want to match both. Same thing can be done for one-shot modifiers if you replace `get_mods()` with `get_oneshot_mods()`.
To check that *only* a specific set of mods is active at a time, AND the modifier state and your desired mod mask as explained above and compare the result to the mod mask itself: `get_mods() & <mod mask> == <mod mask>`.
To check that *only* a specific set of mods is active at a time, use a simple equality operator: `get_mods() == <mod mask>`.
For example, let's say you want to trigger a piece of custom code if one-shot left control and one-shot left shift are on but every other one-shot mods are off. To do so, you can compose the desired mod mask by combining the mod bits for left control and shift with `(MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))` and then plug it in: `get_oneshot_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT)) == (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))`. Using `MOD_MASK_CS` instead for the mod bitmask would have forced you to press four modifier keys (both versions of control and shift) to fulfill the condition.
For example, let's say you want to trigger a piece of custom code if one-shot left control and one-shot left shift are on but every other one-shot mods are off. To do so, you can compose the desired mod mask by combining the mod bits for left control and shift with `(MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))` and then plug it in: `get_oneshot_mods() == (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))`. Using `MOD_MASK_CS` instead for the mod bitmask would have forced you to press four modifier keys (both versions of control and shift) to fulfill the condition.
The full list of mod masks is as follows:
@ -91,7 +91,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
case KC_ESC:
// Detect the activation of only Left Alt
if ((get_mods() & MOD_BIT(KC_LALT)) == MOD_BIT(KC_LALT)) {
if (get_mods() == MOD_BIT(KC_LALT)) {
if (record->event.pressed) {
// No need to register KC_LALT because it's already active.
// The Alt modifier will apply on this KC_TAB.
@ -184,4 +184,4 @@ This page used to encompass a large set of features. We have moved many sections
## Key Overrides {#key-overrides}
* [Key Overrides](feature_key_overrides.md)
* [Key Overrides](feature_key_overrides.md)

2
docs/feature_combo.md
View File

@ -58,7 +58,7 @@ const uint16_t PROGMEM jk_combo[] = {KC_J, KC_K, COMBO_END};
const uint16_t PROGMEM qw_combo[] = {KC_Q, KC_W, COMBO_END};
const uint16_t PROGMEM sd_combo[] = {KC_S, KC_D, COMBO_END};
combo_t key_combos[COMBO_COUNT] = {
combo_t key_combos[] = {
[AB_ESC] = COMBO(ab_combo, KC_ESC),
[JK_TAB] = COMBO(jk_combo, KC_TAB),
[QW_SFT] = COMBO(qw_combo, KC_LSFT),

69
docs/feature_pointing_device.md
View File

@ -450,6 +450,75 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
This allows you to toggle between scrolling and cursor movement by pressing the DRAG_SCROLL key.
### Advanced Drag Scroll
Sometimes, like with the Cirque trackpad, you will run into issues where the scrolling may be too fast.
Here is a slightly more advanced example of drag scrolling. You will be able to change the scroll speed based on the values in set in `SCROLL_DIVISOR_H` and `SCROLL_DIVISOR_V`. This bit of code is also set up so that instead of toggling the scrolling state with set_scrolling = !set_scrolling, the set_scrolling variable is set directly to record->event.pressed. This way, the drag scrolling will only be active while the DRAG_SCROLL button is held down.
```c
enum custom_keycodes {
DRAG_SCROLL = SAFE_RANGE,
};
bool set_scrolling = false;
// Modify these values to adjust the scrolling speed
#define SCROLL_DIVISOR_H 8.0
#define SCROLL_DIVISOR_V 8.0
// Variables to store accumulated scroll values
float scroll_accumulated_h = 0;
float scroll_accumulated_v = 0;
// Function to handle mouse reports and perform drag scrolling
report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) {
// Check if drag scrolling is active
if (set_scrolling) {
// Calculate and accumulate scroll values based on mouse movement and divisors
scroll_accumulated_h += (float)mouse_report.x / SCROLL_DIVISOR_H;
scroll_accumulated_v += (float)mouse_report.y / SCROLL_DIVISOR_V;
// Assign integer parts of accumulated scroll values to the mouse report
mouse_report.h = (int8_t)scroll_accumulated_h;
mouse_report.v = (int8_t)scroll_accumulated_v;
// Update accumulated scroll values by subtracting the integer parts
scroll_accumulated_h -= (int8_t)scroll_accumulated_h;
scroll_accumulated_v -= (int8_t)scroll_accumulated_v;
// Clear the X and Y values of the mouse report
mouse_report.x = 0;
mouse_report.y = 0;
}
return mouse_report;
}
// Function to handle key events and enable/disable drag scrolling
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
case DRAG_SCROLL:
// Toggle set_scrolling when DRAG_SCROLL key is pressed or released
set_scrolling = record->event.pressed;
break;
default:
break;
}
return true;
}
// Function to handle layer changes and disable drag scrolling when not in AUTO_MOUSE_DEFAULT_LAYER
layer_state_t layer_state_set_user(layer_state_t state) {
// Disable set_scrolling if the current layer is not the AUTO_MOUSE_DEFAULT_LAYER
if (get_highest_layer(state) != AUTO_MOUSE_DEFAULT_LAYER) {
set_scrolling = false;
}
return state;
}
```
## Split Examples
The following examples make use the `SPLIT_POINTING_ENABLE` functionality and show how to manipulate the mouse report for a scrolling mode.

12
docs/ja/cli.md
View File

@ -1,19 +1,19 @@
# QMK CLI :id=qmk-cli
# QMK CLI {#qmk-cli}
<!---
original document: 0.9.19:docs/cli.md
git diff 0.9.19 HEAD -- docs/cli.md | cat
-->
## 概要 :id=overview
## 概要 {#overview}
QMK CLI を使用すると QMK キーボードの構築と作業が簡単になります。QMK ファームウェアの取得とコンパイル、キーマップの作成などのようなタスクを簡素化し合理化するためのコマンドを多く提供します。
### 必要事項 :id=requirements
### 必要事項 {#requirements}
QMK は Python 3.6 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) に列挙されているパッケージもインストールする必要があります。これらは QMK CLI をインストールするときに自動的にインストールされます。
### Homebrew を使ったインストール (macOS、いくつかの Linux) :id=install-using-homebrew
### Homebrew を使ったインストール (macOS、いくつかの Linux) {#install-using-homebrew}
[Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます:
@ -23,7 +23,7 @@ export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を
qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
```
### pip を使ってインストール :id=install-using-easy_install-or-pip
### pip を使ってインストール {#install-using-easy_install-or-pip}
上で列挙した中にあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.6 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします:
@ -33,7 +33,7 @@ export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を
qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
```
### 他のオペレーティングシステムのためのパッケージ :id=packaging-for-other-operating-systems
### 他のオペレーティングシステムのためのパッケージ {#packaging-for-other-operating-systems}
より多くのオペレーティングシステム用に `qmk` パッケージを作成および保守する人を探しています。OS 用のパッケージを作成する場合は、以下のガイドラインに従ってください:

2
docs/ja/cli_configuration.md
View File

@ -74,7 +74,7 @@ default.keymap: None -> default
qmk config compile
### 単一キーの例 :id=single-key-example
### 単一キーの例 {#single-key-example}
qmk config compile.keyboard

6
docs/ja/config_options.md
View File

@ -141,7 +141,7 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
* `#define STRICT_LAYER_RELEASE`
* キーリリースがどのレイヤーから来たのかを覚えるのではなく、現在のレイヤースタックを使って強制的に評価されるようにします (高度なケースに使われます)
## 設定可能な挙動 :id=behaviors-that-can-be-configured
## 設定可能な挙動 {#behaviors-that-can-be-configured}
* `#define TAPPING_TERM 200`
* タップがホールドになるまでの時間。
@ -188,7 +188,7 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
* `#define TAP_HOLD_CAPS_DELAY 80`
* MacOS で特別な処理が行われるため、`KC_CAPSLOCK` を使う時にタップホールドキー (`LT`, `MT`) に遅延を設定します。この値はミリ秒で、定義されていない場合はデフォルトは80msです。macOS については、これを200以上に設定すると良いでしょう。
## RGB ライト設定 :id=rgb-light-configuration
## RGB ライト設定 {#rgb-light-configuration}
* `#define RGB_DI_PIN D7`
* WS2812 の DI 端子につなぐピン
@ -347,7 +347,7 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
* `bootloadHID`
* `USBasp`
## 機能オプション :id=feature-options
## 機能オプション {#feature-options}
これらを使って特定の機能のビルドを有効または無効にします。有効にすればするほどファームウェアが大きくなり、MCU には大きすぎるファームウェアを構築するリスクがあります。

10
docs/ja/contributing.md
View File

@ -26,7 +26,7 @@ QMK について質問したい場合は、[OLKB Subreddit](https://reddit.com/r
* https://opensource.com/life/16/10/how-ask-technical-questions
* http://www.catb.org/esr/faqs/smart-questions.html
# プロジェクトの概要 :id=project-overview
# プロジェクトの概要 {#project-overview}
QMK は主に C で書かれており、特定の機能と部品は C++ で書かれています。QMK は、キーボードの中の組み込みプロセッサ、特に AVR ([LUFA](https://www.fourwalledcubicle.com/LUFA.php)) と ARM ([ChibiOS](https://www.chibios.org)) を対象にしています。すでに Arduino プログラミングに精通している場合は、多くの概念と制限がおなじみのものです。QMK に貢献するには Arduino を使用した経験は必要ありません。
@ -57,14 +57,14 @@ QMK は主に C で書かれており、特定の機能と部品は C++ で書
14. レビューをしているメンテナが変更を推奨する場合は、プルリクエストに変更を加えます。
15. プルリクエストがマージされた後で成功を祝います！
# コーディング規約 :id=coding-conventions
# コーディング規約 {#coding-conventions}
私たちのスタイルのほとんどは簡単に理解できます。C あるいは Python のいずれかに精通している場合は、ローカルスタイルにそれほど問題はないはずです。
* [コーディング規約 - C](ja/coding_conventions_c.md)
* [コーディング規約 - Python](ja/coding_conventions_python.md)
# 一般的なガイドライン :id=general-guidelines
# 一般的なガイドライン {#general-guidelines}
QMK には幾つかの異なるタイプの変更があり、それぞれ異なるレベルの厳密さが必要です。どのような種類の変更を行っても、次のガイドラインに留意してください。
@ -110,7 +110,7 @@ enum my_keycodes {
};
```
### ドキュメントのプレビュー :id=previewing-the-documentation
### ドキュメントのプレビュー {#previewing-the-documentation}
開発環境をセットアップした場合は、プルリクエストを開く前に以下のコマンドを `qmk_firmware/` フォルダから実行することで、あなたの変更をプレビューすることができます:
@ -172,6 +172,6 @@ enum my_keycodes {
QMK で物事がどのようにレイアウトされるかについて明確なビジョンを維持するために、私たちはリファクタリングを詳細に計画し、変更をする協力者がいます。リファクタリングのアイデアあるいは提案がある場合は、[issue を開いてください](https://github.com/qmk/qmk_firmware/issues)。QMK を改善する方法についてお話ししたいと思います。
# 行動規範は私にとって何を意味しますか？ :id=what-does-the-code-of-conduct-mean-for-me
# 行動規範は私にとって何を意味しますか？ {#what-does-the-code-of-conduct-mean-for-me}
私たちの[行動規範](https://github.com/qmk/qmk_firmware/blob/master/CODE_OF_CONDUCT.md)は、身元に関係なくあなたがプロジェクトの全員を敬意と礼儀を持って扱う責任があることを意味します。あなたが行動規範に記載されている不適切な行動やコメントの被害者である場合は、私たちはあなたのためにここにおり、私たちのコードに従って虐待者が適切に懲戒されるように最善を尽くします。

2
docs/ja/custom_matrix.md
View File

@ -31,7 +31,7 @@ keyboards/<keyboard>/matrix.c
SRC += matrix.c
```
## マトリックスコードの部分置き換え :id=lite
## マトリックスコードの部分置き換え {#lite}
カスタムマトリックスを実装する際、定型コードを書かなくてすむように、さまざまなスキャン関数のデフォルト実装を提供しています。

12
docs/ja/custom_quantum_functions.md
View File

@ -9,7 +9,7 @@
このページでは、QMK に関する特別な知識は想定していませんが、[QMK の理解](ja/understanding_qmk.md)を読むとより根本的なレベルで何が起きているかを理解するのに役立ちます。
## コア、キーボード、キーマップ階層 :id=a-word-on-core-vs-keyboards-vs-keymap
## コア、キーボード、キーマップ階層 {#a-word-on-core-vs-keyboards-vs-keymap}
私たちは QMK を階層として構造化しました:
@ -39,7 +39,7 @@ enum my_keycodes {
};
```
## 任意のキーコードの挙動のプログラミング :id=programming-the-behavior-of-any-keycode
## 任意のキーコードの挙動のプログラミング {#programming-the-behavior-of-any-keycode}
既存のキーの挙動を上書きしたい場合、あるいは新しいキーについて挙動を定義する場合、`process_record_kb()` および `process_record_user()` 関数を使うべきです。これらは実際のキーイベントが処理される前のキー処理中に QMK によって呼び出されます。これらの関数が `true` を返す場合、QMK はキーコードを通常通りに処理します。これは、キーを置き換えるのではなく、キーの機能を拡張するのに便利です。これらの関数が `false` を返す場合、QMK は通常のキー処理をスキップし、必要なキーのアップまたはダウンイベントを送信するのかはユーザ次第です。
@ -136,7 +136,7 @@ void keyboard_pre_init_user(void) {
}
```
### `keyboard_pre_init_*` 関数のドキュメント :id=keyboard_pre_init_-function-documentation
### `keyboard_pre_init_*` 関数のドキュメント {#keyboard_pre_init_-function-documentation}
* キーボード/リビジョン: `void keyboard_pre_init_kb(void)`
* キーマップ: `void keyboard_pre_init_user(void)`
@ -177,7 +177,7 @@ void keyboard_post_init_user(void) {
* キーボード/リビジョン: `void keyboard_post_init_kb(void)`
* キーマップ: `void keyboard_post_init_user(void)`
# マトリックススキャンコード :id=matrix-scanning-code
# マトリックススキャンコード {#matrix-scanning-code}
可能であれば常に `process_record_*()` を使ってキーボードをカスタマイズし、その方法でイベントをフックし、コードがキーボードのパフォーマンスに悪影響を与えないようにします。ただし、まれにマトリックススキャンにフックする必要があります。これらの関数は1秒あたり少なくとも10回は呼び出されるため、これらの関数のコードのパフォーマンスに非常に注意してください。
@ -194,7 +194,7 @@ void keyboard_post_init_user(void) {
カスタムマトリックススキャンコードが必要な場合は、この関数を使う必要があります。また、カスタムステータス出力 (LED あるいはディスプレイなど)や、ユーザが入力していない場合でも定期的にトリガーするその他の機能のために使うことができます。
# キーボードハウスキーピング :id=keyboard-housekeeping
# キーボードハウスキーピング {#keyboard-housekeeping}
* キーボード/リビジョン: `void housekeeping_task_kb(void)`
* キーマップ: `void housekeeping_task_user(void)`
@ -228,7 +228,7 @@ void suspend_wakeup_init_user(void) {
* キーボード/リビジョン : `void suspend_power_down_kb(void)` および `void suspend_wakeup_init_user(void)`
* キーマップ: `void suspend_power_down_kb(void)` および `void suspend_wakeup_init_user(void)`
# レイヤー切り替えコード :id=layer-change-code
# レイヤー切り替えコード {#layer-change-code}
これはレイヤーが切り替えられるたびにコードを実行します。レイヤー表示あるいはカスタムレイヤー処理に役立ちます。

2
docs/ja/documentation_templates.md
View File

@ -7,7 +7,7 @@
このページでは、新しいキーマップやキーボードを QMK に提出する際に使うべきテンプレートをまとめています。
## キーマップ `readme.md` テンプレート :id=keyboard-readmemd-template
## キーマップ `readme.md` テンプレート {#keyboard-readmemd-template}
ほとんどのキーマップには、レイアウトを表す画像があります。画像を作成するには、[Keyboard Layout Editor](https://keyboard-layout-editor.com) を使うことができます。画像は [Imgur](https://imgur.com) や別のホスティングサービスにアップロードし、プルリクエストに画像を含めないでください。

2
docs/ja/faq_build.md
View File

@ -22,7 +22,7 @@
`make` を `sudo` で実行することは一般的には良い考えでは***なく***、可能であれば前者の方法のいずれかを使うべきです。
### Linux の `udev` ルール :id=linux-udev-rules
### Linux の `udev` ルール {#linux-udev-rules}
Linux では、ブートローダデバイスと通信するには適切な権限が必要です。ファームウェアを書き込む時に `sudo` を使うか(非推奨)、`/etc/udev/rules.d/` に[このファイル](https://github.com/qmk/qmk_firmware/tree/master/util/udev/50-qmk.rules)を配置することで、通信することができます。

2
docs/ja/faq_debug.md
View File

@ -7,7 +7,7 @@
このページは、キーボードのトラブルシューティングについての様々な一般的な質問を説明します。
## デバッグ :id=debugging
## デバッグ {#debugging}
`rules.mk` へ `CONSOLE_ENABLE = yes` の設定をするとキーボードはデバッグ情報を出力します。デフォルトの出力は非常に限られたものですが、デバッグモードをオンにすることでデバッグ情報の量を増やすことが出来ます。キーマップの `DEBUG` キーコードを使用するか、デバッグモードを有効にする[コマンド](ja/feature_command.md)機能を使用するか、以下のコードをキーマップに追加します。

2
docs/ja/faq_misc.md
View File

@ -5,7 +5,7 @@
git diff 0.12.45 HEAD -- docs/faq_misc.md | cat
-->
## どうやってキーボードをテストすればいいですか？ :id=testing
## どうやってキーボードをテストすればいいですか？ {#testing}
通常、キーボードのテストは非常に簡単です。全てのキーをひとつずつ押して、期待するキーが送信されることを確認します。例え QMK で動作していない場合でも、[QMK Configurator](https://config.qmk.fm/#/test/) のテストモードを使用すると、キーボードをチェックできます。

20
docs/ja/feature_advanced_keycodes.md
View File

@ -1,4 +1,4 @@
# 修飾キー :id=modifier-keys
# 修飾キー {#modifier-keys}
<!---
original document: 0.14.6:docs/feature_advanced_keycodes.md
@ -31,7 +31,7 @@
また、それらを繋げることができます。例えば、`LCTL(LALT(KC_DEL))` または `C(A(KC_DEL))` は1回のキー押下で Control+Alt+Delete を送信するキーを作成します。
# モディファイアの状態を確認 :id=checking-modifier-state
# モディファイアの状態を確認 {#checking-modifier-state}
現在のモディファイアの状態は、2つの関数によって主にアクセスされます。: `get_mods()` 関数は通常のモディファイアとモッドタップの状態を、`get_oneshot_mods()` 関数はワンショットモディファイアの状態を確認する関数です。(ワンショットモディファイアはキーが押されていない限り、通常のモディファイアキーのように動作します。)
@ -84,10 +84,10 @@ C 言語におけるビット演算のより詳しい情報は、[ここ](https:
* `set_oneshot_mods(mods)`: `mods` で現在のワンショットモディファイアの状態を上書きします
* `clear_oneshot_mods()`: 全てのワンショットモディファイアを無効にすることによって、ワンショットモディファイアの状態をリセットします。
## 例 :id=examples
## 例 {#examples}
次の例は、[マクロについてのページ](ja/feature_macros.md) で読める [高度なマクロ](ja/feature_macros.md?id=advanced-macro-functions) を使っています。
### Alt + Tab の代わりの Alt + Escape :id=alt-escape-for-alt-tab
### Alt + Tab の代わりの Alt + Escape {#alt-escape-for-alt-tab}
左 Alt と `KC_ESC` が押されたときに、アプリ切り替えの（左 Alt と） `KC_TAB` のように振る舞うことを実現する単純な例です。この例は、左 Alt だけがアクティブになっているかを厳格に確認します。つまり、Alt+Shift+Esc によるアプリの逆順での切り替えはできません。また、この例は、実際の Alt+Escape キーボードショートカットを起動することはできなくなりますが、AltGr+Escape キーボードショートカットを起動することはできることに留意してください。
@ -116,7 +116,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
};
```
### Delete の代わりの Shift + Backspace :id=shift-backspace-for-delete
### Delete の代わりの Shift + Backspace {#shift-backspace-for-delete}
`KC_BSPC` と組み合わせることで Shift の本来の動作が取り消され、そして、`KC_DEL` に完全に置き換えられる高度な例です。この例を適切に動作させるために2つのメイン変数が作られます。: `mod_state` と `delkey_registered` です。最初の1つ目の変数は、モディファイアの状態を記憶し、`KC_DEL` を登録した後に元に戻すために使われます。2つ目の変数はブール型変数 (true または false) で、`KC_DEL` の状態を追跡して Backspace/Delete キー全体のリリースを正確に管理します。
@ -164,22 +164,22 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
return true;
};
```
# 過去の内容 :id=legacy-content
# 過去の内容 {#legacy-content}
このページには多くの機能が含まれていました。このページを構成していた多くのセクションをそれぞれのページに移動しました。これより下は全て単なるリダイレクトであるため、web上で古いリンクをたどっている人は探しているものを見つけることができます。
## レイヤー :id=switching-and-toggling-layers
## レイヤー {#switching-and-toggling-layers}
* [レイヤー](ja/feature_layers.md)
## モッドタップ :id=mod-tap
## モッドタップ {#mod-tap}
* [モッドタップ](ja/mod_tap.md)
## ワンショットキー :id=one-shot-keys
## ワンショットキー {#one-shot-keys}
* [ワンショットキー](ja/one_shot_keys.md)
## タップホールド設定オプション :id=tap-hold-configuration-options
## タップホールド設定オプション {#tap-hold-configuration-options}
* [タップホールド設定オプション](ja/tap_hold.md)

30
docs/ja/feature_backlight.md
View File

@ -1,4 +1,4 @@
# バックライト :id=backlighting
# バックライト {#backlighting}
<!---
original document: 0.14.14:docs/feature_backlight.md
@ -17,7 +17,7 @@ MCU は、GPIO ピンにはそんなに電流を供給できません。MCU か
BACKLIGHT_ENABLE = yes
```
## キーコード :id=keycodes
## キーコード {#keycodes}
有効にすると、以下のキーコードを使ってバックライトレベルを変更することができます。
@ -31,7 +31,7 @@ BACKLIGHT_ENABLE = yes
| `BL_DEC` | バックライトレベルを下げる |
| `BL_BRTG` | バックライトの明滅動作を切り替える |
## 関数群 :id=functions
## 関数群 {#functions}
次の関数を使って、カスタムコードでバックライトを変更することができます:
@ -55,7 +55,7 @@ BACKLIGHT_ENABLE = yes
| `breathing_enable()` | バックライトの明滅動作をオンにする |
| `breathing_disable()` | バックライトの明滅動作をオフにする |
## 設定 :id=configuration
## 設定 {#configuration}
どのドライバを使うかを選択するには、以下を使って `rules.mk` を設定します:
@ -81,14 +81,14 @@ BACKLIGHT_DRIVER = software
独自のキーボードを設計しているわけではない限り、通常は `BACKLIGHT_PIN` または `BACKLIGHT_ON_STATE` を変更する必要はありません。
### バックライトオン状態 :id=backlight-on-state
### バックライトオン状態 {#backlight-on-state}
ほとんどのバックライトの回路は N チャンネルの MOSFET あるいは NPN トランジスタによって駆動されます。これは、トランジスタを *オン* にして LED を点灯させるには、ゲートまたはベースに接続されているバックライトピンを *high* に駆動する必要があることを意味します。
ただし、P チャンネルの MOSFET あるいは PNP トランジスタが使われる場合があります。この場合、トランジスタがオンの時、ピンは代わりに *low* で駆動されます。
この機能は `BACKLIGHT_ON_STATE` を定義することでキーボードレベルで設定されます。
### AVR ドライバ :id=avr-driver
### AVR ドライバ {#avr-driver}
`pwm` ドライバはデフォルトで設定されますが、`rules.mk` 内での同等の設定は以下の通りです:
@ -96,7 +96,7 @@ BACKLIGHT_DRIVER = software
BACKLIGHT_DRIVER = pwm
```
#### 注意事項 :id=avr-caveats
#### 注意事項 {#avr-caveats}
AVR ボードでは、QMK はどのドライバを使うかを以下の表に従って自動的に決定します:
@ -126,7 +126,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
両方のタイマーがオーディオのために使われている場合、バックライト PWM はハードウェアタイマを使うことができず、代わりにマトリックススキャンの間に引き起こされます。この場合、PWM の計算は十分なタイミングの精度で呼ばれない可能性があるため、バックライトの明滅はサポートされず、バックライトもちらつくかもしれません。
#### ハードウェア PWM 実装 :id=hardware-pwm-implementation
#### ハードウェア PWM 実装 {#hardware-pwm-implementation}
バックライト用にサポートされているピンを使う場合、QMK は PWM 信号を出力するように設定されたハードウェアタイマを使います。タイマーは 0 にリセットする前に `ICRx` (デフォルトでは `0xFFFF`) までカウントします。
希望の輝度が計算され、`OCRxx` レジスタに格納されます。カウンタがこの値まで達すると、バックライトピンは low になり、カウンタがリセットされると再び high になります。
@ -135,7 +135,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
明滅動作の効果はカウンタがリセットされる(秒間あたりおよそ244回)たびに呼び出される `TIMER1_OVF_vect` の割り込みハンドラを登録することで可能になります。
このハンドラで、増分カウンタの値が事前に計算された輝度曲線にマップされます。明滅動作をオフにするには、割り込みを単純に禁止し、輝度を EEPROM に格納されているレベルに再設定します。
#### タイマー支援 PWM 実装 :id=timer-assisted-implementation
#### タイマー支援 PWM 実装 {#timer-assisted-implementation}
`BACKLIGHT_PIN` がハードウェアバックライトピンに設定されていない場合、QMK はソフトウェア割り込みを引き起こすように設定されているハードウェアタイマを使います。タイマーは 0 にリセットする前に `ICRx` (デフォルトでは `0xFFFF`) までカウントします。
0 に再設定すると、CPU は LED をオンにする OVF (オーバーフロー)割り込みを発火し、デューティサイクルを開始します。
@ -144,7 +144,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
明滅の効果はハードウェア PWM 実装と同じです。
### ARM ドライバ :id=arm-configuration
### ARM ドライバ {#arm-configuration}
まだ初期段階ですが、ARM バックライトサポートは最終的に AVR と同等の機能を持つことを目指しています。`pwm` ドライバはデフォルトで設定されますが、`rules.mk` 内での同等の設定は以下の通りです:
@ -152,7 +152,7 @@ AVR ボードでは、QMK はどのドライバを使うかを以下の表に従
BACKLIGHT_DRIVER = pwm
```
#### ChibiOS の設定 :id=arm-configuration
#### ChibiOS の設定 {#arm-configuration}
以下の `#define` は ARM ベースのキーボードにのみ適用されます:
@ -164,11 +164,11 @@ BACKLIGHT_DRIVER = pwm
これらの値を決定するには、特定の MCU の ST データシートを参照してください。独自のキーボードを設計しているわけではない場合、通常はこれらを変更する必要はありません。
#### 注意事項 :id=arm-caveats
#### 注意事項 {#arm-caveats}
現在のところ、ハードウェア PWM のみがサポートされ、タイマー支援はなく、自動設定は提供されません。
### ソフトウェア PWM ドライバ :id=software-pwm-driver
### ソフトウェア PWM ドライバ {#software-pwm-driver}
このモードでは、他のキーボードのタスクを実行中に PWM は「エミュレート」されます。追加のプラットフォーム設定なしで最大のハードウェア互換性を提供します。トレードオフは、キーボードが忙しい時にバックライトが揺れる可能性があることです。有効にするには、`rules.mk` に以下を追加します:
@ -176,7 +176,7 @@ BACKLIGHT_DRIVER = pwm
BACKLIGHT_DRIVER = software
```
#### 複数のバックライトピン :id=multiple-backlight-pins
#### 複数のバックライトピン {#multiple-backlight-pins}
ほとんどのキーボードは、全てのバックライト LED を制御するたった1つのバックライトピンを持ちます (特にバックライトがハードウェア PWM ピンに接続されている場合)。
ソフトウェア PWM では、複数のバックライトピンを定義することができます。これらのピンは PWM デューティサイクル時に同時にオンおよびオフになります。
@ -189,7 +189,7 @@ BACKLIGHT_DRIVER = software
#define BACKLIGHT_PINS { F5, B2 }
```
### カスタムドライバ :id=custom-driver
### カスタムドライバ {#custom-driver}
上記ドライバのいずれもキーボードに適用されていない場合(例えば、バックライトを制御するのに別の IC を使用している場合)、QMK が提供しているこの簡単な API を使ってカスタムバックライトドライバを実装することができます。有効にするには、`rules.mk` に以下を追加します:

4
docs/ja/feature_bootmagic.md
View File

@ -63,7 +63,7 @@ BOOTMAGIC_ENABLE = lite
| `6` | レイヤー 6 をデフォルトレイヤーにする |
| `7` | レイヤー 7 をデフォルトレイヤーにする |
## キーコード :id=keycodes
## キーコード {#keycodes}
| キー | エイリアス | 説明 |
|----------------------------------|---------|--------------------------------------------------------------------------|
@ -130,7 +130,7 @@ BOOTMAGIC_ENABLE = lite
| `BOOTMAGIC_KEY_DEFAULT_LAYER_6` | `KC_6` | レイヤー 6 をデフォルトレイヤーにする |
| `BOOTMAGIC_KEY_DEFAULT_LAYER_7` | `KC_7` | レイヤー 7 をデフォルトレイヤーにする |
# ブートマジックライト :id=bootmagic-lite
# ブートマジックライト {#bootmagic-lite}
本格的なブートマジック機能の他に、ブートローダへのジャンプのみを処理するブートマジックライトがあります。これは、物理的なリセットボタンが無くブートローダにジャンプする方法が必要だが、ブートマジックが引き起こす問題を扱いたくないキーボードに適しています。

16
docs/ja/feature_layers.md
View File

@ -1,4 +1,4 @@
# レイヤー :id=layers
# レイヤー {#layers}
<!---
original document: 0.12.41:docs/feature_layers.md
@ -9,7 +9,7 @@ QMK ファームウェアの最も強力で良く使われている機能の一
レイヤースタックがどのように動作するかの詳細な説明については、[キーマップの概要](ja/keymap.md#keymap-and-layers)を調べてください。
## レイヤーの切り替えとトグル :id=switching-and-toggling-layers
## レイヤーの切り替えとトグル {#switching-and-toggling-layers}
以下の関数により、様々な方法でレイヤーをアクティブにすることができます。レイヤーは通常、独立したレイアウトでは無いことに注意してください -- 複数のレイヤーを一度にアクティブにすることができ、レイヤーが `KC_TRNS` を使ってキーの押下を下のレイヤーへと透過させることが一般的です。MO()、LM()、TT() あるいは LT() を使って一時的なレイヤーの切り替えを使う場合、上のレイヤーのキーを透過にするようにしてください。さもないと意図したように動作しないかもしれません。
@ -22,17 +22,17 @@ QMK ファームウェアの最も強力で良く使われている機能の一
* `TO(layer)` - *レイヤー*をアクティブにし、他の全てのレイヤー(デフォルトレイヤーを除く)を非アクティブにします。この関数は特別です。1つのレイヤーをアクティブなレイヤースタックに追加/削除する代わりに、現在のアクティブなレイヤーを完全に置き換え、唯一上位のレイヤーを下位のレイヤーで置き換えることができるからです。これはキーダウンで(キーが押されるとすぐに)アクティブになります。
* `TT(layer)` - レイヤーのタップ切り替え。キーを押したままにすると*レイヤー*がアクティブにされ、放すと非アクティブになります (`MO` 風)。繰り返しタップすると、レイヤーはオンあるいはオフを切り替えます (`TG` 風)。デフォルトでは5回のタップが必要ですが、`TAPPING_TOGGLE` を定義することで変更することができます -- 例えば、2回のタップだけで切り替えるには、`#define TAPPING_TOGGLE 2` を定義します。
### 注意事項 :id=caveats
### 注意事項 {#caveats}
現在のところ、`LT()` の `layer` 引数はレイヤー 0-15 に制限され、`kc` 引数は[基本的なキーコードセット](ja/keycodes_basic.md)に制限されています。つまり、`LCTL()`、`KC_TILD` あるいは `0xFF` より大きなキーコードを使うことができません。これは、QMK が16ビットのキーコードを使うためです。4ビットは機能の識別のために使われ、4ビットはレイヤーのために使われ、キーコードには8ビットしか残されていません。
これを拡張してもせいぜい複雑になるだけでしょう。32ビットキーコードに移行すると、これの多くが解決されますが、キーマップマトリックスが使用する領域が2倍になります。また、問題が起きる可能性もあります。タップしたキーコードにモディファイアを適用する必要がある場合は、[タップダンス](ja/feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys)を使うことができます。
## レイヤーとの連携 :id=working-with-layers
## レイヤーとの連携 {#working-with-layers}
レイヤーを切り替える時は注意してください。(キーボードを取り外さずに)そのレイヤーを非アクティブにすることができずレイヤーから移動できなくなる可能性があります。最も一般的な問題を避けるためのガイドラインを作成しました。
### 初心者 :id=beginners
### 初心者 {#beginners}
QMK を使い始めたばかりの場合は、全てを単純にしたいでしょう。レイヤーをセットアップする時は、これらのガイドラインに従ってください:
@ -40,11 +40,11 @@ QMK を使い始めたばかりの場合は、全てを単純にしたいでし
* layer 0 をルートとして、レイヤーを "ツリー" レイアウトに配置します。他の複数のレイヤーから同じレイヤーに行こうとしないでください。
* 各レイヤーのキーマップでは、より高い番号のレイヤーのみを参照します。レイヤーは最大の番号(最上位)のアクティブレイヤーから処理されるため、下位レイヤーの状態を変更するのは難しくエラーが発生しやすくなります。
### 中級ユーザ :id=intermediate-users
### 中級ユーザ {#intermediate-users}
複数の基本レイヤーが必要な場合があります。例えば、QWERTY と Dvorak を切り替える場合、国ごとに異なるレイアウトを切り替える場合、あるいは異なるビデオゲームごとにレイアウトを切り替える場合などです。基本レイヤーは常に最小の番号のレイヤーである必要があります。複数の基本レイヤーがある場合、常にそれらを相互排他的に扱う必要があります。1つの基本レイヤーがオンの場合、他をオフにします。
### 上級ユーザ :id=advanced-users
### 上級ユーザ {#advanced-users}
レイヤーがどのように動作し、何ができるかを理解したら、より創造的になります。初心者のセクションで列挙されている規則は、幾つかの巧妙な詳細を回避するのに役立ちますが、特に超コンパクトなキーボードのユーザにとって制約になる場合があります。レイヤーの仕組みを理解することで、レイヤーをより高度な方法で使うことができます。
@ -52,7 +52,7 @@ QMK を使い始めたばかりの場合は、全てを単純にしたいでし
場合によっては、マクロ内あるいはタップダンスルーチンの一部としてレイヤーを切り替えほうが良いかもしれません。`layer_on` はレイヤーをアクティブにし、`layer_off` はそれを非アクティブにします。もっと多くのレイヤーに関する関数は、[action_layer.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/action_layer.h) で見つけることができます。
## 関数 :id=functions
## 関数 {#functions}
レイヤーの使用あるいは操作に関係する多くの関数(と変数)があります。

2
docs/ja/feature_led_indicators.md
View File

@ -29,7 +29,7 @@ LED の状態を `uint8_t` として提供する2つの非推奨の関数があ
* `uint8_t led_set_user(uint8_t usb_led)`
* `uint8_t host_keyboard_leds()`
## 設定オプション :id=configuration-options
## 設定オプション {#configuration-options}
インジケータを設定するには、`config.h` で以下の `#define` をします:

2
docs/ja/feature_macros.md
View File

@ -214,7 +214,7 @@ SEND_STRING(".."SS_TAP(X_END));
```
## 高度なマクロ関数 :id=advanced-macro-functions
## 高度なマクロ関数 {#advanced-macro-functions}
マクロの生成に役立つ関数が幾つかあります。マクロの中にかなり高度なコードを書くことができますが、機能が複雑になりすぎる場合は、代わりにカスタムキーコードを定義することをお勧めします。マクロはシンプルにしなければなりません。

2
docs/ja/feature_pointing_device.md
View File

@ -1,4 +1,4 @@
# ポインティングデバイス :id=pointing-device
# ポインティングデバイス {#pointing-device}
<!---
original document: 0.12.41:docs/feature_pointing_device.md

26
docs/ja/feature_ps2_mouse.md
View File

@ -1,4 +1,4 @@
# PS/2 マウスサポート :id=ps2-mouse-support
# PS/2 マウスサポート {#ps2-mouse-support}
<!---
original document: 0.13.17:docs/feature_ps2_mouse.md
@ -11,7 +11,7 @@ PS/2 マウス (例えばタッチパッドあるいはトラックポイント)
PS/2 デバイスの接続は、USART(最善)、割り込み(次善)、 または busywait(非推奨)の3つのやり方が有ります。
## トラックポイントとコントローラ間の回路 :id=the-circuitry-between-trackpoint-and-controller
## トラックポイントとコントローラ間の回路 {#the-circuitry-between-trackpoint-and-controller}
動作させるには、DATA と CLK のふたつのラインを 4.7k の抵抗で 5V にプルアップしてやる必要があります。
@ -28,7 +28,7 @@ MODULE 5+ --------+--+--------- PWR CONTROLLER
```
## Busywait バージョン :id=busywait-version
## Busywait バージョン {#busywait-version}
注意: これは非推奨です。ギクシャクした動きや、未送信の入力が発生するかもしれません。可能であれば、割り込みまたは USART バージョンを使ってください。
@ -49,7 +49,7 @@ PS2_DRIVER = busywait
#endif
```
## 割り込みバージョン :id=interrupt-version
## 割り込みバージョン {#interrupt-version}
以下の例はクロックのために D2 を、データのために D5 を使います。クロックには任意の INT あるいは PCINT ピンを、データには任意のピンを使うことができます。
@ -82,7 +82,7 @@ PS2_DRIVER = interrupt
#endif
```
## USART バージョン :id=usart-version
## USART バージョン {#usart-version}
ATMega32u4 で USART を使うには、クロックのために PD5 を、データのために PD2 を使う必要があります。それらのいずれかが利用できない場合は、割り込みバージョンを使う必要があります。
@ -134,9 +134,9 @@ PS2_DRIVER = usart
#endif
```
## 追加の設定 :id=additional-settings
## 追加の設定 {#additional-settings}
### PS/2 マウス機能 :id=ps2-mouse-features
### PS/2 マウス機能 {#ps2-mouse-features}
以下の PS/2 マウスプロトコルによってサポートされる設定を有効にします。
@ -177,7 +177,7 @@ void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);
void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
```
### 細かい調整 :id=fine-control
### 細かい調整 {#fine-control}
マウスの感度と速度を変更するには以下の定義を使います。
注意: 同じ効果のために `ps2_mouse_set_resolution` も使うことができます (ほとんどのタッチパッドではサポートされません)。
@ -188,7 +188,7 @@ void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
#define PS2_MOUSE_V_MULTIPLIER 1
```
### スクロールボタン :id=scroll-button
### スクロールボタン {#scroll-button}
トラックポイントを使っている場合は、スクロールのためにそれを使えるようにしたいでしょう。
押された時にマウスを移動させる代わりにスクロールさせる「スクロールボタン」を有効にすることができます。
@ -235,7 +235,7 @@ void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
#define PS2_MOUSE_SCROLL_DIVISOR_V 2
```
### マウスとスクロールの軸の反転 :id=invert-mouse-and-scroll-axes
### マウスとスクロールの軸の反転 {#invert-mouse-and-scroll-axes}
X 軸と Y 軸を反転するには、以下を config.h に配置します:
@ -251,7 +251,7 @@ X 軸と Y 軸を反転するには、以下を config.h に配置します:
#define PS2_MOUSE_INVERT_V
```
### マウスの軸の回転 :id=rotate-mouse-axes
### マウスの軸の回転 {#rotate-mouse-axes}
デバイスの出力を時計回りに 90 か 180 か 270 度変換します。
@ -267,7 +267,7 @@ X 軸と Y 軸を反転するには、以下を config.h に配置します:
#define PS2_MOUSE_ROTATE 90 /* 西向きのデバイスの向きの補正*/
```
### デバッグ設定 :id=debug-settings
### デバッグ設定 {#debug-settings}
マウスをデバッグするには、`debug_mouse = true` を追加するか、ブートマジックを使って有効にします。
@ -277,7 +277,7 @@ X 軸と Y 軸を反転するには、以下を config.h に配置します:
#define PS2_MOUSE_DEBUG_RAW
```
### 動作フック :id=movement-hook
### 動作フック {#movement-hook}
ホストに送信される前にキーマップでマウスの動作を処理します。使用例として、
ノイズのフィルタリング、加速の追加、レイヤーの自動アクティブ化が含まれます。

18
docs/ja/feature_stenography.md
View File

@ -1,4 +1,4 @@
# QMK での速記 :id=stenography-in-qmk
# QMK での速記 {#stenography-in-qmk}
<!---
original document: 0.13.15:docs/feature_stenography.md
@ -9,13 +9,13 @@
[Open Steno Project](https://www.openstenoproject.org/)は、速記ストロークを単語とコマンドにリアルタイムに変換する Plover と呼ばれるオープンソースプログラムを構築しました。確立された辞書とサポートがあります。
## QWERTY キーボードを使った Plover :id=plover-with-qwerty-keyboard
## QWERTY キーボードを使った Plover {#plover-with-qwerty-keyboard}
Plover は全ての標準的な QWERTY キーボードで動作しますが、キーボードが NKRO (n-キーロールオーバー)をサポートする場合は Plover は一度に押された全てのキーが分かるためより効率的です。Plover 用のキーマップの例は `planck/keymaps/default` で見つかります。`PLOVER` レイヤーに切り替えると、数字バーをサポートするためにキーボードの位置が調整されます。
QMK で Plover を使うには、NKRO を有効にし、標準レイアウト以外のレイアウトの場合はオプションでレイアウトを調整します。複数のキーを押しやすくするために、なんらかの速記フレンドリなキーキャップを購入することもできます。
## 速記プロトコルを使った Plover :id=plover-with-steno-protocol
## 速記プロトコルを使った Plover {#plover-with-steno-protocol}
Plover は幾つかの速記マシンの言語も理解します。QMK はこれらの言語の内2つの言語、TX Bolt と GeminiPR を話すことができます。レイアウトの例は `planck/keymaps/steno` で見つけることができます。
@ -25,15 +25,15 @@ QMKが steno プロトコルを使って Plover と話す場合は、Plover は
> 注意: ハードウェアの制限により、仮想シリアルポートとマウスエミュレーションの両方を同時に実行することができないかもしれません。
### TX Bolt :id=tx-bolt
### TX Bolt {#tx-bolt}
TX Bolt は可変サイズ(1-5バイト)のパケットで非常に単純なプロトコルを介して24個のキーのステータスを通信します。
### GeminiPR :id=geminipr
### GeminiPR {#geminipr}
GeminiPR は42個のキーを6バイトのパケットにエンコードします。TX Bolt は標準的な速記に必要な全てを含んでいますが、GeminiPR は英語以外の速記法のサポートを含む、より多くのオプションにも開け放たれています。
## 速記のための QMK の設定 :id=configuring-qmk-for-steno
## 速記のための QMK の設定 {#configuring-qmk-for-steno}
最初にキーマップの Makefile で速記を有効にします。競合を避けるために、マウスキー、追加キーあるいはその他の USB エンドポイントを無効にする必要もあります。幾つかのプロセッサの内蔵の USB スタックは一定数の USB エンドポイントと仮想シリアルポートのみをサポートし、速記はそれらのうちの3つを使います。
@ -54,13 +54,13 @@ void eeconfig_init_user() {
ディスプレイタブで 'Open stroke display' をクリックします。Plover を無効にすると、キーボードのキーを押すとストローク表示ウィンドウにそれらが表示されるはずです。これを使ってキーマップが正しくセットアップされたことを確認してください。これで速記をする準備ができました！
## 速記の学習 :id=learning-stenography
## 速記の学習 {#learning-stenography}
* [Learn Plover!](https://sites.google.com/site/learnplover/)
* [Steno Jig](https://joshuagrams.github.io/steno-jig/)
* Plover [Learning Stenography](https://github.com/openstenoproject/plover/wiki/Learning-Stenography) wiki のより多くのリソース
## コードとのインターフェイス :id=interfacing-with-the-code
## コードとのインターフェイス {#interfacing-with-the-code}
速記コードには3つの捕捉可能なフックがあります。これらの関数を定義した場合、処理の特定のポイントでそれらが呼び出されます; それらが true を返す場合処理が継続され、そうでなければあなたが物事を処理すると想定します。
@ -83,7 +83,7 @@ bool post_process_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t
この関数はキーが処理された後、ただしコードを送信するかどうかを決める前に呼び出されます。`IS_PRESSED(record->event)` が false で、`pressed` が 0 または 1 の場合は、コードはまもなく送信されますが、まだ送信されてはいません。ここが速記コードあるいはキーのライブ表示などのフックを配置する場所です。
## キーコードリファレンス :id=keycode-reference
## キーコードリファレンス {#keycode-reference}
`keymap_steno.h` で定義されています。

24
docs/ja/feature_tap_dance.md
View File

@ -5,13 +5,13 @@
git diff 0.13.15 HEAD -- docs/feature_tap_dance.md | cat
-->
## イントロダクション :id=introduction
## イントロダクション {#introduction}
セミコロンキーを1回叩くと、セミコロンが送信されます。2回素早く叩くと、コロンが送信されます。3回叩くと、あなたのキーボードのLEDが激しく踊るように明滅します。これは、タップダンスでできることの一例です。それは、コミュニティが提案したとても素敵なファームウェアの機能の1つで、[algernon](https://github.com/algernon) がプルリクエスト [#451](https://github.com/qmk/qmk_firmware/pull/451) で考えて作ったものです。algernon が述べる機能は次の通りです:
この機能を使うと、特定のキーが、タップした回数に基づいて異なる振る舞いをします。そして、割り込みがあった時は、割り込み前に上手く処理されます。
## タップダンスの使い方 :id=how-to-use
## タップダンスの使い方 {#how-to-use}
最初に、あなたの `rules.mk` ファイルで `TAP_DANCE_ENABLE = yes` と設定する必要があります。なぜならば、デフォルトでは無効になっているからです。これでファームウェアのサイズが1キロバイトほど増加します。
オプションで、あなたの `config.h` ファイルに次のような設定を追加して、`TAPPING_TERM` の時間をカスタマイズしたほうが良いです。
@ -50,7 +50,7 @@
最後に、5番目のオプションは、もし、タップダンスキーをコードに追加した後、非タップダンスキーが奇妙な振る舞いを始めた時に特に役に立ちます。ありうる問題は、あなたがタップダンスキーを使いやすくするために `TAPPING_TERM` の時間を変更した結果、その他のキーが割り込みを処理する方法が変わってしまったというものです。
## 実装の詳細 :id=implementation
## 実装の詳細 {#implementation}
さて、説明の大部分はここまでです！ 以下に挙げているいくつかの例に取り組むことができるようになり、あなた自身のタップダンスの機能を開発できるようになります。しかし、もし、あなたが裏側で起きていることをより深く理解したいのであれば、続けてそれが全てどのように機能するかの説明を読みましょう！
@ -66,9 +66,9 @@
柔軟性のために、タップダンスは、キーコードの組み合わせにも、ユーザー関数にもなることができます。後者は、より高度なタップ回数の制御や、LED を点滅させたり、バックライトをいじったり、等々の制御を可能にします。これは、1つの共用体と、いくつかの賢いマクロによって成し遂げられています。
## 実装例 :id=examples
## 実装例 {#examples}
### シンプルな実装例 :id=simple-example
### シンプルな実装例 {#simple-example}
ここに1つの定義のための簡単な例があります。
@ -96,7 +96,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
};
```
### 複雑な実装例 :id=complex-examples
### 複雑な実装例 {#complex-examples}
このセクションでは、いくつかの複雑なタップダンスの例を詳しく説明します。
例で使われている全ての列挙型はこのように宣言します。
@ -111,7 +111,7 @@ enum {
X_TAP_DANCE
};
```
#### 例1: 1回タップすると `:` を送信し、2回タップすると `;` を送信する :id=example-1
#### 例1: 1回タップすると `:` を送信し、2回タップすると `;` を送信する {#example-1}
```c
void dance_cln_finished(qk_tap_dance_state_t *state, void *user_data) {
@ -136,7 +136,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
};
```
#### 例2: 100回タップした後に "Safety Dance!" を送信します :id=example-2
#### 例2: 100回タップした後に "Safety Dance!" を送信します {#example-2}
```c
void dance_egg(qk_tap_dance_state_t *state, void *user_data) {
@ -151,7 +151,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
};
```
#### 例3: 1つずつ LED を点灯させてから消灯する :id=example-3
#### 例3: 1つずつ LED を点灯させてから消灯する {#example-3}
```c
// タップする毎に、LED を右から左に点灯します。
@ -201,7 +201,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
};
```
#### 例4: クアッドファンクションのタップダンス :id=example-4
#### 例4: クアッドファンクションのタップダンス {#example-4}
[DanielGGordon](https://github.com/danielggordon) によるもの
@ -346,7 +346,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
> この設定の "hold" は、タップダンスのタイムアウト（`ACTION_TAP_DANCE_FN_ADVANCED_TIME` 参照）の **後** に起こります。即座に "hold" を得るためには、条件から `state->interrupted` の確認を除きます。結果として、複数回のタップのための時間をより多く持つことで快適な長いタップの期限を使うことができ、そして、"hold" のために長く待たないようにすることができます(2倍の `TAPPING TERM` で開始してみてください)。
#### 例5: タップダンスを高度なモッドタップとレイヤータップキーに使う :id=example-5
#### 例5: タップダンスを高度なモッドタップとレイヤータップキーに使う {#example-5}
タップダンスは、タップされたコードが基本的なキーコード以外の場合に、 `MT()` と `LT()` マクロをエミュレートするのに利用できます。これは、通常 `Shift` を必要とする '(' や '{' のようなキーや、`Control + X` のように他の修飾されたキーコードをタップされたキーコードとして送信することに役立ちます。
@ -432,7 +432,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
それぞれのタップダンスキーコードをキーマップに含めるときは、`TD()` マクロでキーコードをラップします。例: `TD(ALT_LP)`
#### 例6: タップダンスを一時的なレイヤー切り替えとレイヤートグルキーに使う :id=example-6
#### 例6: タップダンスを一時的なレイヤー切り替えとレイヤートグルキーに使う {#example-6}
タップダンスは、MO(layer) と TG(layer) 機能を模倣することにも使用できます。この例では、1回タップすると `KC_QUOT` 、1回押してそのまま押し続けたら `MO(_MY_LAYER)` 、2回タップしたときは `TG(_MY_LAYER)` として機能するキーを設定します。

12
docs/ja/feature_unicode.md
View File

@ -15,7 +15,7 @@ Unicode 文字はキーボードから直接入力することができます！
4. キーマップに Unicode キーコードを追加します。
## 1. メソッド :id=methods
## 1. メソッド {#methods}
QMK は、Unicode 入力を有効にし、キーマップに Unicode 文字を追加するための3つの異なる方法をサポートします。それぞれに柔軟性と使いやすさの点で長所と短所があります。あなたの使い方に最適なものを選んでください。
@ -23,7 +23,7 @@ QMK は、Unicode 入力を有効にし、キーマップに Unicode 文字を
<br />
### 1.1. Basic Unicode :id=basic-unicode
### 1.1. Basic Unicode {#basic-unicode}
多少制限はありますが、最も使いやすい方法です。Unicode 文字をキーコードとしてキーマップ自体に格納するため、`0x7FFF` までのコードポイントのみをサポートします。これは、ほとんどの現代言語(東アジアを含む)の文字と記号を対象としますが、絵文字は対象外です。
@ -37,7 +37,7 @@ UNICODE_ENABLE = yes
<br />
### 1.2. Unicode Map :id=unicode-map
### 1.2. Unicode Map {#unicode-map}
このメソッドは、標準の文字の範囲に加えて、絵文字、古代文字、珍しい記号なども対象にしています。実際、可能な全てのコードポイント(`0x10FFFF`まで)がサポートされています。Unicode 文字は独立のマッピングテーブルに格納されています。キーマップファイルに `unicode_map` 配列を維持する必要があります。これには最大 16384 エントリを含めることができます。
@ -75,7 +75,7 @@ const uint32_t PROGMEM unicode_map[] = {
<br />
### 1.3. UCIS :id=ucis
### 1.3. UCIS {#ucis}
この方法も全ての可能なコードポイントをサポートします。Unicode Map の方法と同様に、キーマップファイル内にマッピングテーブルを保持する必要があります。ただし、この機能のための組み込みのキーコードはありません — この機能を起動するカスタムキーコードあるいは関数を作成する必要があります。
@ -111,7 +111,7 @@ UCIS 入力を使うには、`qk_ucis_start()` を呼び出します。次に、
[`process_ucis.c`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_ucis.c) でこれらの関数のデフォルトの実装を見つけることができます。
## 2. Input モード :id=input-modes
## 2. Input モード {#input-modes}
QMK での Unicode の入力は、マクロのように、OS への一連の文字列を入力することで動作します。残念ながら、これが行われる方法はプラットフォームによって異なります。特に各プラットフォームでは Unicode 入力を引き起こすために、異なるキーの組み合わせが必要です。従って、対応する入力モードが QMK で設定されなければなりません。
@ -152,7 +152,7 @@ _Unicode 16進数入力_ 入力ソースの使用は、Option + 左矢印およ
デフォルトでは、このモードは Compose キーとして右 Alt (`KC_RALT`) を使いますが、これは WinCompose 設定と他のキーで [`UNICODE_KEY_WINC`](#input-key-configuration) を定義することで変更できます。
## 3. 入力モードの設定 :id=setting-the-input-mode
## 3. 入力モードの設定 {#setting-the-input-mode}
目的の入力モードを設定するには、以下の定義を `config.h` に追加します:

4
docs/ja/feature_userspace.md
View File

@ -61,7 +61,7 @@ ifdef RGB_ENABLE
endif
```
### デフォルトのユーザスペースの上書き :id=override-default-userspace
### デフォルトのユーザスペースの上書き {#override-default-userspace}
デフォルトでは、使用されるユーザスペース名はキーマップ名と同じです。状況によってはこれは望ましくありません。例えば、[レイアウト](ja/feature_layouts.md)機能を使う場合、異なるキーマップに同じ名前 (例えば、ANSI および ISO) を使うことができません。レイアウトに `mylayout-ansi` や `mylayout-iso` という名前を付け、以下の行をレイアウトの `rules.mk` に追加します:
@ -124,7 +124,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
より複雑な例については、[`/users/drashna/`](https://github.com/qmk/qmk_firmware/tree/master/users/drashna) のユーザスペースを調べてください。
### カスタマイズされた関数 :id=customized-functions
### カスタマイズされた関数 {#customized-functions}
QMK には、[`_quantum`、`_kb` および `_user` バージョン](ja/custom_quantum_functions.md#a-word-on-core-vs-keyboards-vs-keymap)を持つ使用可能な[関数](custom_quantum_functions.md)が山ほどあります。 ほとんどの場合、これらの関数のユーザバージョンを使う必要があります。しかし問題はそれらをユーザスペースで使う場合、キーマップで使うことができるバージョンが無いことです。

8
docs/ja/gpio_control.md
View File

@ -1,4 +1,4 @@
# GPIO 制御 :id=gpio-control
# GPIO 制御 {#gpio-control}
<!---
original document: 0.13.15:docs/gpio_control.md
@ -7,7 +7,7 @@
QMK には、マイクロコントローラに依存しない GPIO 制御抽象レイヤーがあります。これは異なるプラットフォーム間でピン制御に簡単にアクセスできるようにするためのものです。
## 関数 :id=functions
## 関数 {#functions}
以下の関数は GPIO の基本的な制御を提供し、`quantum/quantum.h` にあります。
@ -23,11 +23,11 @@ QMK には、マイクロコントローラに依存しない GPIO 制御抽象
| `readPin(pin)` | ピンのレベルを返す | `_SFR_IO8(pin >> 4) & _BV(pin & 0xF)` | `palReadLine(pin)` |
| `togglePin(pin)` | ピンレベルを反転 (ピンを出力として設定してあると仮定) | `PORTB ^= (1<<2)` | `palToggleLine(pin)` |
## 高度な設定 :id=advanced-settings
## 高度な設定 {#advanced-settings}
各マイクロコントローラは GPIO に関して複数の高度な設定を持つことができます。この抽象レイヤーは、アーキテクチャー固有の機能の使用法を制限しません。上級ユーザは、目的のデバイスのデータシートを参照し、必要なライブラリを含めてください。AVR については、標準 avr/io.h ライブラリが使われます; STM32 については ChibiOS [PAL ライブラリ](https://chibios.sourceforge.net/docs3/hal/group___p_a_l.html)が使われます。
## アトミック操作 :id=atomic-operation
## アトミック操作 {#atomic-operation}
上記の関数は、必ずしもアトミックに動作することが保証されているわけではありません。そのため、上記の関数を複数組み合わせて使用する際に、操作の途中での割り込みを防ぎたい場合は、以下の `ATOMIC_BLOCK_FORCEON` マクロを使用してください。

22
docs/ja/i2c_driver.md
View File

@ -1,4 +1,4 @@
# I2C マスタドライバ :id=i2c-master-driver
# I2C マスタドライバ {#i2c-master-driver}
<!---
grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
@ -8,7 +8,7 @@
QMK で使われる I2C マスタドライバには、MCU 間のポータビリティを提供するための一連の関数が用意されています。
## I2C アドレスについての重要なメモ :id=note-on-i2c-addresses
## I2C アドレスについての重要なメモ {#note-on-i2c-addresses}
このドライバが期待する全てのアドレスは、アドレスバイトの上位7ビットにプッシュする必要があります。最下位ビットの設定(読み込み/書き込みを示す)は、それぞれの関数によって行われます。データシートやインターネットで列挙されているほとんど全ての I2C アドレスは、下位7ビットを占める7ビットとして表され、1ビット左(より上位)にシフトする必要があります。これは、ビット単位のシフト演算子 `<< 1` を使用して簡単に実行できます。
@ -18,7 +18,7 @@ QMK で使われる I2C マスタドライバには、MCU 間のポータビリ
I2C アドレスと他の技術詳細について、さらなる情報を得るためには https://www.robot-electronics.co.uk/i2c-tutorial を見てください。
## 使用できる関数 :id=available-functions
## 使用できる関数 {#available-functions}
| 関数 | 説明 |
|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@ -30,7 +30,7 @@ I2C アドレスと他の技術詳細について、さらなる情報を得る
| `i2c_status_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` | `i2c_receive` と同様ですが、 `regaddr` でスレーブのデータ読み込み先のレジスタを指定します。 |
| `i2c_status_t i2c_stop(void);` | I2C トランザクションを終了します。 |
### 関数の戻り値 :id=function-return
### 関数の戻り値 {#function-return}
`void i2c_init(void)` を除く上にあるすべての関数は、次の真理値表にある値を返します。
@ -40,9 +40,9 @@ I2C アドレスと他の技術詳細について、さらなる情報を得る
|`I2C_STATUS_ERROR` |-1 |処理に失敗しました。 |
|`I2C_STATUS_TIMEOUT`|-2 |処理がタイムアウトしました。|
## AVR :id=avr
## AVR {#avr}
### 設定 :id=avr-configuration
### 設定 {#avr-configuration}
I2Cマスタドライバを設定するために、次の定義が使えます。
@ -53,11 +53,11 @@ I2Cマスタドライバを設定するために、次の定義が使えます
AVR は通常 I2C ピンとして使う GPIO が設定されているので、これ以上の設定は必要ありません。
## ARM :id=arm
## ARM {#arm}
ARM の場合は、内部に ChibiOS I2C HAL ドライバがあります。この節では STM32 MCU を使用していると仮定します。
### 設定 :id=arm-configuration
### 設定 {#arm-configuration}
ARM MCU 用の設定はしばしば非常に複雑です。これは、多くの場合複数の I2C ドライバをさまざまなポートに対して割り当てられるためです。
@ -89,7 +89,7 @@ ChibiOS I2C ドライバの設定項目は STM32 MCU の種類に依存します
STM32F1xx, STM32F2xx, STM32F4xx, STM32L0xx, STM32L1xx では I2Cv1 が使われます。
STM32F0xx, STM32F3xx, STM32F7xx, STM32L4xx では I2Cv2 が使われます。
#### I2Cv1 :id=i2cv1
#### I2Cv1 {#i2cv1}
STM32 MCU の I2Cv1 では、クロック周波数とデューティ比を次の変数で変更できます。詳しくは <https://www.playembedded.org/blog/stm32-i2c-chibios/#I2Cv1_configuration_structure> を参照してください。
@ -99,7 +99,7 @@ STM32 MCU の I2Cv1 では、クロック周波数とデューティ比を次の
| `I2C1_CLOCK_SPEED` | `100000` |
| `I2C1_DUTY_CYCLE` | `STD_DUTY_CYCLE` |
#### I2Cv2 :id=i2cv2
#### I2Cv2 {#i2cv2}
STM32 MCU の I2Cv2 では、信号のタイミングパラメータを次の変数で変更できます。詳しくは <https://www.st.com/en/embedded-software/stsw-stm32126.html> を参照してください。
@ -118,7 +118,7 @@ STM32 MCU では GPIO ピンを設定するとき、別の「代替機能」モ
| `I2C1_SCL_PAL_MODE` | `4` |
| `I2C1_SDA_PAL_MODE` | `4` |
#### その他 :id=other
#### その他 {#other}
`void i2c_init(void)` 関数は `weak` 属性が付いており、オーバーロードすることができます。この場合、上記で設定した変数は使用されません。可能な GPIO の設定については、 MCU のデータシートを参照してください。次に示すのは初期化関数の例です：

44
docs/ja/keycodes.md
View File

@ -9,7 +9,7 @@
このページは参照のみです。それぞれのキーの種類毎のリンク先のページに、それぞれのキーの機能についてもっと詳細に記載しています。
## 基本的なキーコード :id=basic-keycodes
## 基本的なキーコード {#basic-keycodes}
[基本的なキーコード](ja/keycodes_basic.md) も見てください。
@ -231,7 +231,7 @@
<sup>5. iTunes では、タップすると1曲全体がスキップされます。押していると曲の中で早送り/巻き戻しになります。</sup><br/>
<sup>6. Windows Media Player は巻き戻しキーを識別しませんが、VLC では早送り/巻き戻しキーで再生速度が変更されます。</sup>
## Quantum キーコード :id=quantum-keycodes
## Quantum キーコード {#quantum-keycodes}
[Quantum キーコード](ja/quantum_keycodes.md#qmk-keycodes) も見てください。
@ -241,7 +241,7 @@
|`QK_DEBUG_TOGGLE`|`DB_TOGG`|デバッグモードを切り替えます |
|`QK_CLEAR_EEPROM`|`EE_CLR` |キーボードの EEPROM (不揮発メモリ) を再初期化します |
## オーディオキー :id=audio-keys
## オーディオキー {#audio-keys}
[オーディオ](ja/feature_audio.md) も見てください。
@ -259,7 +259,7 @@
|`MU_TOG` | |音楽モードを切り替えます |
|`MU_MOD` | |音楽モードを循環します |
## バックライト :id=backlighting
## バックライト {#backlighting}
[バックライト](ja/feature_backlight.md) も見てください。
@ -273,7 +273,7 @@
|`BL_DEC` |バックライトのレベルを下げる |
|`BL_BRTG`|バックライトの明滅動作を切り替える |
## ブートマジック :id=bootmagic
## ブートマジック {#bootmagic}
[ブートマジック](ja/feature_bootmagic.md) も見てください。
@ -309,7 +309,7 @@
| `MAGIC_EE_HANDS_LEFT` | `EH_LEFT` | 分割キーボードのマスター側を左手に設定(`EE_HANDS` 用) |
| `MAGIC_EE_HANDS_RIGHT` | `EH_RGHT` | 分割キーボードのマスター側を右手に設定(`EE_HANDS` 用) |
## Bluetooth :id=bluetooth
## Bluetooth {#bluetooth}
[Bluetooth](ja/feature_bluetooth.md) も見てください。
@ -320,7 +320,7 @@
|`OUT_USB` |USB のみ |
|`OUT_BT` |Bluetooth のみ |
## 動的マクロ :id=dynamic-macros
## 動的マクロ {#dynamic-macros}
[動的マクロ](ja/feature_dynamic_macros.md) も見てください。
@ -332,7 +332,7 @@
|`DYN_MACRO_PLAY2`|`DM_PLY2`|マクロ 2 を再生します |
|`DYN_REC_STOP` |`DM_RSTP`|現在記録中のマクロの記録を終了します |
## グレイブエスケープ :id=grave-escape
## グレイブエスケープ {#grave-escape}
[グレイブエスケープ](ja/feature_grave_esc.md) も見てください。
@ -340,7 +340,7 @@
|-----------|---------|------------------------------------------------------------------|
|`GRAVE_ESC`|`KC_GESC`|押された場合に Escape。Shift あるいは GUI が押されたままの場合は <code>&#96;</code>|
## キーロック :id=key-lock
## キーロック {#key-lock}
[キーロック](ja/feature_key_lock.md) も見てください。
@ -348,7 +348,7 @@
|---------|--------------------------------------------------|
|`KC_LOCK`|キーが再び押されるまで次のキーを押したままにします |
## レイヤー切り替え :id=layer-switching
## レイヤー切り替え {#layer-switching}
[レイヤー切り替え](ja/feature_layers.md#switching-and-toggling-layers) も見てください。
@ -363,7 +363,7 @@
|`TO(layer)` |`layer` をオンにして、デフォルトレイヤーを除く他のレイヤーをオフにします。 |
|`TT(layer)` |複数回タップしない限り `MO` のように動作し、複数回タップすると `layer` をオンにトグルします。 |
## リーダーキー :id=leader-key
## リーダーキー {#leader-key}
[リーダーキー](ja/feature_leader_key.md) も見てください。
@ -371,7 +371,7 @@
|---------|-------------------------------|
|`KC_LEAD`|リーダーキーのシーケンスを開始 |
## マウスキー :id=mouse-keys
## マウスキー {#mouse-keys}
[マウスキー](ja/feature_mouse_keys.md) も見てください。
@ -394,7 +394,7 @@
|`KC_MS_ACCEL1` |`KC_ACL1`|速度を1に設定 |
|`KC_MS_ACCEL2` |`KC_ACL2`|速度を2に設定 |
## 修飾キー :id=modifiers
## 修飾キー {#modifiers}
[修飾キー](ja/feature_advanced_keycodes.md#modifier-keys) も見てください。
@ -420,7 +420,7 @@
| `KC_HYPR` | | 左 Control、Shift、Alt、GUI |
## モッドタップキー :id=mod-tap-keys
## モッドタップキー {#mod-tap-keys}
[モッドタップキー](ja/mod_tap.md) も見てください。
@ -446,7 +446,7 @@
| `MEH_T(kc)` | | 押したままの場合は左 Control、Shift、Alt、タップした場合は `kc` |
| `HYPR_T(kc)` | `ALL_T(kc)` | 押したままの場合は左 Control、Shift、Alt、GUI、タップした場合は `kc` - より詳しくは[ここ](https://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)を見てください |
## RGB ライト :id=rgb-lighting
## RGB ライト {#rgb-lighting}
[RGB ライト](ja/feature_rgblight.md) も見てください。
@ -471,7 +471,7 @@
|`RGB_MODE_GRADIENT`|`RGB_M_G` |固定階調アニメーションモード |
|`RGB_MODE_RGBTEST` |`RGB_M_T` |赤、緑、青のテストアニメーションモード |
## RGB マトリックスライト :id=rgb-matrix-lighting
## RGB マトリックスライト {#rgb-matrix-lighting}
[RGB マトリックスライト](ja/feature_rgb_matrix.md) も見てください。
@ -489,7 +489,7 @@
|`RGB_SPI` | |エフェクトのスピード (EEPROM はまだサポートしていません) を増加させ、Shift を押していると減少させます。 |
|`RGB_SPD` | |エフェクトのスピード (EEPROM はまだサポートしていません) を減少させ、Shift を押していると増加させます。 |
## 感熱式プリンタ :id=thermal-printer
## 感熱式プリンタ {#thermal-printer}
[感熱式プリンタ](ja/feature_thermal_printer.md) も見てください。
@ -498,7 +498,7 @@
|`PRINT_ON` |ユーザが入力した全ての印刷を開始 |
|`PRINT_OFF`|ユーザが入力した全ての印刷を停止 |
## US ANSI シフト済シンボル :id=us-ansi-shifted-symbols
## US ANSI シフト済シンボル {#us-ansi-shifted-symbols}
[US ANSI シフト済シンボル](ja/keycodes_us_ansi_shifted.md) も見てください。
@ -526,7 +526,7 @@
|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` |
|`KC_QUESTION` |`KC_QUES` |`?` |
## ワンショットキー :id=one-shot-keys
## ワンショットキー {#one-shot-keys}
[ワンショットキー](ja/one_shot_keys.md) も見てください。
@ -535,7 +535,7 @@
|`OSM(mod)` | 次のキーが押されるまで、`mod` を押したままにします |
|`OSL(layer)`| 次のキーが押されるまで、一時的にレイヤーをアクティブにします |
## Space Cadet :id=space-cadet
## Space Cadet {#space-cadet}
[Space Cadet](ja/feature_space_cadet.md) も見てください。
@ -549,7 +549,7 @@
|`KC_RAPC` |押したままの場合は右 Alt、タップした場合は `)`、 |
|`KC_SFTENT`|押したままの場合は右 Shift、タップした場合は Enter |
## スワップハンド :id=swap-hands
## スワップハンド {#swap-hands}
[スワップハンド](ja/feature_swap_hands.md) も見てください。
@ -564,7 +564,7 @@
| `SH_TT` | タップで切り替える。押している時に一時的に切り替える。 |
| `SH_OS` | ワンショットスワップハンド: 押している時あるいは次のキーを押すまで切り替える。 |
## ユニコードサポート :id=unicode-support
## ユニコードサポート {#unicode-support}
[ユニコードサポート](ja/feature_unicode.md) も見てください。

8
docs/ja/keymap.md
View File

@ -8,7 +8,7 @@
QMK のキーマップは C のソースファイルの中で定義されます。そのデータ構造は配列の配列です。外側はレイヤーを要素とする配列で、レイヤーはキーを要素とする配列。ほとんどのキーボードは `LAYOUT()` マクロを定義して、この配列の配列を作成しやすくしています。
## キーマップとレイヤー :id=keymap-and-layers
## キーマップとレイヤー {#keymap-and-layers}
QMKでは、**`const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]`**は、**アクションコード**を保持している **16 bit** データの中でキーマップ情報の複数の**レイヤー**を保持します。最大で**32個のレイヤー**を定義することができます。
普通のキー定義の場合、**アクションコード**の上位8ビットは全て0で、下位8ビットは**キーコード**としてキーによって生成された USB HID usage コードを保持します。
@ -32,7 +32,7 @@ QMKでは、**`const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]`**は
TMK の歴史的経緯から、キーマップに保存されたアクションコードは、一部のドキュメントではキーコードと呼ばれる場合があります。
### キーマップレイヤーステータス :id=keymap-layer-status
### キーマップレイヤーステータス {#keymap-layer-status}
キーマップレイヤーの状態は、2つの32ビットパラメータによって決定されます。
@ -102,7 +102,7 @@ TMK の歴史的経緯から、キーマップに保存されたアクション
* [定義](#definitions)
* [レイヤー/キーマップデータ構造](#layers-and-keymaps)
### 定義 :id=definitions
### 定義 {#definitions}
ファイルの上部に以下のものがあります:
@ -131,7 +131,7 @@ TMK の歴史的経緯から、キーマップに保存されたアクション
注意: 古いキーマップファイルに `_______` および `XXXXXXX` の定義が含まれているかもしれません。これらはそれぞれ `KC_TRNS` および `KC_NO` の代わりに使うことができ、レイヤーがどのキーを上書きしているかを簡単に確認することができます。これらの定義はデフォルトで含まれるため、今では不要になりました。
### レイヤーとキーマップ :id=layers-and-keymaps
### レイヤーとキーマップ {#layers-and-keymaps}
このファイルの主要部分は `keymaps[]` 定義です。ここで、レイヤーとそれらの内容を列挙します。ファイルのこの部分は、以下の定義から始まります:

2
docs/ja/newbs_building_firmware.md
View File

@ -63,7 +63,7 @@ QMK にはたくさんの機能があり、完全なリストは左側のサイ
:::
## ファームウェアをビルドする :id=build-your-firmware
## ファームウェアをビルドする {#build-your-firmware}
キーマップの変更が完了したら、ファームウェアをビルドする必要があります。これを行うには、ターミナルウィンドウに戻り、コンパイルコマンドを実行します:

2
docs/ja/newbs_flashing.md
View File

@ -103,7 +103,7 @@ QMK Toolbox の `Flash` ボタンをクリックします。次のような出
*** DFU device disconnected: Atmel Corp: ATmega32U4 (03EB:2FF4:0000)
```
## コマンドラインでファームウェアを書き込む :id=flash-your-keyboard-from-the-command-line
## コマンドラインでファームウェアを書き込む {#flash-your-keyboard-from-the-command-line}
これは、以前のものと比較して非常に単純になりました。
ファームウェアをコンパイルして書き込む準備ができたら、ターミナルウィンドウを開いて書き込みコマンドを実行します:

4
docs/ja/newbs_getting_started.md
View File

@ -24,7 +24,7 @@
:::
## 2. ビルド環境を準備する :id=set-up-your-environment
## 2. ビルド環境を準備する {#set-up-your-environment}
私たちは、QMK を可能な限り簡単に構築できるように努力しています。Linux か Unix 環境を用意するだけで、QMK に残りをインストールさせることができます。
@ -137,7 +137,7 @@ AUR から `qmk-git` パッケージを試すこともできます:
<!-- tabs:end -->
## 3. QMK の設定を行う :id=set-up-qmk
## 3. QMK の設定を行う {#set-up-qmk}
<!-- tabs:start -->

2
docs/ja/newbs_git_best_practices.md
View File

@ -1,4 +1,4 @@
# QMK における Git 運用作法 :id=best-git-practices-for-working-with-qmk
# QMK における Git 運用作法 {#best-git-practices-for-working-with-qmk}
<!---
grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh

2
docs/ja/newbs_git_using_your_master_branch.md
View File

@ -52,7 +52,7 @@ git push origin master
これにより、あなたの `master` ブランチに切り替わり、QMK リポジトリから 'refs' を取得し、現在の QMK の `master` ブランチをコンピュータにダウンロードしてから、あなたのフォークにアップロードします。
## 変更を行なう :id=making-changes
## 変更を行なう {#making-changes}
変更するには、以下を入力して新しいブランチを作成します:

20
docs/ja/newbs_learn_more_resources.md
View File

@ -10,35 +10,35 @@
## QMK に関するリソース
### 英語 :id=english-resources-qmk
### 英語 {#english-resources-qmk}
* [Thomas Baart's QMK Basics Blog](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – 新規ユーザーの視点から見た QMK ファームウェアの使い方の基本を網羅した、ユーザー作成のブログ。
### 日本語 :id=japanese-resources-qmk
### 日本語 {#japanese-resources-qmk}
_日本語のリソース情報を募集中です。_
## コマンドラインに関するリソース :id=command-line-resources
## コマンドラインに関するリソース {#command-line-resources}
### 英語 :id=english-resources-cli
### 英語 {#english-resources-cli}
* [Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)
* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br />
* [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
### 日本語 :id=japanese-resources-cli
### 日本語 {#japanese-resources-cli}
_日本語のリソース情報を募集中です。_
## テキストエディタに関するリソース :id=text-editor-resources
## テキストエディタに関するリソース {#text-editor-resources}
どのテキストエディタを使えば良いか分かりませんか？
### 英語 :id=english-resources-text-editor
### 英語 {#english-resources-text-editor}
* [a great introduction to the subject](https://learntocodewith.me/programming/basics/text-editors/)
### 日本語 :id=japanese-resources-text-editor
### 日本語 {#japanese-resources-text-editor}
_日本語のリソース情報を募集中です。_
@ -48,13 +48,13 @@ _日本語のリソース情報を募集中です。_
## Git に関するリソース
### 英語 :id=english-resources-git
### 英語 {#english-resources-git}
* [Great General Tutorial](https://www.codecademy.com/learn/learn-git)
* [Flight Rules For Git](https://github.com/k88hudson/git-flight-rules)
* [Git Game To Learn From Examples](https://learngitbranching.js.org/)
### 日本語 :id=japanese-resources-git
### 日本語 {#japanese-resources-git}
_日本語のリソース情報を募集中です。_

2
docs/ja/newbs_testing_debugging.md
View File

@ -10,6 +10,6 @@
[ここに移動しました](ja/faq_misc.md#testing)
## デバッグ :id=debugging
## デバッグ {#debugging}
[ここに移動しました](ja/faq_debug.md#debugging)

2
docs/ja/quantum_keycodes.md
View File

@ -11,7 +11,7 @@ quantum 内の全てのキーコードは `0x0000` と `0xFFFF` の間の数値
このページでは、高度な quantum 機能を実装するために使われる `0x00FF` と `0xFFFF` の間のキーコードを説明します。独自のカスタムキーコードを定義する場合は、それらもこの範囲に配置されます。
## QMK キーコード :id=qmk-keycodes
## QMK キーコード {#qmk-keycodes}
| キー | エイリアス | 説明 |
|-----------------|---------|--------------------------------------------------------|

2
docs/ja/ref_functions.md
View File

@ -7,7 +7,7 @@
QMK には、信じられないほど便利な、またはあなたが望んでいた機能を少し追加する、隠された関数がたくさんあります。特定の機能に固有の関数はそれぞれの機能のページにあるため、ここには含まれていません。
## (OLKB) トライレイヤー :id=olkb-tri-layers
## (OLKB) トライレイヤー {#olkb-tri-layers}
目的に応じて、実際に使うことができる別個の関数があります。

2
docs/ja/translating.md
View File

@ -18,7 +18,7 @@
```markdown
[建立你的环境](zh-cn/newbs-getting-started.md#set-up-your-environment)
## 建立你的环境 :id=set-up-your-environment
## 建立你的环境 {#set-up-your-environment}
```
新しい言語の翻訳が完了したら、以下のファイルも修正する必要があります:

12
docs/zh-cn/cli.md
View File

@ -1,19 +1,19 @@
# QMK CLI :id=qmk-cli
# QMK CLI {#qmk-cli}
<!---
original document: 0.15.12:docs/cli.md
git diff 0.15.12 HEAD -- docs/cli.md | cat
-->
## 总览 :id=overview
## 总览 {#overview}
QMK CLI可以让构建QMK键盘的过程更轻松一些，我们已提供的一批指令可用于简化及流式化地处理一些常见工作，如获取并编译QMK固件，创建新的键映射等。
### 依赖项 :id=requirements
### 依赖项 {#requirements}
QMK依赖Python 3.6或更高版本。我们已经尽力缩减依赖项，但在[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt)中的依赖项是需安装的包。在安装QMK CLI时这些依赖项也会自动完成安装。
### 通过 Homebrew 安装(macOS 及部分 Linux) :id=install-using-homebrew
### 通过 Homebrew 安装(macOS 及部分 Linux) {#install-using-homebrew}
若已安装[Homebrew](https://brew.sh)，可以按如下方法安装QMK:
@ -23,7 +23,7 @@ export QMK_HOME='~/qmk_firmware' # 可选，指定 `qmk_firmware` 的路径
qmk setup # 拉取 `qmk/qmk_firmware` 并选择性地配置构建环境
```
### 通过 pip 安装 :id=install-using-easy_install-or-pip
### 通过 pip 安装 {#install-using-easy_install-or-pip}
未在以上列出的操作系统可以手动安装QMK。首先确认已安装Python 3.6（或更高版本）及 pip，然后通过如下指令安装QMK：
@ -33,7 +33,7 @@ export QMK_HOME='~/qmk_firmware' # 可选，指定 `qmk_firmware` 的路径
qmk setup # 拉取 `qmk/qmk_firmware` 并选择性地配置构建环境
```
### 其它操作系统的安装包 :id=packaging-for-other-operating-systems
### 其它操作系统的安装包 {#packaging-for-other-operating-systems}
我们正在寻求可以制作维护更多操作系统下可用的 `qmk` 安装包的开发者，若您愿意为您的操作系统制作安装包，请遵循如下指引：

2
docs/zh-cn/cli_commands.md
View File

@ -89,7 +89,7 @@ qmk compile -j <num_jobs> -kb <keyboard_name>
qmk compile -j 0 -kb <keyboard_name>
```
## `qmk flash` :id=qmk-flash
## `qmk flash` {#qmk-flash}
该命令与 `qmk compile` 类似，但额外地可以指定bootloader。bootloader参数是可选的，默认会指定为 `:flash`。可通过 `-bl <bootloader>` 来指定bootloader。请查阅[刷写固件](zh-cn/flashing.md)指引以深入了解可用的bootloader信息。

16
docs/zh-cn/configurator_default_keymaps.md
View File

@ -1,4 +1,4 @@
# 向QMK配置器中添加默认键映射 :id=adding-default-keymaps
# 向QMK配置器中添加默认键映射 {#adding-default-keymaps}
<!---
original document: 0.15.12:docs/configurator_default_keymaps.md
@ -8,7 +8,7 @@
本章节描述了如何向QMK配置器中添加一款键盘的默认键映射
## 技术信息 :id=technical-information
## 技术信息 {#technical-information}
QMK配置器使用JSON作为键映射的本地文件格式。我们尽力确保其行为与在 `qmk_firmware` 中 执行 `make <keyboard>:default` 时一致。
@ -32,7 +32,7 @@ f14629ed1cd7c7ec9089604d64f29a99981558e8 Remove/migrate action_get_macro()s from
本例中，`f14629ed1cd7c7ec9089604d64f29a99981558e8` 即应为 `commit` 的值。
## 示例 :id=example
## 示例 {#example}
若某人想添加H87a Hineybush键盘的默认键映射方案，应到 `qmk_firmware` 下H87a的默认键映射下执行上述 `git log` 命令：
@ -101,9 +101,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
`layers` 数组中的空白区域不影响键映射功能，仅为了方便阅读。
## 附加说明 :id=caveats
## 附加说明 {#caveats}
### 层定义只能通过序号进行引用 :id=layer-references
### 层定义只能通过序号进行引用 {#layer-references}
QMK中常见的一种做法是通过一系列 `#define` 或 `enum` 类型声明来对层定义进行命名：
@ -117,11 +117,11 @@ enum layer_names {
对于C代码来讲可行，但对于配置器来讲，你*必须*使用层序号 - 上例中的`MO(_FN)` 应使用 `MO(2)`。
### 不支持任何形式的定制化代码 :id=custom-code
### 不支持任何形式的定制化代码 {#custom-code}
需要在 keymap.c 文件中添加函数代码的功能，如Tap Dance或是Unicode，都*完全*无法在配置器中构建。即便是在 `qmk_firmware` 代码库中在键盘定义中设置了 `TAP_DANCE_ENABLE = yes`，也只会导致*任何*固件构建在配置器中行不通。这是由API及JSON格式的键映射数据同时造成的限制。
### 对自定义键码的不完全支持 :id=custom-keycodes
### 对自定义键码的不完全支持 {#custom-keycodes}
仅有一个方案可以支持自定义键码：若自定义键码的逻辑实现是在 qmk_firmware 下的键盘定义中完成的，而非在键映射中，那么这个键码*可以*在配置器中使用且*可以*编译运行。（因此，）相对于在 `keymap.c` 中使用如下代码段：
@ -193,6 +193,6 @@ bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
注意最后的 `process_record_user()` 调用，若用户需要添加自定义键码到键映射中，须使用 `NEW_SAFE_RANGE` 替代 `SAFE_RANGE`，而其定义来自于上面键盘层定义中。
## 更多资料 :id=additional-reading
## 更多资料 {#additional-reading}
为了让QMK配置器支持你的键盘，你的键盘定义必须存在于 `qmk_firmware` 代码库的 `master` 分支中。相关操作指引，请参见[在QMK配置器中支持你的键盘](zh-cn/reference_configurator_support.md).

10
docs/zh-cn/contributing.md
View File

@ -26,7 +26,7 @@
* https://opensource.com/life/16/10/how-ask-technical-questions
* http://www.catb.org/esr/faqs/smart-questions.html
# 项目概况 :id=project-overview
# 项目概况 {#project-overview}
QMK很大一部分是C语言编写的，小部分特性是C++的。QMK的设计目标是在键盘上的嵌入式处理器中工作，如AVR([LUFA](https://www.fourwalledcubicle.com/LUFA.php))和ARM ([ChibiOS](https://www.chibios.org))。如果您对Arduino很熟悉的话，会发现优缺点也基本是相似的。但无论你之前是否有Arduino使用经验，都不会影响你参与到QMK贡献中来。
@ -58,14 +58,14 @@ QMK很大一部分是C语言编写的，小部分特性是C++的。QMK的设计
14. 维护人员会通知您要更改什么地方，然后您就按照建议改一改。
15. 你的pull request合并成功了，恭喜！
# 代码规范 :id=coding-conventions
# 代码规范 {#coding-conventions}
我们的编码风格很容易掌握，如果你有C语言或Python编码经验，跟随我们的编码风格不会有什么困难。
* [编码规范 - C](zh-cn/coding_conventions_c.md)
* [编码规范 - Python](zh-cn/coding_conventions_python.md)
# 基本准则 :id=general-guidelines
# 基本准则 {#general-guidelines}
在QMK中存在多种类型的修改需求，因此也会有审查严格性上的差异。请在做出任何修改时留意，你的改动隶属于什么类型。
@ -111,7 +111,7 @@ enum my_keycodes {
};
```
### 预览文档 :id=previewing-the-documentation
### 预览文档 {#previewing-the-documentation}
在发起pull request前，请通过文档预览来检查你的本地更改。可以在 `qmk_firmware/` 目录下执行以下命令来配置文档开发环境：
@ -174,6 +174,6 @@ QMK的最终归宿是键盘。有些键盘是社区维护的，有一些是制
为了保持QMK脉络清晰，QMK的深度重构工作已在规划中，并会通过合作者进行相应的修改。如果你有重构的思路或建议请[创建一个issue](https://github.com/qmk/qmk_firmware/issues), 我们很乐意讨论一下QMK可以如何改进。
# 行为守则对于我来说有何意义？ :id=what-does-the-code-of-conduct-mean-for-me
# 行为守则对于我来说有何意义？ {#what-does-the-code-of-conduct-mean-for-me}
我们的[行为守则](https://qmk.fm/coc/) 指出您有责任尊重并礼貌地对待项目中的每个人，无论他们的身份如何。如果你是我们行为守则所描述的不当行为的受害者，我们将站在你这边，尽最大努力对施暴者进行谴责。

10
docs/zh-cn/custom_quantum_functions.md
View File

@ -9,7 +9,7 @@
本页不要求任何额外的QMK知识基础，但阅读[理解QMK](zh-cn/understanding_qmk.md)将会在更基础的层面帮你理解发生了什么。
## 核心/键盘/键映射的概念 :id=a-word-on-core-vs-keyboards-vs-keymap
## 核心/键盘/键映射的概念 {#a-word-on-core-vs-keyboards-vs-keymap}
QMK基于如下层级组成：
@ -38,7 +38,7 @@ enum my_keycodes {
};
```
## 编程设计你的键码的行为 :id=programming-the-behavior-of-any-keycode
## 编程设计你的键码的行为 {#programming-the-behavior-of-any-keycode}
当你覆盖一个已存在按键的行为时，或是给新按键设计功能时，请使用 `process_record_kb()` 和 `process_record_user()` 函数。QMK会在响应并处理按键事件前调用这些函数，如果这些函数返回值为 `true`，QMK将继续用常规的方式处理键码，这样可以很方便的扩展键码的功能而不需要替换代码实现。如果函数返回`false` QMK会跳过常规的键处理逻辑，需要发送的按键按下或抬起事件则需交由你负责完成。
@ -152,7 +152,7 @@ void keyboard_pre_init_user(void) {
* 键盘/各子版本：`void matrix_init_kb(void)`
* 键映射：`void matrix_init_user(void)`
### 低级矩阵函数的重写 :id=low-level-matrix-overrides
### 低级矩阵函数的重写 {#low-level-matrix-overrides}
* GPIO引脚初始化：`void matrix_init_pins(void)`
* 此处须完成低级行列引脚的初始化。默认实现中，这里会参考可选的键盘设置项 `ROW2COL`，`COL2ROW` 及 `DIRECT_PINS` 来初始化所有 `MATRIX_ROW_PINS` 及 `MATRIX_COL_PINS` 中定义的GPIO引脚的输入/输出状态。当键盘设计者重写该函数后，QMK本身不会进行任何引脚的初始化，只会听从重写的函数的实现逻辑。
@ -234,7 +234,7 @@ void suspend_wakeup_init_user(void) {
* 键盘/各子版本：`void suspend_power_down_kb(void)` 和 `void suspend_wakeup_init_user(void)`
* 键映射：`void suspend_power_down_kb(void)` 和 `void suspend_wakeup_init_user(void)`
# 层切换代码 :id=layer-change-code
# 层切换代码 {#layer-change-code}
每当层发生切换时被执行，可用于感知层切换事件，或自定义层处理逻辑。
@ -413,7 +413,7 @@ void eeconfig_init_user(void) { // EEPROM被重置
`val` 是你想写入EEPROM的值，`eeconfig_read_*`函数会从EEPROM返回一个32位(双字)的值。
### 定时执行 :id=deferred-execution
### 定时执行 {#deferred-execution}
QMK支持在特定时间间隔后执行回调，以代替手动的计时器管理。

2
docs/zh-cn/driver_installation_zadig.md
View File

@ -78,7 +78,7 @@ Zadig可以自动检测到bootloader设备，但有时你需要在 **Options（
:::
## 已知驱动列表 :id=list-of-known-bootloaders
## 已知驱动列表 {#list-of-known-bootloaders}
该表列出了已知的bootloader设备及其USB VID（厂商ID）和PID（产品ID），以及可用于QMK刷写固件的驱动。留意usbser及HidUsb驱动是随Windows附带的，无法通过Zadig安装 - 如果你的设备驱动不符，请参照上节来卸载这些驱动。

2
docs/zh-cn/easy_maker.md
View File

@ -23,7 +23,7 @@
更多信息请参见[引脚直连](#direct-pin)一节。
# 引脚直连 :id=direct-pin
# 引脚直连 {#direct-pin}
与其名字表意相同，它的原理是一个引脚连接一个开关，每个开关的另一端接地（VSS或GND），不需要额外的部件，通常MCU内部自带上拉电阻，因此可以感知开关动作。

2
docs/zh-cn/faq_build.md
View File

@ -22,7 +22,7 @@
但请留意，用 `sudo` 来执行 `make` 通常***不是***一个好主意，请尽量考虑使用上面的办法。
### Linux `udev` 规则 :id=linux-udev-rules
### Linux `udev` 规则 {#linux-udev-rules}
在linux下，需要足够的权限才能读写bootloader设备，可以使用 `sudo` 来刷写固件（不推荐），也可以将[这个文件](https://github.com/qmk/qmk_firmware/tree/master/util/udev/50-qmk.rules) 放到 `/etc/udev/rules.d/` 目录下。

4
docs/zh-cn/faq_debug.md
View File

@ -7,7 +7,7 @@
此页面详细介绍了人们对键盘故障排除的各种常见问题。
## 调试 :id=debugging
## 调试 {#debugging}
如果你在 `rules.mk` 中配置了 `CONSOLE_ENABLE = yes`，你的键盘将会输出调试信息。默认情况下输出很有限，可以启用调试模式来增加调试输出的丰富度。使用你的键映射方案中的 `DEBUG` 键码，或使用[指令](zh-cn/feature_command.md)功能来启动调试模式，或者将下面这段代码放到你的键映射中：
@ -37,7 +37,7 @@ void keyboard_post_init_user(void) {
更喜欢使用终端的方案？PJRC提供的[hid_listen](https://www.pjrc.com/teensy/hid_listen.html)也可以用来展示调试信息，已有Windows、Linux及MacOS下预编译好的可执行文件。
## 发送自定义调试信息 :id=debug-api
## 发送自定义调试信息 {#debug-api}
有时在[自定义代码](zh-cn/custom_quantum_functions.md)中输出调试信息非常有用，要做到这个功能也很简单，在代码文件头部包含 `print.h` 文件：

2
docs/zh-cn/faq_misc.md
View File

@ -5,7 +5,7 @@
git diff 0.15.12 HEAD -- docs/faq_misc.md | cat
-->
## 怎么对键盘进行测试？ :id=testing
## 怎么对键盘进行测试？ {#testing}
测试键盘就简单直接，把每个按键按一遍后确认发送的是正确的就行。也可以使用[QMK配置器](https://config.qmk.fm/#/test/)的测试模式检查键盘，即便这键盘没有运行着QMK。

2
docs/zh-cn/flashing.md
View File

@ -256,7 +256,7 @@ BOOTLOADER = stm32-dfu
* `:st-link-cli`: 通过ST-Link CLI工具集而非dfu-util进行刷写，需要有ST-Link电子狗。
* `:st-flash`: 通过[STLink工具](https://github.com/stlink-org/stlink)内的 `st-flash` 工具而非dfu-util进行刷写，需要有ST-Link电子狗。
## STM32duino :id=stm32duino
## STM32duino {#stm32duino}
该bootloader几乎是STM32F103板专用，该型号出厂不带USB DFU bootloader。其源代码及预编译好的二进制文件[在这里](https://github.com/rogerclarkmelbourne/STM32duino-bootloader)。

6
docs/zh-cn/hand_wire.md
View File

@ -33,7 +33,7 @@
首先从安装键轴及卫星轴开始，考虑厚度及材质的影响，可能需要热熔胶来固定。
## 设计矩阵 :id=planning-the-matrix
## 设计矩阵 {#planning-the-matrix}
如果你在参考已有的手工搭建指南（比如[自制键盘固件目录](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired)下的键盘），可以跳过该步骤，确保是按照文中的矩阵方案连线即可。
@ -51,7 +51,7 @@
必须时刻留意矩阵的行列数总和不能超出控制器的IO引脚数，因此上图的方案可以使用 Proton C 或 Teensy++ 控制器，但常规 Teensy 或 Pro Micro 不行。
### 常见微控制器板 :id=common-microcontroller-boards
### 常见微控制器板 {#common-microcontroller-boards}
| 控制器板 | 控制器方案 | # I/O引脚数 | 引脚图 |
| :------------ |:-------------:| ------:| ------ |
@ -250,6 +250,6 @@ Keyboard Firmware Builder提供的源代码是QMK的，但版本是2017年初的
以前本页内还有其它内容，现在我们已经将他们单独分离出去了。以下的内容是一些重定向链接，以供那些从老链接地址过来的人能找到自己要找的内容。
## 序: 键盘矩阵是如何工作的（以及为什么需要二极管） :id=preamble-how-a-keyboard-matrix-works-and-why-we-need-diodes
## 序: 键盘矩阵是如何工作的（以及为什么需要二极管） {#preamble-how-a-keyboard-matrix-works-and-why-we-need-diodes}
* [键盘矩阵是如何工作的](zh-cn/how_a_matrix_works.md)

4
docs/zh-cn/keymap.md
View File

@ -8,7 +8,7 @@
QMK键映射定义在C源文件中，其数据结构上是一个容纳了数组的数组。外层数组容纳了各个层，内层各数组则为层内的键列表。基本所有键盘都通过定义 `LAYOUT()` 宏来创建该两级数组。
## 键映射与配列 :id=keymap-and-layers
## 键映射与配列 {#keymap-and-layers}
在QMK中, **`const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]`** 容纳了多个 **层**， 每个**层**下包含了由**16位**的**动作码**所组成的键映射信息。 最多可以定义**32个层**。
对于常规键的定义，其**动作码**的高8位皆为0，低8位保存了USB HID中使用的各个键对应的**键码**。
@ -42,7 +42,7 @@ QMK键映射定义在C源文件中，其数据结构上是一个容纳了数组
有时，键映射中存储的动作码在一些文档中也被称作键码，主要是由TMK沿袭而来的习惯。
### 键映射的层状态 :id=keymap-layer-status
### 键映射的层状态 {#keymap-layer-status}
键映射的层状态由两个32位参数决定：

2
docs/zh-cn/newbs_building_firmware.md
View File

@ -51,7 +51,7 @@
:::
## 构建固件 :id=build-your-firmware
## 构建固件 {#build-your-firmware}
对键映射做完修改后，该编译固件了。回到终端中使用编译命令：

4
docs/zh-cn/newbs_getting_started.md
View File

@ -22,7 +22,7 @@
:::
## 2. 准备构建环境 :id=set-up-your-environment
## 2. 准备构建环境 {#set-up-your-environment}
我们已经尽力让QMK易于配置了，你只要准备好Linux或Unix环境，剩余的交给QMK来安装。
@ -135,7 +135,7 @@ Arch系环境下可以使用官方源安装命令行程序（在写这份文档
<!-- tabs:end -->
## 3. 执行QMK配置 :id=set-up-qmk
## 3. 执行QMK配置 {#set-up-qmk}
*译注：由于setup过程中需要从github clone依赖项，请先确保科学上网*
<!-- tabs:start -->

2
docs/zh-cn/newbs_git_using_your_master_branch.md
View File

@ -46,7 +46,7 @@ git push origin master
以上操作会切换到 `master` 分支，从QMK仓库拉取refs，下载QMK `master` 分支的当前版本，并上传至你的fork中。
## 进行编辑 :id=making-changes
## 进行编辑 {#making-changes}
要进行编辑，通过如下命令创建一个新分支：

4
docs/zh-cn/newbs_learn_more_resources.md
View File

@ -13,13 +13,13 @@
* [Thomas Baart's QMK Basics Blog](https://thomasbaart.nl/category/mechanical-keyboards/firmware/qmk/qmk-basics/) – 一个站在新人视角，探讨如何使用QMK固件的个人博客。
### 命令行操作参考资料 :id=command-line-resources
### 命令行操作参考资料 {#command-line-resources}
* [Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)
* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br />
* [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
### 文本编辑器相关参考资料 :id=text-editor-resources
### 文本编辑器相关参考资料 {#text-editor-resources}
对文本编辑器有选择困难？
* [a great introduction to the subject](https://learntocodewith.me/programming/basics/text-editors/)

2
docs/zh-cn/newbs_testing_debugging.md
View File

@ -8,7 +8,7 @@
[已移到这里](zh-cn/faq_misc.md#testing)
## 调试 :id=debugging
## 调试 {#debugging}
[已移到这里](zh-cn/faq_debug.md#debugging)

2
docs/zh-cn/reference_glossary.md
View File

@ -171,7 +171,7 @@ USB主机就是你的电脑，或者你的键盘所插的任何设备。
[新建一个issue](https://github.com/qmk/qmk_firmware/issues) ，想好你的问题，或许你所问的术语就会添加到这里。创建一个PR帮我们添加需要添加的术语当然坠吼了:)
## 中文翻译术语特别说明（terms of Chinese translation）:id=terms-of-zh-cn-translate
## 中文翻译术语特别说明（terms of Chinese translation）{#terms-of-zh-cn-translate}
!>如果你对QMK文档翻译中的细节不关心，请跳过该节
由于语言及文化差异，QMK英文文档中的部分内容，很难在**保持原句结构**的情况下，完美地翻译为中文，而保持翻译前后的语句结构一致对于开源代码的文档翻译来讲十分重要，这样才能确保不同的文档贡献者不会*夹带私货*，防止不同的翻译风格、不同的翻译水准、不同的理解与润色最终产生糟糕的混合。

2
docs/zh-cn/translating.md
View File

@ -18,7 +18,7 @@
```markdown
[建立你的环境](zh-cn/newbs-getting-started.md#set-up-your-environment)
## 建立你的环境 :id=set-up-your-environment
## 建立你的环境 {#set-up-your-environment}
```
在翻译后，以下文件也需要进行修改：

336
keyboards/bahm/aster_ergo/info.json Normal file
View File

@ -0,0 +1,336 @@
{
"manufacturer": "Mechlovin Studio",
"keyboard_name": "Aster Ergo",
"maintainer": "Bahm",
"processor": "STM32F103",
"bootloader": "stm32duino",
"diode_direction": "COL2ROW",
"features": {
"bootmagic": true,
"command": true,
"console": true,
"extrakey": true,
"mousekey": true,
"nkro": true
},
"matrix_pins": {
"cols": ["A10", "A9", "A8", "B15", "B14", "B13", "B12", "B1", "B0", "A7", "A6", "B4", "B3", "A15", "A5", "A2", "A1"],
"rows": ["B7", "B6", "B5", "B11", "B10", "A4"]
},
"url": "",
"usb": {
"device_version": "1.0.0",
"pid": "0x8701",
"vid": "0xBA00"
},
"indicators": {
"caps_lock": "B2",
"scroll_lock": "C13"
},
"layouts": {
"LAYOUT_all": {
"layout": [
{"matrix": [0, 0], "x": 0, "y": 0},
{"matrix": [0, 1], "x": 1.25, "y": 0},
{"matrix": [0, 2], "x": 2.25, "y": 0},
{"matrix": [0, 3], "x": 3.25, "y": 0},
{"matrix": [0, 4], "x": 4.25, "y": 0},
{"matrix": [0, 5], "x": 5.25, "y": 0},
{"matrix": [0, 6], "x": 6.25, "y": 0},
{"matrix": [0, 7], "x": 8.25, "y": 0},
{"matrix": [0, 8], "x": 9.25, "y": 0},
{"matrix": [0, 9], "x": 10.25, "y": 0},
{"matrix": [0, 10], "x": 11.25, "y": 0},
{"matrix": [0, 11], "x": 12.25, "y": 0},
{"matrix": [0, 12], "x": 13.25, "y": 0},
{"matrix": [0, 13], "x": 14.5, "y": 0},
{"matrix": [0, 14], "x": 17.25, "y": 0},
{"matrix": [0, 15], "x": 18.25, "y": 0},
{"matrix": [0, 16], "x": 19.25, "y": 0},
{"matrix": [1, 0], "x": 0, "y": 1.25},
{"matrix": [1, 1], "x": 1, "y": 1.25},
{"matrix": [1, 2], "x": 2, "y": 1.25},
{"matrix": [1, 3], "x": 3, "y": 1.25},
{"matrix": [1, 4], "x": 4, "y": 1.25},
{"matrix": [1, 5], "x": 5, "y": 1.25},
{"matrix": [1, 6], "x": 6, "y": 1.25},
{"matrix": [1, 7], "x": 8.5, "y": 1.25},
{"matrix": [1, 8], "x": 9.5, "y": 1.25},
{"matrix": [1, 9], "x": 10.5, "y": 1.25},
{"matrix": [1, 10], "x": 11.5, "y": 1.25},
{"matrix": [1, 11], "x": 12.5, "y": 1.25},
{"matrix": [1, 12], "x": 13.5, "y": 1.25},
{"matrix": [1, 13], "x": 14.5, "y": 1.25},
{"matrix": [2, 13], "x": 15.5, "y": 1.25},
{"matrix": [1, 14], "x": 17.25, "y": 1.25},
{"matrix": [1, 15], "x": 18.25, "y": 1.25},
{"matrix": [1, 16], "x": 19.25, "y": 1.25},
{"matrix": [2, 0], "x": 0, "y": 2.25, "w": 1.5},
{"matrix": [2, 1], "x": 1.5, "y": 2.25},
{"matrix": [2, 2], "x": 2.5, "y": 2.25},
{"matrix": [2, 3], "x": 3.5, "y": 2.25},
{"matrix": [2, 4], "x": 4.5, "y": 2.25},
{"matrix": [2, 5], "x": 5.5, "y": 2.25},
{"matrix": [2, 6], "x": 8, "y": 2.25},
{"matrix": [2, 7], "x": 9, "y": 2.25},
{"matrix": [2, 8], "x": 10, "y": 2.25},
{"matrix": [2, 9], "x": 11, "y": 2.25},
{"matrix": [2, 10], "x": 12, "y": 2.25},
{"matrix": [2, 11], "x": 13, "y": 2.25},
{"matrix": [2, 12], "x": 14, "y": 2.25},
{"matrix": [3, 13], "x": 15, "y": 2.25, "w": 1.5},
{"matrix": [2, 14], "x": 17.25, "y": 2.25},
{"matrix": [2, 15], "x": 18.25, "y": 2.25},
{"matrix": [2, 16], "x": 19.25, "y": 2.25},
{"matrix": [3, 0], "x": 0, "y": 3.25, "w": 1.75},
{"matrix": [3, 1], "x": 1.75, "y": 3.25},
{"matrix": [3, 2], "x": 2.75, "y": 3.25},
{"matrix": [3, 3], "x": 3.75, "y": 3.25},
{"matrix": [3, 4], "x": 4.75, "y": 3.25},
{"matrix": [3, 5], "x": 5.75, "y": 3.25},
{"matrix": [3, 6], "x": 8.25, "y": 3.25},
{"matrix": [3, 7], "x": 9.25, "y": 3.25},
{"matrix": [3, 8], "x": 10.25, "y": 3.25},
{"matrix": [3, 9], "x": 11.25, "y": 3.25},
{"matrix": [3, 10], "x": 12.25, "y": 3.25},
{"matrix": [3, 11], "x": 13.25, "y": 3.25},
{"matrix": [3, 12], "x": 14.25, "y": 3.25, "w": 2.25},
{"matrix": [4, 0], "x": 0, "y": 4.25, "w": 1.25},
{"matrix": [4, 1], "x": 1.25, "y": 4.25},
{"matrix": [4, 2], "x": 2.25, "y": 4.25},
{"matrix": [4, 3], "x": 3.25, "y": 4.25},
{"matrix": [4, 4], "x": 4.25, "y": 4.25},
{"matrix": [4, 5], "x": 5.25, "y": 4.25},
{"matrix": [4, 6], "x": 6.25, "y": 4.25},
{"matrix": [5, 7], "x": 7.75, "y": 4.25},
{"matrix": [4, 7], "x": 8.75, "y": 4.25},
{"matrix": [4, 8], "x": 9.75, "y": 4.25},
{"matrix": [4, 9], "x": 10.75, "y": 4.25},
{"matrix": [4, 10], "x": 11.75, "y": 4.25},
{"matrix": [4, 11], "x": 12.75, "y": 4.25},
{"matrix": [4, 12], "x": 13.75, "y": 4.25, "w": 1.75},
{"matrix": [4, 13], "x": 15.5, "y": 4.25},
{"matrix": [4, 15], "x": 18.25, "y": 4.25},
{"matrix": [5, 0], "x": 0, "y": 5.25, "w": 1.25},
{"matrix": [5, 1], "x": 1.25, "y": 5.25, "w": 1.25},
{"matrix": [5, 2], "x": 2.5, "y": 5.25, "w": 1.25},
{"matrix": [5, 4], "x": 3.75, "y": 5.25, "w": 1.25},
{"matrix": [5, 5], "x": 5, "y": 5.25, "w": 2.25},
{"matrix": [5, 8], "x": 7.75, "y": 5.25, "w": 2.75},
{"matrix": [5, 9], "x": 10.5, "y": 5.25, "w": 1.25},
{"matrix": [5, 10], "x": 11.75, "y": 5.25, "w": 1.25},
{"matrix": [5, 11], "x": 13, "y": 5.25, "w": 1.25},
{"matrix": [5, 12], "x": 14.25, "y": 5.25, "w": 1.25},
{"matrix": [5, 14], "x": 17.25, "y": 5.25},
{"matrix": [5, 15], "x": 18.25, "y": 5.25},
{"matrix": [5, 16], "x": 19.25, "y": 5.25}
]
},
"LAYOUT_tkl_ansi": {
"layout": [
{"matrix": [0, 0], "x": 0, "y": 0},
{"matrix": [0, 1], "x": 1.25, "y": 0},
{"matrix": [0, 2], "x": 2.25, "y": 0},
{"matrix": [0, 3], "x": 3.25, "y": 0},
{"matrix": [0, 4], "x": 4.25, "y": 0},
{"matrix": [0, 5], "x": 5.25, "y": 0},
{"matrix": [0, 6], "x": 6.25, "y": 0},
{"matrix": [0, 7], "x": 8.25, "y": 0},
{"matrix": [0, 8], "x": 9.25, "y": 0},
{"matrix": [0, 9], "x": 10.25, "y": 0},
{"matrix": [0, 10], "x": 11.25, "y": 0},
{"matrix": [0, 11], "x": 12.25, "y": 0},
{"matrix": [0, 12], "x": 13.25, "y": 0},
{"matrix": [0, 13], "x": 14.5, "y": 0},
{"matrix": [0, 14], "x": 17.25, "y": 0},
{"matrix": [0, 15], "x": 18.25, "y": 0},
{"matrix": [0, 16], "x": 19.25, "y": 0},
{"matrix": [1, 0], "x": 0, "y": 1.25},
{"matrix": [1, 1], "x": 1, "y": 1.25},
{"matrix": [1, 2], "x": 2, "y": 1.25},
{"matrix": [1, 3], "x": 3, "y": 1.25},
{"matrix": [1, 4], "x": 4, "y": 1.25},
{"matrix": [1, 5], "x": 5, "y": 1.25},
{"matrix": [1, 6], "x": 6, "y": 1.25},
{"matrix": [1, 7], "x": 8.5, "y": 1.25},
{"matrix": [1, 8], "x": 9.5, "y": 1.25},
{"matrix": [1, 9], "x": 10.5, "y": 1.25},
{"matrix": [1, 10], "x": 11.5, "y": 1.25},
{"matrix": [1, 11], "x": 12.5, "y": 1.25},
{"matrix": [1, 12], "x": 13.5, "y": 1.25},
{"matrix": [1, 13], "x": 14.5, "y": 1.25, "w": 2},
{"matrix": [1, 14], "x": 17.25, "y": 1.25},
{"matrix": [1, 15], "x": 18.25, "y": 1.25},
{"matrix": [1, 16], "x": 19.25, "y": 1.25},
{"matrix": [2, 0], "x": 0, "y": 2.25, "w": 1.5},
{"matrix": [2, 1], "x": 1.5, "y": 2.25},
{"matrix": [2, 2], "x": 2.5, "y": 2.25},
{"matrix": [2, 3], "x": 3.5, "y": 2.25},
{"matrix": [2, 4], "x": 4.5, "y": 2.25},
{"matrix": [2, 5], "x": 5.5, "y": 2.25},
{"matrix": [2, 6], "x": 8, "y": 2.25},
{"matrix": [2, 7], "x": 9, "y": 2.25},
{"matrix": [2, 8], "x": 10, "y": 2.25},
{"matrix": [2, 9], "x": 11, "y": 2.25},
{"matrix": [2, 10], "x": 12, "y": 2.25},
{"matrix": [2, 11], "x": 13, "y": 2.25},
{"matrix": [2, 12], "x": 14, "y": 2.25},
{"matrix": [3, 13], "x": 15, "y": 2.25, "w": 1.5},
{"matrix": [2, 14], "x": 17.25, "y": 2.25},
{"matrix": [2, 15], "x": 18.25, "y": 2.25},
{"matrix": [2, 16], "x": 19.25, "y": 2.25},
{"matrix": [3, 0], "x": 0, "y": 3.25, "w": 1.75},
{"matrix": [3, 1], "x": 1.75, "y": 3.25},
{"matrix": [3, 2], "x": 2.75, "y": 3.25},
{"matrix": [3, 3], "x": 3.75, "y": 3.25},
{"matrix": [3, 4], "x": 4.75, "y": 3.25},
{"matrix": [3, 5], "x": 5.75, "y": 3.25},
{"matrix": [3, 6], "x": 8.25, "y": 3.25},
{"matrix": [3, 7], "x": 9.25, "y": 3.25},
{"matrix": [3, 8], "x": 10.25, "y": 3.25},
{"matrix": [3, 9], "x": 11.25, "y": 3.25},
{"matrix": [3, 10], "x": 12.25, "y": 3.25},
{"matrix": [3, 11], "x": 13.25, "y": 3.25},
{"matrix": [3, 12], "x": 14.25, "y": 3.25, "w": 2.25},
{"matrix": [4, 0], "x": 0, "y": 4.25, "w": 2.25},
{"matrix": [4, 2], "x": 2.25, "y": 4.25},
{"matrix": [4, 3], "x": 3.25, "y": 4.25},
{"matrix": [4, 4], "x": 4.25, "y": 4.25},
{"matrix": [4, 5], "x": 5.25, "y": 4.25},
{"matrix": [4, 6], "x": 6.25, "y": 4.25},
{"matrix": [5, 7], "x": 7.75, "y": 4.25},
{"matrix": [4, 7], "x": 8.75, "y": 4.25},
{"matrix": [4, 8], "x": 9.75, "y": 4.25},
{"matrix": [4, 9], "x": 10.75, "y": 4.25},
{"matrix": [4, 10], "x": 11.75, "y": 4.25},
{"matrix": [4, 11], "x": 12.75, "y": 4.25},
{"matrix": [4, 12], "x": 13.75, "y": 4.25, "w": 2.75},
{"matrix": [4, 15], "x": 18.25, "y": 4.25},
{"matrix": [5, 0], "x": 0, "y": 5.25, "w": 1.25},
{"matrix": [5, 1], "x": 1.25, "y": 5.25, "w": 1.25},
{"matrix": [5, 2], "x": 2.5, "y": 5.25, "w": 1.25},
{"matrix": [5, 4], "x": 3.75, "y": 5.25, "w": 1.25},
{"matrix": [5, 5], "x": 5, "y": 5.25, "w": 2.25},
{"matrix": [5, 8], "x": 7.75, "y": 5.25, "w": 2.75},
{"matrix": [5, 9], "x": 10.5, "y": 5.25, "w": 1.25},
{"matrix": [5, 10], "x": 11.75, "y": 5.25, "w": 1.25},
{"matrix": [5, 11], "x": 13, "y": 5.25, "w": 1.25},
{"matrix": [5, 12], "x": 14.25, "y": 5.25, "w": 1.25},
{"matrix": [5, 14], "x": 17.25, "y": 5.25},
{"matrix": [5, 15], "x": 18.25, "y": 5.25},
{"matrix": [5, 16], "x": 19.25, "y": 5.25}
]
},
"LAYOUT_tkl_iso": {
"layout": [
{"matrix": [0, 0], "x": 0, "y": 0},
{"matrix": [0, 1], "x": 1.25, "y": 0},
{"matrix": [0, 2], "x": 2.25, "y": 0},
{"matrix": [0, 3], "x": 3.25, "y": 0},
{"matrix": [0, 4], "x": 4.25, "y": 0},
{"matrix": [0, 5], "x": 5.25, "y": 0},
{"matrix": [0, 6], "x": 6.25, "y": 0},
{"matrix": [0, 7], "x": 8.25, "y": 0},
{"matrix": [0, 8], "x": 9.25, "y": 0},
{"matrix": [0, 9], "x": 10.25, "y": 0},
{"matrix": [0, 10], "x": 11.25, "y": 0},
{"matrix": [0, 11], "x": 12.25, "y": 0},
{"matrix": [0, 12], "x": 13.25, "y": 0},
{"matrix": [0, 13], "x": 14.5, "y": 0},
{"matrix": [0, 14], "x": 17.25, "y": 0},
{"matrix": [0, 15], "x": 18.25, "y": 0},
{"matrix": [0, 16], "x": 19.25, "y": 0},
{"matrix": [1, 0], "x": 0, "y": 1.25},
{"matrix": [1, 1], "x": 1, "y": 1.25},
{"matrix": [1, 2], "x": 2, "y": 1.25},
{"matrix": [1, 3], "x": 3, "y": 1.25},
{"matrix": [1, 4], "x": 4, "y": 1.25},
{"matrix": [1, 5], "x": 5, "y": 1.25},
{"matrix": [1, 6], "x": 6, "y": 1.25},
{"matrix": [1, 7], "x": 8.5, "y": 1.25},
{"matrix": [1, 8], "x": 9.5, "y": 1.25},
{"matrix": [1, 9], "x": 10.5, "y": 1.25},
{"matrix": [1, 10], "x": 11.5, "y": 1.25},
{"matrix": [1, 11], "x": 12.5, "y": 1.25},
{"matrix": [1, 12], "x": 13.5, "y": 1.25},
{"matrix": [1, 13], "x": 14.5, "y": 1.25, "w": 2},
{"matrix": [1, 14], "x": 17.25, "y": 1.25},
{"matrix": [1, 15], "x": 18.25, "y": 1.25},
{"matrix": [1, 16], "x": 19.25, "y": 1.25},
{"matrix": [2, 0], "x": 0, "y": 2.25, "w": 1.5},
{"matrix": [2, 1], "x": 1.5, "y": 2.25},
{"matrix": [2, 2], "x": 2.5, "y": 2.25},
{"matrix": [2, 3], "x": 3.5, "y": 2.25},
{"matrix": [2, 4], "x": 4.5, "y": 2.25},
{"matrix": [2, 5], "x": 5.5, "y": 2.25},
{"matrix": [2, 6], "x": 8, "y": 2.25},
{"matrix": [2, 7], "x": 9, "y": 2.25},
{"matrix": [2, 8], "x": 10, "y": 2.25},
{"matrix": [2, 9], "x": 11, "y": 2.25},
{"matrix": [2, 10], "x": 12, "y": 2.25},
{"matrix": [2, 11], "x": 13, "y": 2.25},
{"matrix": [2, 12], "x": 14, "y": 2.25},
{"matrix": [3, 13], "x": 15.25, "y": 2.25, "w": 1.25, "h": 2},
{"matrix": [2, 14], "x": 17.25, "y": 2.25},
{"matrix": [2, 15], "x": 18.25, "y": 2.25},
{"matrix": [2, 16], "x": 19.25, "y": 2.25},
{"matrix": [3, 0], "x": 0, "y": 3.25, "w": 1.75},
{"matrix": [3, 1], "x": 1.75, "y": 3.25},
{"matrix": [3, 2], "x": 2.75, "y": 3.25},
{"matrix": [3, 3], "x": 3.75, "y": 3.25},
{"matrix": [3, 4], "x": 4.75, "y": 3.25},
{"matrix": [3, 5], "x": 5.75, "y": 3.25},
{"matrix": [3, 6], "x": 8.25, "y": 3.25},
{"matrix": [3, 7], "x": 9.25, "y": 3.25},
{"matrix": [3, 8], "x": 10.25, "y": 3.25},
{"matrix": [3, 9], "x": 11.25, "y": 3.25},
{"matrix": [3, 10], "x": 12.25, "y": 3.25},
{"matrix": [3, 11], "x": 13.25, "y": 3.25},
{"matrix": [3, 12], "x": 14.25, "y": 3.25},
{"matrix": [4, 0], "x": 0, "y": 4.25, "w": 1.25},
{"matrix": [4, 1], "x": 1.25, "y": 4.25},
{"matrix": [4, 2], "x": 2.25, "y": 4.25},
{"matrix": [4, 3], "x": 3.25, "y": 4.25},
{"matrix": [4, 4], "x": 4.25, "y": 4.25},
{"matrix": [4, 5], "x": 5.25, "y": 4.25},
{"matrix": [4, 6], "x": 6.25, "y": 4.25},
{"matrix": [5, 7], "x": 7.75, "y": 4.25},
{"matrix": [4, 7], "x": 8.75, "y": 4.25},
{"matrix": [4, 8], "x": 9.75, "y": 4.25},
{"matrix": [4, 9], "x": 10.75, "y": 4.25},
{"matrix": [4, 10], "x": 11.75, "y": 4.25},
{"matrix": [4, 11], "x": 12.75, "y": 4.25},
{"matrix": [4, 12], "x": 13.75, "y": 4.25, "w": 2.75},
{"matrix": [4, 15], "x": 18.25, "y": 4.25},
{"matrix": [5, 0], "x": 0, "y": 5.25, "w": 1.25},
{"matrix": [5, 1], "x": 1.25, "y": 5.25, "w": 1.25},
{"matrix": [5, 2], "x": 2.5, "y": 5.25, "w": 1.25},
{"matrix": [5, 4], "x": 3.75, "y": 5.25, "w": 1.25},
{"matrix": [5, 5], "x": 5, "y": 5.25, "w": 2.25},
{"matrix": [5, 8], "x": 7.75, "y": 5.25, "w": 2.75},
{"matrix": [5, 9], "x": 10.5, "y": 5.25, "w": 1.25},
{"matrix": [5, 10], "x": 11.75, "y": 5.25, "w": 1.25},
{"matrix": [5, 11], "x": 13, "y": 5.25, "w": 1.25},
{"matrix": [5, 12], "x": 14.25, "y": 5.25, "w": 1.25},
{"matrix": [5, 14], "x": 17.25, "y": 5.25},
{"matrix": [5, 15], "x": 18.25, "y": 5.25},
{"matrix": [5, 16], "x": 19.25, "y": 5.25}
]
}
}
}

28
keyboards/bahm/aster_ergo/keymaps/default/keymap.c Normal file
View File

@ -0,0 +1,28 @@
/* Copyright 2023 Mechlovin' Studio
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include QMK_KEYBOARD_H
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT_tkl_ansi(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_F13, KC_PSCR, KC_SCRL, KC_PAUS,
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_INS, KC_HOME, KC_PGUP,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_END, KC_PGDN,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP,
KC_LCTL, KC_LGUI, KC_LALT, MO(1), KC_SPC, KC_SPACE, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
)
};

52
keyboards/bahm/aster_ergo/keymaps/via/keymap.c Normal file
View File

@ -0,0 +1,52 @@
/* Copyright 2023 Mechlovin' Studio
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include QMK_KEYBOARD_H
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT_all(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_F13, KC_PSCR, KC_SCRL, KC_PAUS,
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_DEL, KC_INS, KC_HOME, KC_PGUP,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL, KC_END, KC_PGDN,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
KC_LSFT, KC_NUBS, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, MO(2), KC_RSFT, KC_UP,
KC_LCTL, KC_LGUI, KC_LALT, MO(1), KC_SPC, KC_SPACE, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
),
[1] = LAYOUT_all(
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
),
[2] = LAYOUT_all(
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
),
[3] = LAYOUT_all(
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
)
};

3
keyboards/bahm/aster_ergo/keymaps/via/rules.mk Normal file
View File

@ -0,0 +1,3 @@
# This file intentionally left blank
VIA_ENABLE = yes
LTO_ENABLE = yes

25
keyboards/bahm/aster_ergo/readme.md Normal file
View File

@ -0,0 +1,25 @@
# bahm/aster_ergo
The Aster Ergo PCB for the Aster Ergo keyboard (A TKL ergo keyboarđ)
* Keyboard Maintainer: [mechlovin](https://github.com/mechlovin)
* Hardware Supported: Aster Ergo PCB, APM32F103
* Hardware Availability: [GH](https://geekhack.org/index.php?topic=116962.0)
Make example for this keyboard (after setting up your build environment):
make bahm/aster_ergo:default
Flashing example for this keyboard:
make bahm/aster_ergo:default:flash
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
## Bootloader
Enter the bootloader in 3 ways:
* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available

1
keyboards/bahm/aster_ergo/rules.mk Normal file
View File

@ -0,0 +1 @@
# This file intentionally left blank

8
keyboards/blank_tehnologii/manibus/info.json
View File

@ -5,9 +5,9 @@
"maintainer": "SamuraiKek",
"debounce": 2,
"usb": {
"vid": "0xFEED",
"pid": "0x0000",
"device_version": "0.0.2"
"vid": "0x424D",
"pid": "0x4D4E",
"device_version": "1.0.0"
},
"split": {
"soft_serial_pin": "D0"
@ -16,7 +16,7 @@
"bootloader": "atmel-dfu",
"layouts": {
"LAYOUT": {
"layout": [
"layout": [
{"label":"Esc", "x":0, "y":0.75},
{"label":"1", "x":1, "y":0.5},
{"label":"2", "x":2, "y":0.25},

1
keyboards/blank_tehnologii/manibus/keymaps/default/config.h
View File

@ -16,4 +16,3 @@
#pragma once
#define EE_HANDS

10
keyboards/blank_tehnologii/manibus/keymaps/default/keymap.c
View File

@ -15,13 +15,13 @@
*/
#include QMK_KEYBOARD_H
enum custom_keycodes {
_QWERTY,
_LOWER
enum custom_layers {
_QWERTY,
_LOWER
};
#define LOWER MO(_LOWER)
/*
L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05,
L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15,
@ -57,7 +57,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_BSLS,
// ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤
KC_LCTL, KC_HOME, KC_INS, KC_DEL, KC_LGUI, KC_SPC, KC_LALT, KC_ENT, KC_BSPC, LOWER, KC_LBRC, KC_RBRC, KC_END, KC_GRV
KC_LCTL, KC_HOME, KC_INS, KC_DEL, KC_LGUI, KC_SPC, KC_LALT, KC_ENT, KC_BSPC, LOWER, KC_LBRC, KC_RBRC, KC_END, KC_GRV
// └────────┴────────┴────────┴────────┴────────┴────────┴────────┘ └────────┴────────┴────────┴────────┴────────┴────────┴────────┘
),

76
keyboards/blank_tehnologii/manibus/keymaps/via/keymap.c Normal file
View File

@ -0,0 +1,76 @@
/* Copyright 2021 SamuraiKek
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include QMK_KEYBOARD_H
enum custom_layers {
_QWERTY,
_FN1
};
#define FN1 MO(_FN1)
/*
L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05,
L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15,
L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25,
L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35,
L40, L41, L42, L43, L44, L45, L46, R40, R41, R42, R43, R44, R45, R46,
[_UNIVERSAL] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
// └────────┴────────┴────────┴────────┴────────┴────────┴────────┘ └────────┴────────┴────────┴────────┴────────┴────────┴────────┘
)
*/
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_QWERTY] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_EQL,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_BSLS,
// ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤
KC_LCTL, KC_HOME, KC_INS, KC_DEL, KC_LGUI, KC_SPC, KC_LALT, KC_ENT, KC_BSPC, FN1, KC_LBRC, KC_RBRC, KC_END, KC_GRV
// └────────┴────────┴────────┴────────┴────────┴────────┴────────┘ └────────┴────────┴────────┴────────┴────────┴────────┴────────┘
),
[_FN1] = LAYOUT(
// ┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐
KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, QK_BOOT, _______, _______, _______, KC_UP, _______, KC_MPLY, KC_F12,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RIGHT,KC_VOLD, KC_VOLU,
// ├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤
_______, _______, _______, _______, _______, _______, _______, KC_MUTE, KC_MPRV, KC_MNXT, _______, _______,
// ├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤
_______, KC_PGUP, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PGDN, _______
// └────────┴────────┴────────┴────────┴────────┴────────┴────────┘ └────────┴────────┴────────┴────────┴────────┴────────┴────────┘
)
};

1
keyboards/blank_tehnologii/manibus/keymaps/via/rules.mk Normal file
View File

@ -0,0 +1 @@
VIA_ENABLE = yes

3
keyboards/ez_maker/directpins/promicro/info.json
View File

@ -2,7 +2,7 @@
"manufacturer": "Zach White",
"keyboard_name": "DirectPins ProMicro",
"maintainer": "skullydazed",
"bootloader": "atmel-dfu",
"development_board": "promicro",
"features": {
"bootmagic": true,
"extrakey": true,
@ -22,7 +22,6 @@
["B5", "B6"]
]
},
"processor": "atmega32u4",
"usb": {
"device_version": "0.0.1",
"pid": "0x2320",

98
keyboards/kbdcraft/adam64/adam64.c Normal file
View File

@ -0,0 +1,98 @@
/*
* Copyright 2023 KBDCraft
* Copyright 2023 Adophoxia <andyao1528@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "quantum.h"
#ifdef RGB_MATRIX_ENABLE
const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
/* Refer to IS31 manual for these locations
* driver
* | R location
* | | G location
* | | | B location
* | | | | */
{0, CS14_SW1, CS13_SW1, CS15_SW1},
{0, CS14_SW2, CS13_SW2, CS15_SW2},
{0, CS14_SW3, CS13_SW3, CS15_SW3},
{0, CS14_SW4, CS13_SW4, CS15_SW4},
{0, CS14_SW5, CS13_SW5, CS15_SW5},
{0, CS14_SW6, CS13_SW6, CS15_SW6},
{0, CS14_SW7, CS13_SW7, CS15_SW7},
{0, CS32_SW1, CS31_SW1, CS33_SW1},
{0, CS32_SW2, CS31_SW2, CS33_SW2},
{0, CS32_SW3, CS31_SW3, CS33_SW3},
{0, CS32_SW4, CS31_SW4, CS33_SW4},
{0, CS32_SW5, CS31_SW5, CS33_SW5},
{0, CS32_SW6, CS31_SW6, CS33_SW6},
{0, CS32_SW7, CS31_SW7, CS33_SW7},
{0, CS23_SW1, CS24_SW1, CS22_SW1},
{0, CS23_SW2, CS24_SW2, CS22_SW2},
{0, CS23_SW3, CS24_SW3, CS22_SW3},
{0, CS23_SW4, CS24_SW4, CS22_SW4},
{0, CS23_SW5, CS24_SW5, CS22_SW5},
{0, CS23_SW6, CS24_SW6, CS22_SW6},
{0, CS23_SW7, CS24_SW7, CS22_SW7},
{0, CS35_SW1, CS34_SW1, CS36_SW1},
{0, CS35_SW2, CS34_SW2, CS36_SW2},
{0, CS35_SW3, CS34_SW3, CS36_SW3},
{0, CS35_SW4, CS34_SW4, CS36_SW4},
{0, CS35_SW5, CS34_SW5, CS36_SW5},
{0, CS35_SW6, CS34_SW6, CS36_SW6},
{0, CS35_SW7, CS34_SW7, CS36_SW7},
{0, CS17_SW1, CS16_SW1, CS18_SW1},
{0, CS17_SW2, CS16_SW2, CS18_SW2},
{0, CS17_SW3, CS16_SW3, CS18_SW3},
{0, CS17_SW4, CS16_SW4, CS18_SW4},
{0, CS17_SW5, CS16_SW5, CS18_SW5},
{0, CS17_SW6, CS16_SW6, CS18_SW6},
{0, CS17_SW7, CS16_SW7, CS18_SW7},
{0, CS26_SW1, CS25_SW1, CS27_SW1},
{0, CS26_SW2, CS25_SW2, CS27_SW2},
{0, CS26_SW3, CS25_SW3, CS27_SW3},
{0, CS26_SW4, CS25_SW4, CS27_SW4},
{0, CS26_SW5, CS25_SW5, CS27_SW5},
{0, CS26_SW7, CS25_SW7, CS27_SW7},
{0, CS20_SW1, CS19_SW1, CS21_SW1},
{0, CS20_SW2, CS19_SW2, CS21_SW2},
{0, CS20_SW3, CS19_SW3, CS21_SW3},
{0, CS20_SW4, CS19_SW4, CS21_SW4},
{0, CS20_SW5, CS19_SW5, CS21_SW5},
{0, CS20_SW6, CS19_SW6, CS21_SW6},
{0, CS20_SW7, CS19_SW7, CS21_SW7},
{0, CS29_SW1, CS28_SW1, CS30_SW1},
{0, CS29_SW2, CS28_SW2, CS30_SW2},
{0, CS29_SW3, CS28_SW3, CS30_SW3},
{0, CS29_SW4, CS28_SW4, CS30_SW4},
{0, CS29_SW5, CS28_SW5, CS30_SW5},
{0, CS29_SW6, CS28_SW6, CS30_SW6},
{0, CS29_SW7, CS28_SW7, CS30_SW7},
{0, CS9_SW1, CS10_SW1, CS8_SW1},
{0, CS9_SW2, CS10_SW2, CS8_SW2},
{0, CS9_SW3, CS10_SW3, CS8_SW3},
{0, CS9_SW6, CS10_SW6, CS8_SW6},
{0, CS2_SW3, CS1_SW3, CS3_SW3},
{0, CS2_SW4, CS1_SW4, CS3_SW4},
{0, CS2_SW5, CS1_SW5, CS3_SW5},
{0, CS2_SW6, CS1_SW6, CS3_SW6},
{0, CS2_SW7, CS1_SW7, CS3_SW7}
};
#endif

34
keyboards/kbdcraft/adam64/config.h Normal file
View File

@ -0,0 +1,34 @@
/*
* Copyright 2023 KBDCraft
* Copyright 2023 Adophoxia <andyao1528@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#define I2C1_SCL_PIN B8
#define I2C1_SDA_PIN B9
#define I2C1_CLOCK_SPEED 400000
#define I2C1_DUTY_CYCLE FAST_DUTY_CYCLE_16_9
#define DRIVER_COUNT 1
#define DRIVER_ADDR_1 0b0110000
#define RGB_MATRIX_LED_COUNT 64
/* turn off effects when suspended */
#define RGB_DISABLE_WHEN_USB_SUSPENDED
#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
#define RGB_MATRIX_KEYPRESSES

Some files were not shown because too many files have changed in this diff Show More