Skip to content

Commit

Permalink
v1-2-0 Layout/Settings UI
Browse files Browse the repository at this point in the history
* Layout/Settings User Interface
* Layout folder restructuring to aid the Layout Picker UI
* Local layout file remaps allow for easier layout testing
* Some Ext-mod reworks to better their performance
  • Loading branch information
DreymaR committed Jan 2, 2021
1 parent b8495cf commit 5469310
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ DreymaR's Big Bag Of Keyboard Tricks - EPKL
* Most of my Big Bag "tricks" are implemented for EPKL, as layouts and other files.
* Some non-EPKL BigBag stuff can be found in the Other folder.
* Info about DreymaR's Big Bag of keyboard trickery is mainly found on the Colemak forum:
- The [Big Bag main topic][CmkBBT] with better explanations and links.
- Daughter topics for implementations, including the [Big Bag for EPKL/Windows][CmkPKL] one.
- The [Big Bag main topic][CmkBBT] with better explanations and links.
- Daughter topics for implementations, including the [Big Bag for EPKL/Windows][CmkPKL] one.

These Aren't The Guides You're Looking For?
-------------------------------------------
Expand All @@ -43,7 +43,8 @@ Getting EPKL up and running
* To use the chosen layout(s) and settings, select the Refresh EPKL menu option.
* By default, help images show up when modifiers are pressed. Change the `img_HideStates` setting from `0` to `-` to always show images.
* This image shows the EPKL tray menu. Right-click the `Co` icon in the lower right corner of your screen, maybe via 'show hidden icons'.
![EPKL tray menu](./Other/Docs/EPKL_Tray-Menu.png)

![EPKL tray menu](./Other/Docs/EPKL_Tray-Menu.png)

More Know-How
-------------
Expand Down Expand Up @@ -95,7 +96,8 @@ The layouts and setup files may take a little tweaking to get what you want. The
- I haven't made images for all variants though, so there may be minor discrepancies.
* Layout folders aren't premade for every variant, board and mod combo, as there are so many of them. See below.
* The Layout/Settings dialog can change layout, key mappings and a selection of settings. Here's a mapping example:
![EPKL settings dialog](./Other/Docs/EPKL_Settings-UI.png)

![EPKL settings dialog](./Other/Docs/EPKL_Settings-UI.png)

**Hotkeys found in the EPKL_Settings file:**
* Ctrl+Shift+1 – Display/hide the help image
Expand Down Expand Up @@ -354,23 +356,22 @@ These are some of the changes in [EPKL] (PKL[eD] up to v1):
- The Key Mapper UI reads KeyLayoutMap (KLM) names from the Remap file. Keys not in the selection box may be edited manually into the text fields.
- Select row then code to remap, then the same for the VK code that you're mapping to. Then mapping type. Finally, edit any state mappings etc. manually.
- For most modifiers, you can select Left/Right or use the generic mod. The modifier is used in Mod, Tap-or-Mod (ToM) and MoDK mappings.
- The mapping is written into the `Layouts_Override` file. If that key is also mapped in your (Base)Layout.ini, copy the line to `layout.ini` or it won't work.
- The mapping is written into the `Layouts_Override` file. If that key is also mapped in your (Base)Layout.ini, write the line to `layout.ini` or it won't work.
- Added a `Write to layout.ini` button to the KeyMapper. Such mappings will override other LayStack mappings. The default Submit button writes to `Layout_Override`.
- The Settings UI lets you choose between several EPKL settings. It shows their current value and any same-line comments. Edit their value and submit.
- The UI-adjustable settings have to be in the `Settings_Default` file and specified in the "setInGUI" entry of the `EPKL_Tables.ini` file.
- Switching Slash and Backslash for Wide modded Extend brings the WheelLeft/Right keys together. Used it for Colemak-CAWS-ISO. Less intuitive for (C)AWide Ext2.
- Added a `LayMain(\3LA)` setting and `@M` shortcut for the main layout in the Layouts files. It may specify a 3-Letter Abbreviation (3LA) for subfolder names.
- If not set directly, the 3-Letter Abbreviation is found from the Tables file. Failing that, the three first letters of LayMain are used.
- Added a 'hideImageState' setting to hide certain help image shift states. Some users may want only AltGr, Extend and dead key images to show.
- Remaps and RemapCycle sections are now allowed in the LayStack. See the `_Test\Cmk-eD-Nyfee_ANS_CurlAngle` layout for an example.
- Added a `Write to layout.ini` button to the KeyMapper. Such mappings will override other LayStack mappings. The default Submit button writes to `Layout_Override`.
- Detection of current system layout VK codes through GetKeyVK().
- This makes `key = VKey` mappings work as intended, enabling for instance Extend to see and use a key without changing its system layout mapping.
- Added "System-VK" throughput layouts for Extend etc. users using VKey mappings. Ergomaps would also work on it. One could also remap some keys with states.
- Non-Scandinavian installed ISO layouts such as the UK one, should now get the right VK codes detected for OEM_# symbol keys.
- If the underlying system layout is changed while running EPKL, for now you should Refresh EPKL to get the codes reread correctly.
- QWERTZ and especially AZERTY are special in that they require some letter remaps too. There are remaps for them in the Remaps file but no layouts using those.
- Fixed: Some Ext-Shift presses would get lost, especially after having pressed Ext-Ctrl.

