qmk-firmware/keyboards/thevankeyboards/minivan/keymaps/josjoha/user_config.h
Jos Boersema 7639b5aa3e
[Keymap] josjoha keymap for TheVan Keyboards' Minivan (#8066)
Keymap Minivan: configurable dual layout, many symbols, speed/text-size measuring

* Made center led color follow last activated layer color. Some led code clean up

* Reordered the _RAR layer, also putting GUI on the _ACC layer.

* Some issue with _FUN (see keymap.c FIXME), removed _FUN nested 'go to layer' key on _FUN.

* markdown formatting

* Update readme about _FUN top row issue (see keymap.c at XXX)

* Sentence order final bit was wrong by topic. White space fiddles.

* Minor comment editing

* minor comment adjustments

* leds are not modifiers, moved

* _FUN persistance on base layer only (XXX)

* The up/left to go to _LTR layer, now always goes to BASE (_LTR or _DDL).
Led indicators refldect this. No _DRA hold on base layer but _ACC. No
one shot to _FUN layer (seemed to make things confusing), but a TO().

* Some chatter about how to configure this map to your needs.

* language fixing

* Tried to make sense explaining how to access the descramble.

* language fix

* Seems there was a stale CSET_LTR/.*DDL, should be BASE_LTR/.*DDL, fixed.

* language, blabla

* Corrected stale _LTR into BASE

* Some documentation finetuning and trying to make it simple to understand

* language fixing

* language fixing

* Doing the utmost to explain it in a way I understand it too.

* language fixing, going ultra-verbose

* language fixing and formatting

* language fixing

* language fixing, formatting

* attempt to simplify explanations as much as possible

* added License to keymap.c (GPL), noted that _ACC and _DRA need work to
function in 'descramble' mode

* fixes regarding layer order, adding two layers, started on descramble
layers for _ACC and _DRA Unicode

* Noted some coming changes about F-layer and more descramble.

* changed globals to type 'bool'

* Changed F-layer by removing pre-modifier F keys, moved BASE direction
switches, added new incomplete descramble layers

* _FUN layer changes (comment fix)

* Led color fixes. Changed order of layers in the source (no user consequence).

* Added copyright authors (hope that is correct in GPL style/requirements).

* Switched on BASE layers the keys to activate _MOV with leftside _NSY:
more harmoneous, and _MOV can also be held by right hand.

* Follow Quantum indentation style more (mostly).

* On _NSY & _DDN, Tab follows _LTR. '-' moved to LShift, '.' moved, ','
created, shift(tab) removed.

* Added Linux Unicode input mode Accented characters on layers _DDA, _DDD

* added to Todo

* Added ijIJ to _ACC and _DDA layers (2nd last letter of Dutch alphabet).

* add todo point about navigation, fix -> "8th key"

* added 「」《》 to _DRA and _DDA

* Added 〇, ƒƑ. Altered Nav clusters with paging on outside, added thumb Page up/down to _MOV, brought _REV in line with recent _NSY changes (tab,-,enter,dot,comma). Harmonized tab on _Mov with other layer tabs (also a move command, moving cells).

* Added super- and sub-script for numbers on _DRA, _DDD.

* Added quotation marks „ “ ” to layers _DRA and _DDD.

* Added °〇•· to _DRA, _DDA

* § as an enumeration grouped with • (bullet), · as possibly math (middot or multiply) grouped with ±.

* Changed numbers to be on home-rows both hands, because thumb layer key does
not interfere alternating between hands for longer numbers (previous
reason for one-handed numbers). The unshifted symbols went left 2nd row,
because then the shifted versions can be accessed with shift if the
layout is replicated on a Pok3r (which is non-programmable right hand 2nd row.)
The logic has been harmonized with layers _DDN, _DRA & _DDD, _FUN, which
have number(-like) keys. It seems better this way. The symbols are layed
out more spaciously, each finger now does two symbols (2nd row, 4th
row). The numbers are more like they normally are, which feels more
natural, and should even the load between both hands and help with
alternating between hands when typing numbers.

Reason to change was looking into pressing ;, q, j, with ring-, middle-,
index-finger (moved one to the right from default Dvorak), because the
stagger makes it easier to reach that way, less loss of home row contact,
bending fingers more straight up and down. Downside became that left
index type 5 numbers, and that the normal finger matching (0 is pinky,
etc) was lost. With the new layout these potential problems are also resolved.

* Made descramble _DDN, _DDL representation show both raw and resulting layouts.
layouts.

* Added arrows, fleur and heart on _DRA and _DDD.

* Changed _FUN layer switching to incorporate the 'descramble' system
seemlessly. The 4 layer with a descramble twin will switch to either
depending on the descramble mode.

* Descramble mode with normal Unicode layers mostly done, except costum LT() to share the key with Delete/Alt on _DDL.

* Changed descramble mode keys to be just one on a cycle. Added full set
of Alt/Control/Shift multimodifiers to `_FUN` layer.

* Changed descramble mode keys to be just one on a cycle. Added full set
of Alt/Control/Shift multimodifiers to `_FUN` layer.

* format fix

* Descramble cycle key moved from row 1 to row 4 far right, to avoid
accidental press,

* The 'descramble' mode with normal Unicode encoding finished. Fixed
mistaken non-transparent key on _DRA and _DDD, removed tab from _RAR.

* stale layer comment fix _LTR/_DDL

* New layer-tap timed keys proved unreliable, longer tap term fixed it.

* The _FUN layer is a one-shot layer for the F-keys, but that can be toggled by the FUN< key on the _FUN layer (top row, 3rd).
Some additions to the readme.

* Comment improvements (layout tables)

* minor

* Made #defines to allow a user to easily switch to a WASD arrow layout.

* Added keys to switch leds on/off, to _RAR layer. Fixed wrong comment on 'APP' key in _RAR.

* comments fix regarding MLed, SLeds

* Added BASE to same key as _FUN on base layer, except layers with numbers/symbols.
Removed capital ƒ, and moved ± to that key. Added … on old spot of ±.
Some readme language editing, adding something about other keyboards, etc.

* small language fix

* Config.h: Removed unused #defines.
Readme: minor edits.

* minor language edits.

* Minor comment edit.

* Minor language fix.

* Minor language style edit.

* Removed unnecessary section 'personal remarks'

* Changed the top row in _DRA and _DDD. Super-/sub-script parenthesis to that location on _NSY, added currency symbols, reduced emoticons.

* minor formatting

* Added LGUI and RGUI on the _DRA/_DDD layer(s).

* Put RGUI on the base layer, on the _FUN layer switch key. This probably causes side-effects on
systems without where RGUI is not merely a modifier.

* Changed _FUN toggle on BASE to Rshift, because RGUI on some systems has a consequence when tapped by itself.

* Changed LGUI and RGUI around because LGUI is mostly used and on BASE layer. Some edits to last part of readme.md.

* Minor language fixed (L/R-GUI, use-case).

* some more blabla on use case of the map generally

* Changed name KC__[LR]GUI to KC__[XY]GUI for clarity wrt switching them.

* Removed left-arrow on Alt on _ACC and _DRA, for faster use with pointer device.

* Added the same system as is on RShift, to LShift, pointed it to _MOV layer.

* Changed left shift layer toggle to _DRA, because it has uncluttered shift, alt, control, for using those with a pointer device (mouse, stylus).

* Changed base layer left-shift tap from _DRA to _MOV, because _MOV toggled can be convenient generally, and it is a less dangerous layer to accidentally press, and it makes more sense to activate the navigation layer when editing in 3D software.

* The Power keys on _RAR now require Shift to be activated (accident prevention).

* fiddled with title

* more title fiddles

* Added RGUI on _FUN for future proofing the layout, harmonizing layers.

* Added ',' on _REV (number fraction division). Minor fix to documentation format.

* title fiddle

* Added LGUI, RGUI to _RAR, to harmonize with other layers and for potential future uses.

* Changed unnecessary transparent keycode on _AcC and _DDA to be 'nop', minor comment fixes.

* Added on _DRA and _DDD: ─━┄┅.
Fixed a bug in led layer colors (forgotten 'else', causing wrong color for _DDD).

* Some changes to conform to QMK readme.md standards (more necessary).