- Updated the non-Wide Sym and ANSI CAWS to the latest versions. ISO and ANSI are the same now. The non-Wide variants swap brackets with minus/plus.


Expand Down
5 changes: 2 additions & 3 deletions Source/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,8 @@ DONE:
- The Key Mapper UI reads KeyLayoutMap (KLM) names from the Remap file. Keys not in the selection box may be edited manually into the text fields.
- Select row then code to remap, then the same for the VK code that you're mapping to. Then mapping type. Finally, edit any state mappings etc. manually.
- For most modifiers, you can select Left/Right or use the generic mod. The modifier is used in Mod, Tap-or-Mod (ToM) and MoDK mappings.
- The mapping is written into the `Layouts_Override` file. If that key is also mapped in your (Base)Layout.ini, copy the line to `layout.ini` or it won't work.
- The mapping is written into the `Layouts_Override` file. If that key is also mapped in your (Base)Layout.ini, write the line to `layout.ini` or it won't work.
- Added a `Write to layout.ini` button to the KeyMapper. Such mappings will override other LayStack mappings. The default Submit button writes to `Layout_Override`.
- The Settings UI lets you choose between several EPKL settings. It shows their current value and any same-line comments. Edit their value and submit.
- The UI-adjustable settings have to be in the `Settings_Default` file and specified in the "setInGUI" entry of the `EPKL_Tables.ini` file.
- To allow the Settings UI to work, EPKL can now use a Settings Override/Default stack (like with the Layouts files) instead of just `EPKL_Settings.ini`.
Expand All @@ -283,7 +284,6 @@ DONE:
- Remaps and RemapCycle sections are now allowed in the LayStack. See the `_Test\Cmk-eD-Nyfee_ANS_CurlAngle` layout for an example.
- LayStack Remaps and cycles will only be checked for if their sections are present in `layout.ini`. This is to avoid slowing down other layouts.
- The Nyfee Colemak-DH mods were added to test LayStack remaps. His mods move `Z W X C F K (V)` and the Bracket/Minus/Equals keys.
- Added a `Write to layout.ini` button to the KeyMapper. Such mappings will override other LayStack mappings. The default Submit button writes to `Layout_Override`.
- Detection of current system layout VK codes through GetKeyVK().
- This makes `key = VKey` mappings work as intended, enabling for instance Extend to see and use a key without changing its system layout mapping.
- Added "System-VK" throughput layouts for Extend etc. users using VKey mappings. Ergomaps would also work on it. One could also remap some keys with states.
Expand All @@ -294,7 +294,6 @@ DONE:
- Fixed: If a remap (cycle?) wasn't mapped to a cycle, it could lead to an infinite loop in ReadRemaps().
- Fixed: Some Ext-Shift presses would get lost, especially after having pressed Ext-Ctrl.
- Reworked extendKeyPress() to avoid this. Also let the Janitor clean up idle Ext-mods to be sure.