* Changed _REV into a numbers pad layer called _PAD, put on Lshift in BASE.

_REV layer (not used anyway) replaced with a layer that is basically
a layer where symbols that exist on _NSY (mostly) and on _LTR (few)
are existing in the same locations, but in the number pad variant of
that symbol. The goal is to make it easy to find, it is not meant for
single hand access quickly. The use is to deal with special shortcuts
like Blender has, which differentiate normal and numpad numbers/symbols.
For quick access it was put on the left shift in BASE layer.

* Added navigation arrangements to _PAD. Changed location of shift on _RAR.

The numbers on numpad are easy to find, but when these keys are in their
navigation variant with numlock on it becomes almost impossible. There
was room on the map to add an arrow row, and a row for the remaining
navigation keys, hence they where added. They are in a left handed
order, because there already is a right handed order on _MOV.

It still proved possible to accidentally trigger Power, due to erroneous
hitting 'shift' in BASE and then messing around by accident. With shift
on (BASE) space in _RAR, accidents should be reduced further, since it
is a combination never used.

* Added Tab on _ACC and _PAD

To facilitate Control-Tab (a blender shortcut). On _ACC the Tab is in its
correct place. On _PAD it messy because not on its correct place. Leaving
it there for now: easier to access Tab+Control with left hand only on the
modifiers in _PAD, and other hand on a pointer device. Tab has a potential
use to jump input cells, which may be used in combination with a numpad.

* _MOV layer: switched default layout to trangle navigation layout.

This only required to set the already existing #defines. I found
the flat layout not intuitive, the triangle layout has no left/rigth hand problem.

The higher buttons for the mouse where not correctly ordered, so they where re-ordered.

* Triangle navigation by default. Added pictures of layout to readme.md

* Layer names on images.

* Changed image for layer _DRAW slightly.

The shifted symbol to the lower right.

* Image for _PAD corrected for no-action and Tab.

* Added a paragraph about why this layout is good to use.

* removed 'modifiers' paragraph

* Some text improvements in paragraph on what is good about this layout.

Fiddle on the title as well.

* Added Del on _DRAW layer.

Some minor text fiddles here and there.

* Removed word "descramble" in image layer _RAR.

* Improved key 'sticky' and altered image size (test).

* Rescaled image for layer FUN

* Unicode in its own file. Bug fix: _DDA 'ï' printed a capital.

Upon a suggestion from QMK Discord #programming, the macros and
unicode is put in a separate file, because keymap.c got large.

An erroneous numerical value for ï was fixed.

Author e-mail is updated to a new e-mail adres.

* Added an image to illustrate 'descramble' mode.

* Changed explicit e-mail to link, to reduce spam bot trolling.

* Added a Qwerty+Dvorak compile time version.

It seemed the overall design (accented, Unicode, stuff) could be useful
for Qwerty typers (of which there are so many). This was done by #if(n)def
out/in a fair amount of code here and there, and creating 4 replacement
layers in a new file qwerty_dvorak.c, also with its own readme in
qwerty_dvorak.md. The 'descramble' switch system is re-used here to
switch from Qwerty to Dvorak.

The new code is put in qwerty_dvorak.c, which starts with an extensive
comment about why and how it works.

Fix: Docs, a stale "_MOV" was replaced with "_PAD" in the readme.md for _DDL.

* Changed image hosting.

Downtime, problems registering: resorting to my own domain.

* minor text order changes

* Some text improvements.

* Added a compile option to easily change what layer is active on startup.

This layer can be plain Dvorak or 'descrambled' Dvorak, if
QWERTY_DVORAK is not set. It can be Qwerty or Dvorak if it is set.
Just some simple #define statements.

* Added graphics for Qwerty+Dvorak, and improved documentation.

Added the whole set of layers also to qwerty_dvorak.md, because
it seemed it would get even more confusing to have a user cross
reference it between the two files.

* Some simple text improvements

* Numbers/symbols layer keys on BASE to DRAW when both pressed.

The two keys besides the space bars go to DRAW layer when pressed
simultaneously. (This is inspired on the Planck's 'adjust' layer,
pressing both 'lower' and 'raise' together.) All layers can now
(relatively) comfortably be reached. This change was necessary
because it was cumbersome to reach the DRAW layer with the right
pinky and then type with the right hand. _RAR is now not super
easy, but it is a 'rare' layer anyway.

* Added compile + flash section in readme.

* Corrected documentation: 'mouse on ... hand'

* Removed up/down arrow ⮙⮛ on _DRA and _DDD, because the hex file was too large.

Due to pulling the master repository, changing nothing in this keymap, the
code compiled as 2 bytes too large, where before it had been 2 bytes left free.
Some compile options have been created, to make it easy to cut out up/down
arrow on the 'descramble' _DDD layer, and/or the normal _DRA layer, and/or
dashes ┄┅ on the 'descramble' _DDD layer. The 'normal' layer cut out of arrows
yields little benefit, but it keeps all layers exactly the same between 'descramble'
and normal mode. For Qwerty compilation, you will want to not cut out anything,
requiring to edit the user compile options in keymap.c (top).

* Resolved size issue with QMK #defines, re-instated ⮙⮛, removed RGUI on _FUN.

Various #defines tested to reduce space, NO_ACTION_MACRO NO_ACTION_FUNCTION
worked. Therefore the cutting out of the up/down arrows was no longer
needed. The #defines to easily remove them have been left in place.

RGUI made _FUN confusing with the multi-modifiers, thus taken out. Multi-
modifiers now logically cascade without skipping a key.

* Improved image files with led colors and some tweaks.

* Updated graphics file for Dvorak in QWERTY_DVORAK compile option.

The led colors where not correct because the graphics for standard
Dvorak was being re-used.

* Fixed for re-instating arrow up/down for space.

* Activation marker on _FUN layer in documentation altered.

It looked like it was a symbol.

* Made startup layer explicit in code.

Startup layer follows 'descramble' on/off user #define setting.

* Marker for BASE activation for _PAD, _MOV: fixed.

There was a stale marker in the documentation layouts for _MOV: removed.
The same marker for _PAD was improved.

* Code optimizations suggested on pull request #8066

https://github.com/qmk/qmk_firmware/pull/8066
Some things moved to config.h, rules.mk
Changed layer_on/_off to layer_move(..)
Removed a global variable, changed literal type on a function.

Code is now a lot smaller, hence removed readme.md entry on that.
Removed "not shown" on 'descramble' leds in qwerty readme (mistake).

* Compile option to change ƒ into €.