- Reworked Extend modifiers further, to send with the AHK prefixes `+^!#` instead of holding down modifier keys. Seems smoother. Also, releasing Ext sends mods up.
- Updated the non-Wide Sym and ANSI CAWS to the latest versions. ISO and ANSI are the same now. The non-Wide variants swap brackets with minus/plus.
- Cz (Czech) ANSI variants. With no ISO key for Ůů, it was mapped to AltGr+Uu. There's optionally a map line to swap J and Z if desired, but it's non-standard.
Expand Down
7 changes: 3 additions & 4 deletions Source/Source_EPKL/_PKL_main.ahk
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,8 @@
; - The Key Mapper UI reads KeyLayoutMap (KLM) names from the Remap file. Keys not in the selection box may be edited manually into the text fields.
; - Select row then code to remap, then the same for the VK code that you're mapping to. Then mapping type. Finally, edit any state mappings etc. manually.
; - For most modifiers, you can select Left/Right or use the generic mod. The modifier is used in Mod, Tap-or-Mod (ToM) and MoDK mappings.
; - The mapping is written into the `Layouts_Override` file. If that key is also mapped in your (Base)Layout.ini, copy the line to `layout.ini` or it won't work.
; - The mapping is written into the `Layouts_Override` file. If that key is also mapped in your (Base)Layout.ini, write the line to `layout.ini` or it won't work.
; - Added a `Write to layout.ini` button to the KeyMapper. Such mappings will override other LayStack mappings. The default Submit button writes to `Layout_Override`.
; - The Settings UI lets you choose between several EPKL settings. It shows their current value and any same-line comments. Edit their value and submit.
; - The UI-adjustable settings have to be in the `Settings_Default` file and specified in the "setInGUI" entry of the `EPKL_Tables.ini` file.
; - To allow the Settings UI to work, EPKL can now use a Settings Override/Default stack (like with the Layouts files) instead of just `EPKL_Settings.ini`.
Expand All @@ -207,7 +208,6 @@
; - Remaps and RemapCycle sections are now allowed in the LayStack. See the `_Test\Cmk-eD-Nyfee_ANS_CurlAngle` layout for an example.
; - LayStack Remaps and cycles will only be checked for if their sections are present in `layout.ini`. This is to avoid slowing down other layouts.
; - The Nyfee Colemak-DH mods were added to test LayStack remaps. His mods move `Z W X C F K (V)` and the Bracket/Minus/Equals keys.
; - Added a `Write to layout.ini` button to the KeyMapper. Such mappings will override other LayStack mappings. The default Submit button writes to `Layout_Override`.
; - Detection of current system layout VK codes through GetKeyVK().
; - This makes `key = VKey` mappings work as intended, enabling for instance Extend to see and use a key without changing its system layout mapping.
; - Added "System-VK" throughput layouts for Extend etc. users using VKey mappings. Ergomaps would also work on it. One could also remap some keys with states.
Expand All @@ -218,14 +218,13 @@
; - Fixed: If a remap (cycle?) wasn't mapped to a cycle, it could lead to an infinite loop in ReadRemaps().
; - Fixed: Some Ext-Shift presses would get lost, especially after having pressed Ext-Ctrl.
; - Reworked extendKeyPress() to avoid this. Also let the Janitor clean up idle Ext-mods to be sure.

; - Reworked Extend modifiers further, to send with the AHK prefixes `+^!#` instead of holding down modifier keys. Seems smoother. Also, releasing Ext sends mods up.
; - Updated the non-Wide Sym and ANSI CAWS to the latest versions. ISO and ANSI are the same now. The non-Wide variants swap brackets with minus/plus.
; - Cz (Czech) ANSI variants. With no ISO key for Ůů, it was mapped to AltGr+Uu. There's optionally a map line to swap J and Z if desired, but it's non-standard.


setPklInfo( "pklName", "EPiKaL Portable Keyboard Layout" ) ; PKL[edition DreymaR] -> EPKL
setPklInfo( "pklVers", "1.2." ) ; EPKL Version (was PKL[eD] until v0.4.8)
setPklInfo( "pklVers", "1.2.0" ) ; EPKL Version (was PKL[eD] until v0.4.8)
setPklInfo( "pklComp", "DreymaR" ) ; Compilation info, if used
setPklInfo( "pkl_URL", "https://github.com/DreymaR/BigBagKbdTrixPKL" ) ; http://pkl.sourceforge.net/

Expand Down

0 comments on commit 5469310

Please sign in to comment.