Since it's a west european keymap, maybe someone likes the euro currency on it.
(It was not on it because I don't like ...)

* default to ƒ on keymap

* Removed print sheet for layout *.odt file.

Changing this to text/markdown seems to reduce the use of this file
to a point that it may be better to delete it. There is also the
graphics now, which might be better to print.

* Updated the seller/maintainer of the board to: The Key Dot Company LLC.

https://thekey.company/blogs/blog-updates/thekey-company-acquires-minivan

* Changed external links to website to plain text.

The markdown link is caught by the github cammo system.

* Last free spot on the map made easy to configure.

One spot was still free (Unicode _DRA/_DDD layer). This puts a #define
on top of unicode_macros.c, to make it easy for a user to put in their
own symbol.

Put placeholder 🛠 in there. That symbol is not represented in the
documentation (maybe it should, it is a nice symbol).

* Removed space saving #defines.

These became obsolete clutter, now that there is enough space thanks to
LINK_TIME_OPTIMIZATION_ENABLE.

* Added tokens to simplify compiling for 45/46 keys.

An attempt to make it easy to switch on a #define between
various hardware configurations (44, 45, 46 keys) failed.
This: #define J1 , KC_A // seems to have failed to be
recognized as a key definition.
error: error: macro "LAYOUT_command" requires 45 arguments, but only 44 given

Left in are some code tokens (J1-J4) and #defines that need
at least bulk replacement in keymap.c and optionally qwerty_dvorak.c,
to compile for such hardware configurations. It would be nice
if this could be done better.

* User can easily compile for 45, 46 hardware keys.

Added some #ifdefs around optional keys in the keymap, to allow
compiling for 45 and 46 keys. Left the earlier made code with the
J1_J2 etc. tokens, which could still be used to port the map to
a board with even more keys. This fixes earlier mentioned problem.

* Arrow cluster for 'arrow' hardware configuration.

This is a user configurations option in the keymap.c, to have
an arrow cluster around the additional key for 'arrow' hardware.
The arrow cluster is however not on the base layer (no room). The
additional key is used to switch to the _MOV layer. There it becomes
a down arrow in the arrow cluster.

To make this work with the default _MOV layer, the right hand
keys on the 2nd row where moved one spot to the left, for the 'triangle'
arrow configuration (mouse right). This is a trivial change.

There was a bunch of language improvements to the documentation,
including graphics.

The symbol 🛠 is now listed.

The program seems to be reliable, as far as used and tested.

* Correction of mark-down formatting.

_MOV layer 'arrow' cluster documentation rendered incorrectly
(attempt to add newline).

* Markdown formatting mistake correction.

Adding a newline at 'Layers (text)' chapter.

* Moving the graphics about 'arrow' to topic.

The graphic explaining what 'arrow' with arrow cluster means,
should be where that is mentioned under compile options.

* Editor token J3_J4 moved to avoid arrow cluster.

If one wants to insert a key by bulk replacing J3_J4, and has
activated the 'arrow' layout arrow cluster, this new key would
be inside the arrow cluster, hence it was moved to the left.

* Æstethics of image 'arrow' layout, arrow cluster.

Shading corrected/nicer.

* Corrected image link in readme.md

Illustration 'arrow' layout, arrow cluster.

* Fix: Toggle to BASE layer leaked. South-paw key.

When toggling to a non-BASE layer, either on the _FUN layer or
using the 'arrow' cluster for 'arrow' layout, on the BASE layer to
toggle to _MOV, the layer changed on the down-stroke, causing a
character to leak. These layer switch macros now alter layer on the
up stroke.

There seems to have been an accidental code deletion: #define MORE_key1.
This defines what the additional hardware key for 'South Paw' ('Command')
should be.

* User compile option comments easier to read.

The phrases "uncomment" and "comment out" are confusing.
Replaced by _activate_ and _remove_.

* Put user compile options back to default Minivan.

Accidentally left the compile options for number of Minivan keys
in the wrong state while git pushing.

* Rewording a comment in the user compile options.

Clearer language.

* Leds indicate Caps/Num-lock.

Leds green/blue switch depending on numlock for numbers-pad layer _PAD.
BASE layer led brightens when capslock is on.

* _PAD had the wrong period, fixed.

_PAD layer had the KC_DOT instead of KC_KP_DOT.

* Options for navigation keys arrow hardware key.

Compile options added to have a complete navigation cluster around
the additional hardware key for 'arrow' layout, both for triangle
left handed arrows and flat right handed arrows.

* Added _FUN layer in text Qwerty.

_FUN text layer was by mistake missing/deleted in the qwerty-dvorak readme.

* Added graphical visualization of all layers.

* Graphics: _RAR 'Capslock', _NSY '~' corrected.

Text representation of layers was correct, graphics corrected.

* Compile Option arrows in a vi(1) editor layout.

Vi(1) is a much loved editor, with its own peculiar arrow layout
on HJKL (as it appears in Qwerty). It seems possible some Qwerty
vi users might find it fun this way for regular arrows as well.

The 'arrow' hardware layout, compiled with arrow cluster, follows
the vi(1) arrow arrangement.

* More layer overview graphics files for the readmes.

Added a '40% x 400%' to the 3D layer overview image (top).
Added overview of all layers in a readable way (Dvorak² only).
Added a guide to show where what is similar on layers. This should help with learning.
Added a graphic showing what key activates what layer.
Added graphics that show what layer subsets are active in certain modes (Dvorak² and Qwerty/Dvorak).

Fixed mistake: _Tab_ missing in layer `_PAD` graphics file.

* 'Tab' inserted in overview graphics for _PAD layer.

* Corrected mistake in similar layer keys.

LGUI on _ACC

* Added overview graphics for Qwerty/Dvorak.

Overview of layers, similar keys on similar layers, activation.

* Compile option to change ⮘ ⮙ ⮚ ⮛ into ☐ ☒ ☑ 🗹

Layer _DRA, _DDD. Checkboxes seem handy for lists. Set default on in
keymap.c. Pointers seem rarely useful. Right arrow sometimes as a bullet
point marker. All affected graphics updated.

* First overview image correction.

Last layer is not 'symbols' due to its numbers.
Some art improvement.

* Minor tekst correction (author Minivan config).

* Short features overview and git lib fix.

* note⁴ as example

* Improvements all over the place.

The keymap is now modular dual layout. There is a common system,
and there can then be two letter/numbers layer pairs be compiled
with it, which are separately defined and documented in ./bases…
files.

Speed measuring and text size counting added.

There is an additional Unicode layer, for a total of three.

The “descramble Dvorak” layer is now just a function, as was
originally intended.

* Wrong link to Dvorak manual, stray ‛r’ character.

* Splitting the layouts so they are not pairs of 4.

The layers had been configurable only as a set of a BASE and letter
layer with another BASE and letter layer: Dvorak + Dvorak² and
Qwerty+Dvorak.

Now Dvorak, Dvorak² and Qwerty can be individually configured, to
be on either the Default or Alternate spots in the dual layout
(Dvorak² only supports Alternate, due to its “_HALF_ descramble” mode).

* Added Colemak layout.

Some tidying up of documentation wrt DEF/ALT base layer identifiers.
Fixed missing ‛:’ on the graphics for Qwerty.

* stale letter

* fix modified submodules

* removed redundant code

testing twice for non-zero

* Speed measuring precision fix.

The calculation of “int speed;” caused great loss of precision.

* Added overview of layers by key.

Makes it easier to see the associations of meanings per key.

* Dvorak descramble by key overview

Forgot to add.

* Minor readme format fiddle.

* Graphics: blank keys are grey, fix one mistake.

* Compilation as a single layout.

Layer definitions _ALT_BASE and _ALT_NSY (enum) are simply #redefined
as preprocessor numbers equal to _DEF_BASE and _DEF_NSY (see user_config.h,
lowest reference to MINIFAN_SINGLE_LAYOUT).

* Single layout compile option

See user_config.h lowest reference to MINIFAN_SINGLE_LAYOUT for the why of the how.

* RShift toggles to _RAR when held ≥ 500 ms.

“Qwerty with arrows on BASE”, will need a key to _RAR layer.
It mirrors the behavior of LShift. It is generally useful.

Removed useless user options regarding LShift layer toggle.
It will have to be _PAD.

* Layer switch graphic update per last push.

Forgot to update the default base layer switching graphic.

* Preconfigured optional ‛Command’ hold key to _RAR layer.

This is a third way to reach the _RAR layer, useful if the furthest
right key on row 1 is changed to an uncluttered BASE layer arrow.
This further prepares the way for a Qwerty layout with arrows on BASE.

* Changed ‛Command’ hardware key to TG(_RAR)

MO(_RAR) doesn't work, because it doesn't follow a change in base
layers, which happens on _RAR.

* Corrected wrong all-layers-by-key upload readme.md

* More graphics = more fun: keycap view in readme.

Preparing to integrate a number pad base layer.
Shortened hold time for right/left Shift layer toggles to 200 ms.

* Too light grey for “1470” on three layout graphics.

* Added a numbers pad Base layout option.

This numbers pad layer is in the format of a numbers pad keyboard/cluster.
It has a second layer, which is normal for all Base layers. In this case,
the second layer provides sub-/super-script versions of the numbers, in the
same layout.

* Keycap view numpad improvements.

* Graphics: forgot to cut off southpaw/arrow on two keycap views.

* Preprocessor identifier for “MIT” Planck spacebar.

Trans-minivan preprocessor statements augmented with an identifier
which might work for a Planck keyboard with two unit spacebar.

At this point, the “trans minivan” code only could make porting
to other keyboards less of a chore. It remains untested. Only
visual inspection of the preprocessing regarding the amount of
keys in the layout has been done.

* Tweak of common layout graphic impression.

This would also allow indication of a number pad.

* Improved dual numpad layer & graphics.

All numbers/symbols seem to get affected by NumLock, hence they
all needed to show that in the graphic documentation. Tab was
removed in favor of Numpad ‛=’, and comma replaced by numpad-comma.

* Committing partial job on numpad Base layers.

Hardware problem here, don't want to loose the data.

* Three issues: header file, numpad Base, Tab key.

This should complete previous unexpected commit.

① Documentation and precedent for a base layer with its own header file,
  base_NAME.h. This allows someone writing a new Base layer pair, to
  (un)set user configuration options in user_config.h.

② Numbers pad Base layer added, different variants.
  The common numbers pad also has a new optional layout (square), and can be
  removed by user configuration option (because one might already compile with
  the Base layer numbers pad)..

③ It turns out there was an easy solution to the Tab key anomaly.
  Uncluttered Tab is now located both on BON and ACC layers, on intuitive
  locations opposing Control, which is also in the right spot. Basic
  modifiers for Tab works well now.

* Graphics for Base numpad single square: correction.

Showed wrong insertion key for 'command' / 'south paw' hardware key.
…

* ‛South paw’ default GUI. Graphics. TOC user config.

Made ‛south paw’ be GUI by default.
Improved graphics appearance.
Ordered options in user_config.h, added table of contents.

* User config cleanup & added a compact alternate.

The normal user configuration, which is heavily documented and
therefore a bit unwieldy, can now optionally be done in another
file, without any documentation.

* Base graphics fix, _ACC/_NSY hold switch option

* Added a Qwerty with arrows on base.

Added a graphic in readme for Dvorak descramble (for documentation predictability).

* Put `~ on the _BON layer.

① There was no uncluttered `~ available. On Qwerty Base Arrow
  the `~ key got even more sidelined.

② Improved Qwerty Base Arrow manual.

* Option to harmonize Qwerty with Qwerty Base Arrow

Key ‛/?’ is different on Qwerty Base Arrow, which will lead
to typing arrows for people who have both kinds of Qwerty
running. This option adds this key in the same spot as where
it is on Qwerty Base Arrow, but only if Qwerty Base Arrow is
being compiled.

* See previous commit (Qwerty harmonization)

* Efficiency fix. +Workman layout.

Workman layout added.

Serious efficiency mistakes discovered and fixed:
① There was no check on Delete on Base layer, to see if another
  key had been pressed. Fixed.
② The Shifts on Base did not provide a Shift for the _BON layer
  accented characters. Fixed.

Fixing was painless, proving the code is stable and maintainable.

* Changed Tab/CTL on _ACC/_DRA, μ, T.O.C. readme.md

μ was forgotten (French), added on _ACC.
This caused Tab to get displaced and stacked with Control, which
ends up being better anyway. This also meant _ACC needed Left-Control,
and therefore _DRA needed to switch Tab and Control, because it needs
to complement _ACC with Right-Control (to be able to type all modifiers
with Tab).

➡ Overview graphics are not yet updated. _DRA and _ACC are now out of sync
  in the graphics documentation. To be fixed soon.

Chapter on language support added in readme.

Table of Contents added to readme.

* Updated all graphics (_BON/_DRA Tab/Control/μ).

Some fiddles with readme.

* Led on/off at startup, RAlt on Base option.

It is hard to believe, but the todo que seems empty!

* Minor changes in readme.

* Minor documentation improvement (RAlt/_RAR).

* Minor changes readme.

Removed “not tested yet …”, because that becomes wrong once it is tested.

* Added a blank keycaps graphic.

* Lower saturation letters Dvorak-descramble keycap.

;-]

* One key change in personal keycap graphic.

;-]

* Forgot _NSY layer in keycap qwerty basearrow

* Moved speed/count startup setting in user_config.h

Moved to chapter startup settings.

(These last commits are more like some loose ends with the last
 ongoing topics. It isn't active development, nothing new gets
 started. If QMK requests more changes, even if it is a typo,
 just let me know.)

* Travis Cl: “The LINK_TIME_OPTIMIZATION_ENABLE flag…

… has been renamed to LTO_ENABLE..  Stop.”

Changed it.

* Adds a link to external resources in readme.

A place to put gimp .xcf files if someone wants to
modify/port the keymap. Perhaps links to varieties
of Minifan on github. Maybe a video about the keymap,
and such. Stuff that doesn't belong/fit on github,
and is easy to update without pull requests.

* RGBLIGHT_ENABLE rules.mk fixed, leds off for nop

rules.mk RGBLIGHT_ENABLE can now be set to “no” without issue.

Compile option to have leds off in Default Base layer.

* Transparency bug fixed.

Default layer was not set. This remained a hidden mistake, until Qwerty
Base Arrow had a different layer hold key in one place.

* Graphics doc correction, L/Rshift toggle config

Qwerty Base Arrow fix: Keycap view showed unneeded and empty ‛South Paw’ key.
                       All layers by key shows 45 Minivan version, title said “44”.

Added user configuration options to alter what is on the short and long
toggle on Left and Right Shift.

* Improved “why this layout” in readme.

Wanted to add that numbers & symbols layer can be reached by both
thumbs. It seems quite a drawback if that is not possible, to
constantly need to hold down the same thumb, especially for programming ?
It seemed worthwhile to mention.

* Reduced size of readme, dvorak-descramble, todo.

Stuff got a bit out of hand.

* one letter typo

* renumbered readme, _fun_stay initialization

Renumbered readme chapters to start from 1 not 0. Other minor edits.
Sticky on/off for _FUN layer seemed to be unpredictable on startup.

* Letter Ñ (capital) fix.

I seem to remember messing with this recently,
must have damaged this letter :-(. Capital was missing.

* Bare bones base numpad all layer by key.

I seemed to have forgotten to hide the common layers for this version.
Which doesn't matter a whole lot but this is a bit better and as it was meant.
2021-03-04 11:07:55 -08:00

722 lines
38 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* License (GPL):
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/>.
* © 2019,2020 by Jos Boersema
*
*/
// ------------------------------------- ⬇ --------------------------------------
// Configuration:
// ------------------------------------- ⬇ --------------------------------------
// (For the non-coders: “_Remove_” means to place // in front of a line. The rest of the line becomes a comment.
// Placing // in front of a line, means whatever follows it will be ignored during compilation.
// “_Activate_” means to *delete* the two // in front. Now the rest of the line *will* be compiled
// /* ... */ is another a way to turn “...” into being a comment which is ignored during compilation.
// (The documentation here is geared toward people who have no understanding about programming.)
/*
--------------------------------------------------------------------------------------
----
--
-
Table of Contents:
-0- ➡ Compact configuration file ⬅
-1- ➡ Letters / Numbers & Symbols layouts ⬅
• Qwerty
• Qwerty with Base arrows
• Dvorak
• Dvorak descramble mode
• Colemak
• Workman
• Numpad
-2- ➡ Eviscerations ( ① / ② ) ⬅
• Single layout
-3- ➡ Startup settings ⬅
• Alternate Base
• Leds on/off at startup.
• Speed measuring
• Text size counting ⬅
-4- ➡ How many hardware keys 1st row ⬅
-5- ⚠ ≠ Minivan ⬅
-6- ➡ Defining the meaning of the additional hardware keys ⬅
• Defining the additional key for 'South paw' (also called 'Command')
• Defining 'Arrow' hardware layout additional keys
-7- ➡ Arrows/Navigation cluster ⬅
• Navigation cluster configuration
• VI editor arrows
-8- ➡ Number pad Configuration⬅
-9- ➡ Speed measuring ⬅
-10- ➡ Some alternative keys ⬅
• Right Alt or hold(_RAR) on Base
• GUI left/right
• Alternate currency symbol
• Check boxes or Pointers
• Switch _ACC/_BON and *left* side _NSY/_DRA hold keys
• Switch _PAD and _MOV on Left Shift toggle
• Switch _FUN and _RAR on Right Shift toggle
-11- ➡ Eviscerations ( ② / ② ) ⬅
• Removing the numbers pad _PAD layer
• Removing one or more of the Unicode layers _ACC, _DRA or_BON
• Removing groups of characters
-12- ➡ Leds ⬅
-
--
----
--------------------------------------------------------------------------------------
*/
/* -0- ➡ Compact configuration file ⬅
*
* If you _activate_ this, this whole heavily documented configuration block below
* gets skipped, and instead a bare bones configuration file with all these same options
* gets read. There is no functional difference.
*
* (You can use the compact configuration if you like that better. It can make communicating
* a configuration easier. The fully documented configuration is left in a state of default
* when uploaded to QMK, so that it gives the most commonly used layout: Qwerty with Numpad,
* basic 44 Minivan keys. The compact version its state is whatever it is.)
*/
#define MINIFAN_CONFIG_COMPACT // _Activate_ this, to load the configuration in ./minifan_config_compact.h (note: minifan).
#ifndef MINIFAN_CONFIG_COMPACT // (don't alter this)
/* -1- ➡ Letters / Numbers & Symbols layouts ⬅
*
* Here you can configure what letters layer (BASE layer), and number&symbols layer you
* want. This is a dual layout system, so you can choose a second pair as well. You can
* switch between them with a key on the _RAR layer. All the other layers are the same,
* regardless of your choice in letter/number&symbol layers.
*
* The letters layer is the BASE layer, from which you also reach all other layers.
* The letters it has is the alphabet in its simplest form: abcdefghijklmnopqrstuvwxyz.
* The numbers & symbols layer has what you find on any regular keyboard: 123… !@#… []/…
* The numbers & symbols layer is made to fit the Letters layer, due to small differences
* between layouts like Qwerty and Dvorak (in this case the symbols -, /, ?, and _).
*
* Example: A Qwerty letters layer, with a fitting numbers & symbols layer, as Default.
* A Dvorak letters layer, with a fitting numbers & symbols layer, as Alternate.
*
* You will be asked to configure one layout as Default and another as Alternate.
*
* A bases layout may have locally re-defined one or more of the common layers. If you
* choose two bases layouts who re-define the same common layer locally, you will need
* to choose either one by commenting out the other.
*/
//
// • Qwerty
// (a regular Qwerty layout)
// _Activate_ one of these two, _remove_ the other.
#define BASE_QWERTY__DEF_BASE // _Activate_ if you want Qwerty on the Default spot
//#define BASE_QWERTY__ALT_BASE // _Activate_ if you want Qwerty on the Alternate spot
// Note: you still need to set if you have the additional arrow hardware key. You
// can ignore what it should be defined as, because it will be a plain arrow on Base.
//
// • Qwerty with Base arrows
// (provides direct access to arrows)
// _Activate_ one of these two, _remove_ the other.
//#define BASE_QWERTY_BASEARROW__DEF_BASE // _Activate_ if you want Qwerty with Base arrows on the Default spot
//#define BASE_QWERTY_BASEARROW__ALT_BASE // _Activate_ if you want Qwerty with Base arrows on the Alternate spot
//
// • Dvorak
// (a regular Dvorak layout)
// _Activate_ one of these two, _remove_ the other.
//#define BASE_DVORAK__DEF_BASE // _Activate_ if you want Dvorak on the Default spot
//#define BASE_DVORAK__ALT_BASE // _Activate_ if you want Dvorak on the Alternate spot
//
// • Dvorak descramble mode
// (Dvorak for a computer already remapping to Dvorak)
// This layout is only available on Alternate, because of the special _HALF_ descramble mode.
//#define BASE_DVORAK_DESCRAMBLE__ALT_BASE // _Activate_ if you want Dvorak on the Alternate spot
//
// • Colemak
// (a regular Colemak layout)
// _Activate_ one of these two, _remove_ the other.
//#define BASE_COLEMAK__DEF_BASE // _Activate_ if you want Colemak on the Default spot
//#define BASE_COLEMAK__ALT_BASE // _Activate_ if you want Colemak on the Alternate spot
//
// • Workman
// (a regular Workman layout)
// _Activate_ one of these two, _remove_ the other.
//#define BASE_WORKMAN__DEF_BASE // _Activate_ if you want Workman on the Default spot
//#define BASE_WORKMAN__ALT_BASE // _Activate_ if you want Workman on the Alternate spot
//
// • Numpad
// (a numerical keypad, one for left hand and one for right hand)
// _Activate_ to get Numpad on Alternate. There is no option for Numpad on Default base.
#define BASE_NUMPAD__ALT_BASE // _Activate_ if you want Numpad on the Alternate spot
// ➡ ➡ ➡ This Base layer has configuration options at the top of its file. See ./base_numpad.c
//
/* -2- ➡ Eviscerations ( ① / ② ) ⬅
*/
/* • Single layout
*
* Removes the Alternate base layers, and removes the switch key on _RAR.
* ⚠ You have to not define a Alternate base layer pair. Define only a Default pair.
*/
//#define MINIFAN_SINGLE_LAYOUT // _Activate_ to only have the Default base layers, _remove_ to also have Alternate.
/* -3- ➡ Startup settings ⬅
*/
/* • Alternate Base
*
* You can define which of the two BASE layers is on when powering up the keyboard.
*/
//#define STARTUP_ALTERNATE // Example: For BASES_QWERTY_DVORAK defined: _remove_ is startup in Qwerty, _active_ is
// startup in Dvorak
/* • Leds on/off at startup.
*/
//#define STARTUP_SIDE_LEDS_OFF // _Activate_ to have side leds be off at keyboard startup (when you plug it in / computer powers on).
//#define STARTUP_MID_LED_OFF // _Activate_ to have middle led be off at keyboard startup.
//
/* • Speed measuring
*/
//#define STARTUP_SPEED // _Activate_ for default speed measuring on, _remove_ to set off at startup.
//
/* • Text size counting ⬅
*/
//#define STARTUP_COUNT // _Activate_ for default character/word counting on, _remove_ to set off at startup.
/* -4- ➡ How many hardware keys 1st row ⬅
*
* Define how many keys your keyboard has.
*/
// Default (12x12x12x8 keys)
//'Command' (12x12x12x9 keys) + key on the left
//'Arrow' (12x12x12x9 keys) + key on the right
//'South paw' + 'Arrow' (12x12x12x10 keys)
//#define MORE_KEY__COMMAND // Additional key 1st row on the left. This hardware layout is called 'Command' or 'South paw'.
//#define MORE_KEY__ARROW // Additional key 1st row (counting from row with space-bar) on the right, called 'Arrow' layout.
//
// See below for how to define your additional key(s).
/* -5- ⚠ ≠ Minivan ⬅
*
* This section is for when you want to flash this keymap unto a board with more
* keys than the Minivan has.
*
* Trans-Minivan keymap: 12x12x12x11, 12x12x12x12, 12x12x12x13 keys
* Example board: Planck (12x12x12x12)
*
* It is assumed that you enabled MORE_KEY__ARROW and
* MORE_KEY__COMMAND, to get to 12x12x12x10 keys. With this you
* can get to one, two or three more keys on row 1, without manually
* editing all layers. You could first edit the definition on layers that you have
* a specific meaning for these keys, and let the rest be patched with the definitions
* here.
*
* It can help to inspect the preprocessing with > gcc -E keymap.c | less
*
* Planck keyboard
*
* The identifier TRANSMINIVAN_MIDLEFT could help compile the layout on a Planck keyboard,
* if it has a two unit large spacebar. You compile without TRANSMINIVAN_LEFTSIDE in that case.
* All keys on the left, row 1 (closest to the user) shift one unit to the left, with TRANS_MIDLEFT
* inserted on what would be the left key of the two unit spacebar (assuming that is a key).
*
* Other keyboards formats
*
* It is always possible to just padd the rows somewhere, if you have even more keys. On the other
* hand, to try to cut this layout down to fewer keys than it has at minimum (12x12x12x8), is likely
* going to reduce its functionality, and will require some puzzling to keep a well organized BASE
* layer, and have “hold key” layer switching work correctly.
*
* FIXME: not been compiled or tested for any boards.
*/
//#define TRANSMINIVAN_LAYOUT ....... // Set this to something with the needed amount of keycodes.
// Your values are inserted here: [ _LTR ] = LAYOUT_redefined (
// ^^^^^^^^^^^^^^^^ (throughout all layers)
//#define TRANSMINIVAN_LEFTSIDE // _Activate_ to get yet one more key on the left side row 1
#define TRANS_LEFT XXXXXXX // Define what the TRANSMINIVAN_LEFTSIDE key should be, where it is not otherwise defined.
// (Ignored if TRANSMINIVAN_LEFTSIDE is _removed_).
//
//#define TRANSMINIVAN_MIDLEFT // _Activate_ to get yet one more key on the first key from center, row 1.
#define TRANS_MIDLEFT XXXXXXX // Define what the TRANSMINIVAN_RIGHTSIDE key should be on all layers at once.
// (Ignored if TRANSMINIVAN_MIDLEFT is _removed_).
//
//#define TRANSMINIVAN_RIGHTSIDE // _Activate_ to get yet one more key on the right side row 1
#define TRANS_RIGHT XXXXXXX // Define what the TRANSMINIVAN_RIGHTSIDE key should be, where it is not otherwise defined.
// (Ignored if TRANSMINIVAN_RIGHTSIDE is _removed_).
/* -6- ➡ Defining the meaning of the additional hardware keys ⬅
*
* Some possibilities you might like:
*
* ① Number-pad and F-keys layers are only on a toggle. If you want them accessible on a hold key, you can use
* these additional hardware keys. Make sure to use a transparent key on that location on those layers.
*
* ② You can use the right side additional key for quick access to an arrow/navigation cluster (see below).
*
* ③ Other uses, such as a delete key and/or a special interface key your system needs.
*/
/* • Defining the additional key for 'South paw' (also called 'Command')
*
* Left side additional key. This is ignored if MORE_KEY__COMMAND is not defined.
*/
// Configure here what this key is on the BASE layers (excluding Base Numpad compile option).
//#define MORE_key1_BASE TG ( _RAR ) // _Activate_ this to get a toggle to layer _RAR. MO(_RAR) does not follow a BASE switch by Other Base.
//#define MORE_key1_BASE KC_DEL // Could be useful if you like to toggle to certain layers and stay there for a while.
#define MORE_key1_BASE KC__XGUI // (Default) (Using KC__XGUI makes sure it is the *other* GUI, relative to KC__YGUI.)
//
// Configure here what this key is on all other layers
//#define MORE_key1 KC_DEL // Configure here what this key is on all other layers (and Base Numpad).
#define MORE_key1 KC__XGUI // (Default)
//
//
/* • Defining 'Arrow' hardware layout additional keys
*
* You can create an arrow-cluster with your additional MORE_key2 hardware key on the _MOV layer.
* Either way: this new key can toggle to _MOV layer, with the key that on the _MOV layer becomes the down-arrow,
* in the middle of an arrow cluster. To do that, uncomment MOREKEY2_ARROW_CLUSTER.
* The keys that are by default defined on those keys on _MOV layer, will now be overwritten (they are not typically
* that much used there).
*
* Arrow cluster for 'arrow' layout: _activate_ MOREKEY2_ARROW_CLUSTER and _activate_ #define MORE_key2 _MOV_UP
* No arrow cluster for 'arrow' layout: _remove_ MOREKEY2_ARROW_CLUSTER, and set MORE_key2 to whatever you want.
*/
#define MOREKEY2_ARROW_CLUSTER // Arrow cluster on _MOV layer. This is ignored if MORE_KEY__ARROW is not defined.
// This will cost you 'Right Alt' and 'GUI' on the _MOV layer.
//#define MOREKEY2_ADD_NAVIGATION // Additional navigation keys around arrow cluster MOREKEY2_ARROW_CLUSTER. Ignored if MOREKEY2_ARROW_CLUSTER is not defined.
// Note: this will cause mouse buttons 'BTN4' and 'BTN5' on the _MOV layer to be moved.
/*
* Define the key you want on the additional key. Leave it to _MOV_UP if you want an arrow cluster, easily
* accessed with this key.
*
* If you want to be able to type all arrow cluster keys with both GUI keys, than you cannot have this additional
* arrow cluster around the arrow additional hardware key, because it eats away the GUI just to the left of
* that additional hardware key.
*
* For typing both GUIs with the navigation cluster, you also need the left side additional hardware key. In this
* case, you can still set the optional hardware key on the right to _MOV_UP, but that is marginally useful
* as you already have that on Left Shift.
*
* When aiming to type all normally available keys on a 100% keyboard with all modifiers including GUIs, you
* could use the right hand side optional hardware key (arrow), because it causes the right side GUI to be
* available there. (This kind of stuff affects rare or even never used keyboard shortcuts.)
*/
#define MORE_key2 _MOV_UP // Right side additional key. This is ignored if MORE_KEY__ARROW is not defined.
//#define MORE_key2 KC_DEL // More or less a random suggestion. Harmonizes well with “.DEL” on Numbers Pad.
// It is convenient to have an uncluttered Delete key on the Base layer.
//#define MORE_key2 <...your choice...> // Right side additional key.
//
/* -7- ➡ Arrows/Navigation cluster ⬅
*/
/* • Navigation cluster configuration
*
* _Activate_ below line to use a "WASD" type layout (on the spot where WASD is in Qwerty).
* _Remove_ if you prefer a flat type layout, with arrows in a row, on the right hand.
*/
#define ARROWS_TRIANGLE // Implies mouse is also similarly in a triangle.
/*
* • VI editor arrows
*
* Vi is a famous editor, with its own peculiar text cursor movement arrangement (arrows).
* This option modifies the flat arrows layout on the right hand, to be like the “HJKL”
* arrows in the editor vi(1). “HJKL” meaning: the 7th to 10th key on the 3rd row.
* The arrows on the additional MOREKEY2_ARROW_CLUSTER also get harmonized to be like vi.
*/
//#define VI_SWITCHERYDOO // You have to _remove_ ARROWS_TRIANGLE, or this gets ignored.
/* -8- ➡ Number pad Configuration⬅
*
* This concerns the Numbers Pad layer, which is part of the common layers (not the Bse
* layer, which also has a Numbers Pad option).
*
* There are two compile versions for the number pad layer _PAD, in the common layers.
*
* _Activate_ the below to have the numbers pad _PAD layer resemble the squared layout of
* a numerical keyboard, allowing to type all numbers with the right hand.
* _Remove_ the below to have the numbers in this layer follow the layout of the _NSY layer,
* with the numbers on a line from left to right on the home row, across both hands.
*/
//#define NUMPAD_COMMON_SQUARE // _Activate_ to resemble a one handed numerical keyboard.
/* -9- ➡ Speed measuring ⬅
*/
/*
* Led color configuration. You can see the speed you have configured below directly on the keyboard,
* after you compiled and flashed it.
* Set speed measuring to <off>.
* Hold the 'Report' key for one second, then release. The keyboard prints a number, which is the
* amount of characters per second for which that color is then being shown. Hold it again for
* a second, and it increments. Toggle speed measuring on/off to restart.
* You can play with the below settings until you like the result.
*
* The default values (8, 160 respectively) are starting at blue, avoiding confusion with default
* cyan for BASE layer, going to purple and further avoiding confusion with text size counting.
* Very fast typers could reach red, and then it goes further to yellow, etc.
*/
#define SPEED_COUNTDOWN 25 // After how many keypresses to update the effect(s).
#define SPEED_HUE_STEP 8 // For each key/sec faster, the hue value of HSV goes this step further.
#define SPEED_HUE_START 160 // The starting hue for 0 k/s (0 = 255 = red).
/*
* Speed report in words-per-minute (wpm) rather than keystrokes-per-second (k/s). wpm = k/s * ⁶⁰/₅ = k/s * 12
*/
#define WORDS_PER_MINUTE // _Activate_ to get speed report in words-per-minute, _remove_ to get it in keystrokes-per-second (k/s).
/* -10- ➡ Some alternative keys ⬅
*/
/*
* • Right Alt or hold(_RAR) on Base
*
* _Activate_ below line to get Right-Alt or Alt-Gr (same thing) on Base.
* A short tap results in RAlt briefly pressed, plus Right-Arrow.
* When pressed with another key, however short, results only in RAlt, and no Right-Arrow.
* Held a little longer than tapping it, results in only RAlt being pressed, no Right-Arrow.
*
* _Remove_ to have a layer hold key to the _RAR layer there, instead of RAlt, together with tapped Right-Arrow.
*/
//#define BASE_RIGHT_ALT // _Activate_ to get Right-Alt instead of _RAR on Base layer.
/*
* • GUI left/right
*
* _Activate_ below line to have LGUI (also called OS or Win key, etc) where RGUI is,
* and RGUI where LGUI is.
*/
//#define SWITCH_GUIS // _Activate_ this if you want LGUI on the BASE layer rather than RGUI, despite that spot being on the right.
/*
* • Alternate currency symbol
*
* _Activate_ the below to get a Euro symbol, where ƒ (Dutch Guilder) is on the default map (_DRA layer).
*/
#define UNICODE_CURRENCY 0x20ac // Hex number, euro symbol €. The unicode hex number for position ƒ in the default keymap.
/*
* • Check boxes or Pointers
*
* You can have these symbols (checkboxes): ☐ ☒ ☑ 🗹
* or these (pointers): ⮘ ⮙ ⮚ ⮛
*/
//#define POINT_ON_CHECKBOXES // _Activate_ to get arrows, _remove_ to get checkboxes on _DRA layer.
/*
* • Switch _ACC/_BON and *left* side _NSY/_DRA hold keys
*
* If you type a lot of _ACC layer (accented keys), and not much _DRA layer, you might like to
* switch the _ACC hold key, and the left side _NSY key, if you find it awkward to reach to the
* left with your thumb. These two keys are next to each other. Only the Base layer is affected.
*/
//#define SWITCH_HOLD_ACC_NSY // _Activate_ to switch the *left* _NSY and _ACC layer hold keys, on Base layer.
/*
* • Switch _PAD and _MOV on Left Shift toggle
*
* Recommended if you use _MOV more than _PAD
*/
//#define SWITCH_LSHIFT_PAD_MOV // _Activate_ to make _MOV layer be on the fast tap, and _PAD on a short hold toggle
/*
* • Switch _FUN and _RAR on Right Shift toggle
*
* Recommended if you use _RAR more than _FUN
*/
//#define SWITCH_RSHIFT_FUN_RAR // _Activate_ to make _RAR layer be on the fast tap, and _FUN on a short hold toggle
/* -11- ➡ Eviscerations ( ② / ② ) ⬅
*/
/* • Removing the numbers pad _PAD layer
*
* You may have no use for this common layer, if you have a numerical keypad on the Alternate Base already.
*
* ⚠ Note: ./base_numpad.h can overrides this setting, if compiled with that Base layers.
*/
//#define REMOVE_PAD // _Activate_ to strip out the _PAD layer, _remove_ to have the _PAD layer.
//
/* • Removing one or more of the Unicode layers _ACC, _DRA or_BON
*/
/* Removes the _ACC layer, optionally redirect its key. This can save some 750 bytes.
*/
//#define REMOVE_ACC // _Activate_ to strip out the _ACC layer, _remove_ to have the _ACC layer.
/* Unless REMOVE_ACC is _active_, the next defines which redirect the _ACC key(s) are ignored. */
//#define _ACC_KEY_ALT_LAYER _BON // _Activate_ to make the key(s) that normally goes to _ACC, go to _BON instead.
//#define _ACC_KEY_ALT_LAYER _DRA // _Activate_ to make the key(s) that normally goes to _ACC, go to _DRA instead.
/*
*
* Removes the _DRA layer, optionally redirect its key. Also saves some 750 bytes.
*/
//#define REMOVE_DRA // _Activate_ to strip out the _DRA layer, _remove_ to have the _DRA layer.
/* Unless REMOVE_DRA is _active_, the next defines which redirect the _DRA key(s) are ignored. */
//#define _DRA_KEY_ALT_LAYER _ACC // _Activate_ to make the key(s) that normally goes to _ACC, go to _ACC instead.
//#define _DRA_KEY_ALT_LAYER _BON // _Activate_ to make the key(s) that normally goes to _ACC, go to _BON instead.
/*
*
* Removes the _BON layer, optionally redirect its key. Also saves some 750 bytes.
*/
//#define REMOVE_BON // _Activate_ to strip out the _BON layer, _remove_ to have the _BON layer.
/* Unless REMOVE_BON is _active_, the next defines which redirect the _BON key(s) are ignored. */
//#define _BON_KEY_ALT_LAYER _ACC // _Activate_ to make the key(s) that normally goes to _BON, go to _ACC instead.
//#define _BON_KEY_ALT_LAYER _DRA // _Activate_ to make the key(s) that normally goes to _BON, go to _DRA instead.
/*
*
* • Removing groups of characters
*/
/*
* The below cut out an amount of symbols on a given layer, to simplify and/or reduce firmware size a little.
*/
//#define ALL_DRA_BON_EVISCERATIONS // _Activate_ this to _remove_ the below all at once. (Seems to save only ±114 bytes)
//
#define BOX_DRAWINGS // _Activate_ to get box drawings on _BON. Horizontal lines (━─┄┅) on _DRA are not affected.
// Affected on rows 2 and 3: ┣┫┏┗┃┇┛┓
// Full, 3rd row, boxdr.: Ctrl ① ⬅ ② ⬇ ③ ➡ ④ ┏ ⑤ ┓ ⑥ ┃ ⑦ ┇ ⑧ ╋ ⑨ ⓪ ∞ —
// Full, 2nd row, boxdr.: LSht ÷ ☞ ┗ ≠ ┛ ✗ ┣ ✓ ┫ ⚠ « » RSht
//
// 3rd row, no boxdrawing: Ctrl ① ⬅ ② ⬇ ③ ➡ ④ ⑤ ⑥ ⑦ ⑧ ⑨ ⓪ ∞ —
// 2nd row, no boxdrawing: LSht ÷ ☞ ≠ ✗ ✓ ⚠ « » RSht
//
#define SUB_SCRIPT_NUMS // _Activate_ to get subscript numbers (₁₂₃…₀) on _DRA.
// Affected on row 3: ₁₂₃₄₅₆₇₈₉₀
// Thinned out 3rd row: xxx ¹ ² ³ ⁴ ⁵ ⁶ ⁷ ⁸ ⁹ ⁰ xxx
// Full 3rd row: xxx ¹₁ ²₂ ³₃ ⁴₄ ⁵₅ ⁶₆ ⁷₇ ⁸₈ ⁹₉ ⁰₀ xxx
//
#define FULL_DRA_2NDROW // _Activate_ to have symbols on all unshifted + shifted positions on _DRA, 2nd row.
// Affected: 「 」 § · 🗹 《 》
// Full 2nd row: LSht 「━ 」─ °〇 •§ …· ☐ ☒ ☑ 🗹 ¿¡ 《┄ 》┅ Rsht
// Thinned out 2nd row: LSht ━ ─ ° • … ☐ ☑ ☑ ¿¡ ┄ ┅ RSht
//
#define FULL_DRA_4THROW // _Activate_ to have symbols on all unshifted + shifted positions on _DRA, 4th row.
// Affected 4th row: „ ≤ ≥ ∅ ¢ ƒ ❦ 🙂 🙁 👍 👎 ⁽ ₍ ⁾ ₎
// Full 4th row: BASE “„ ”≤ £≥ ∅ ¢ ±ƒ ❦ ♥ 🙂🙁 👍👎 ⁽₍ ⁾₎ Bkspc
// Thinned out 4th row: BASE “ ” £ ± ♥ Bkspc
//
#define FULL_BON_4THROW // _Activate_ to have symbols on all unshifted + shifted positions on _BON, 4th row.
// Affected 4th row: 🛠 ¤ ∑ ‱ ٭ 😊 ⍨ ⃰ ⁻ ⁺ 🄯 ©
// Full 4th row: BASE ‛🛠 ’⬆ ¤ 🄯 ∑ © ‰‱ ★٭ 😊⍨ × ⃰ √ ⁻⁺ Bkspc
// Thinned out 4th row: BASE ’⬆ ‰ ★ × Bkspc
//
/* -12- ➡ Leds ⬅
*
* Leds off for the Default Base Layer.
* Implies: no indication on Default Base for: Caps-lock, typing speed, typing amount done of a limit.
* Speed / typing amount will be visible by going to another layer.
*/
//#define LEDS_OFF_BASE_DEF // _Activate_ to make leds dark when in Default Base layer.
// ------------------------------------- ⬆ --------------------------------------
// Below here no more comfortable configuration options.....
// There may be configuration options in the layout ./bases_....h file you chose.
// ------------------------------------- ⬆ --------------------------------------
#else // (ignore this)
# include "./minifan_config_compact.h"
#endif // MINIFAN_CONFIG_COMPACT
// ------------------------------------- ⬇ --------------------------------------
// Base layer headers
// ------------------------------------- ⬇ --------------------------------------
// * Numpad *
# if defined(BASE_NUMPAD__ALT_BASE)
# include "./base_numpad.h" // Numbers pad header
# endif
// * Qwerty Base Arrow *
# if defined(BASE_QWERTY_BASEARROW__DEF_BASE) || defined(BASE_QWERTY_BASEARROW__ALT_BASE)
# include "./base_qwerty_basearrow.h" // Your Keymap header/configuration file.
# endif
// // ⬇ insert your ./base_YOUR_KEYMAP.h #include here:
// * YOUR KEYMAP *
// # if defined(BASE_YOUR_KEYMAP__DEF_BASE) || defined(BASE_YOUR_KEYMAP__ALT_BASE)
// # include "./base_YOUR_KEYMAP.h" // Your Keymap header/configuration file.
// # endif
// // ⬆
// ------------------------------------- ⬆ --------------------------------------
// Base layer headers are best #included here, so the preprocessor statements
// following the user configuration block can pick up on anything that was set.
//
// Example: base_numpad.h _activate_ REMOVE_PAD. Based upon that, the preprocessor
// constant _PAD is changed into _FUN in the below statements.
// ------------------------------------- ⬆ --------------------------------------
// The below sets some things up based on the above #defines.
// This is sort of a hack. It re-defines _ALT_BASE and _ALT_NSY to point to the same
// layer as _DEF_BASE and _DEF_NSY, because there are quite a few references to the
// former and putting #if then around each one complicated the code even more. If needed,
// it can be changed later. This option already reduces firmware size, so we should be
// well below the maximum.
# ifdef MINIFAN_SINGLE_LAYOUT
# define _ALT_BASE _DEF_BASE
# define _ALT_NSY _DEF_NSY
# endif
// This triggers the compilation of special _HALF_ descramble mode, where you access
// the Unicode layers without passing them through the descramble system (middle led
// lit on _RAR_ when cycling through the base layers with Other Base key).
# ifdef BASE_DVORAK_DESCRAMBLE__ALT_BASE
# define DVORAK_DESCRAMBLE_HALF
# endif
// Prevent likely erroneous configuration. If no 'Arrow' hardware layout, then not patching in an arrow cluster.
# if !defined(MORE_KEY__ARROW) && defined(MOREKEY2_ARROW_CLUSTER)
# undef MOREKEY2_ARROW_CLUSTER
# endif
# if !defined(MORE_KEY__ARROW) && defined(MOREKEY2_ADD_NAVIGATION)
# undef MOREKEY2_ADD_NAVIGATION
# endif
# if !defined(MOREKEY2_ARROW_CLUSTER) && defined(MOREKEY2_ADD_NAVIGATION)
# undef MOREKEY2_ADD_NAVIGATION // Only navigation keys, when the are arrows defined.
# endif
// When choosing 'triangle' arrows, then they go left. Not 'triangle' arrows, than right.
# ifdef ARROWS_TRIANGLE
/* _Activate_ below line to put the arrows on the left, comment out to have arrows right. */
# define ARROWS_LEFT // Implies mouse is right
# endif
// Set up user GUI choice:
# ifndef SWITCH_GUIS
# define KC__XGUI KC_LGUI // Name logic is alphabetic order left to right …X (…) …Y in layout definitions..
# define KC__YGUI KC_RGUI // .. meaning KC__XGUI is left on the keymap, KC__YGUI is right.
# endif
# ifdef SWITCH_GUIS
# define KC__XGUI KC_RGUI
# define KC__YGUI KC_LGUI
# endif
// Define the layout macro for the amount of hardware keys.
// These for Minivan are defined up in the code tree.
# if !defined(MORE_KEY__COMMAND) && !defined(MORE_KEY__ARROW)
# define LAYOUT_redefined LAYOUT // Default (8 keys on 1st row)
# endif
# if !defined(MORE_KEY__COMMAND) && defined(MORE_KEY__ARROW)
# define LAYOUT_redefined LAYOUT_arrow // Additional key 1st row on the right. 'Arrow'
# endif
# if defined(MORE_KEY__COMMAND) && !defined(MORE_KEY__ARROW)
# define LAYOUT_redefined LAYOUT_command // Additional key 1st row on the left. 'Command'
# endif
# if defined(MORE_KEY__COMMAND) && defined(MORE_KEY__ARROW)
# define LAYOUT_redefined LAYOUT_arrow_command // Additional keys 1st row both left and right. 'Arrow' + 'Command'
# endif
# ifdef TRANSMINIVAN_LAYOUT
# undef LAYOUT_redefined
# define LAYOUT_redefined TRANSMINIVAN_LAYOUT
# endif
// Process user config setting for speed measuring
# ifdef STARTUP_SPEED
# define SPEED_INIT_VALUE TRUE
# else
# define SPEED_INIT_VALUE FALSE
# endif
// Process user config setting for text size measuring
# ifdef STARTUP_COUNT
# define COUNT_INIT_VALUE TRUE
# else
# define COUNT_INIT_VALUE FALSE
# endif
// Get all key reductions at once
# ifdef ALL_DRA_BON_EVISCERATIONS
# ifdef BOX_DRAWINGS
# undef BOX_DRAWINGS
# endif
# ifdef SUB_SCRIPT_NUMS
# undef SUB_SCRIPT_NUMS
# endif
# ifdef FULL_DRA_2NDROW
# undef FULL_DRA_2NDROW
# endif
# ifdef FULL_DRA_4THROW
# undef FULL_DRA_4THROW
# endif
# ifdef FULL_BON_4THROW
# undef FULL_BON_4THROW
# endif
# endif
// This resolves compiling “TO (_BON)” on the _FUN layer.
# ifdef REMOVE_BON
# undef _BON
# ifdef _BON_KEY_ALT_LAYER
# define _BON _BON_KEY_ALT_LAYER // To what user wants
# else
# define _BON _FUN // void behavior
# endif
# endif
// This resolves compiling “TO (_PAD)” on the _FUN layer.
# ifdef REMOVE_PAD
# undef _PAD
# define _PAD _FUN // void behavior
# endif
// If the _ACC layer hold key has no function anymore because the layers _ACC and _BON to which it
// switches have been removed, and no alternative use been set, that key reverts to being KC_DEL,
// and the whole macro CHOLTAP_ACCE it normally activates gets cut.
# if defined(REMOVE_ACC) \
&& !defined(_ACC_KEY_ALT_LAYER) \
&& defined(REMOVE_BON) \
&& !defined(_BON_KEY_ALT_LAYER)
# define CHOLTAP_ACCE KC_DEL // replaces in the keymap
# define CHOLTAP_ACCE_NOP // cuts CHOLTAP_ACCE out of macros
# endif
// Here all Unicode layers _ACC, _DRA and _BON have been removed, and none of their key(s) has
// been re-assigned to a useful purpose. That makes that whole system redundant, so it is simplified.
# if defined(REMOVE_ACC) \
&& !defined(_ACC_KEY_ALT_LAYER) \
&& defined(REMOVE_DRA) \
&& !defined(_DRA_KEY_ALT_LAYER) \
&& defined(REMOVE_BON) \
&& !defined(_BON_KEY_ALT_LAYER)
# define CHOLTAP_ACCE KC_DEL // replaces in the keymap
# define CHOLTAP_ACCE_NOP // cuts CHOLTAP_ACCE out of macros
# define DUO_HOLD_BASIC // cuts out the long DUO_HOLD macro, replaces it with a simple 'descramble'-aware hold(_NSY/_DDN)
# endif