diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 03945b8..5132220 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -4,12 +4,12 @@ on: push: branches: [main] paths: - - 'EurKey-macOS.bundle/**' + - 'EurKEY-Next.bundle/**' - 'scripts/**' - 'spec/**' pull_request: paths: - - 'EurKey-macOS.bundle/**' + - 'EurKEY-Next.bundle/**' - 'scripts/**' - 'spec/**' @@ -40,5 +40,5 @@ jobs: - name: upload DMG uses: actions/upload-artifact@v4 with: - name: EurKEY-macOS-DMG + name: EurKEY-Next-DMG path: build/*.dmg diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e0eeba0..a9cc2fd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -39,33 +39,49 @@ jobs: - name: create GitHub release uses: softprops/action-gh-release@v2 with: - name: EurKEY-macOS ${{ steps.version.outputs.version }} - files: build/EurKEY-macOS-${{ steps.version.outputs.version }}.dmg + name: EurKEY Next ${{ steps.version.outputs.version }} + files: build/EurKEY-Next-${{ steps.version.outputs.version }}.dmg body: | - ## Changes + ## EurKEY Next - - Fix modifier key order to Apple canonical: Option+Shift (not Shift+Option) - - Add EU badge template icons for v1.2, v1.3, v1.4 matching Apple's built-in style - - Add icon build pipeline from SVG source - - Add interactive keyboard viewer to website - - Add layout PDF downloads to website - - Replace Hugo with lightweight static website - - Fix Greek dead key terminator (Ω → α) to match official spec - - Enable CapsLock language switch for all layouts - - Rename create-dmg.sh → build-dmg.sh + - **ANSI compatibility:** the ISO-only key between left Shift and Z does not exist on ANSI keyboards. Its characters § and ± are now accessible via the `⌥\` dead key (`⌥\` `s` → §, `⌥\` `S` → ±). + - Normalize Caps Lock: Caps Lock = Shift, no special bindings. + - Configure every key exactly as printed on the MacBook keyboard (ISO, English International). + - Remove distinction between left/right modifier keys. + - Rename all dead key states to their initializing key combination for easier identification. + - Fix Greek dead key terminator (Ω → α) to match official EurKEY spec. + - Fix modifier key order to Apple canonical: Option+Shift (not Shift+Option). + - Clean up duplicate dead key compositions. + - Change Mathematicians (`⌥⇧m`) dead key terminator from invisible space to 𝕄. + + ## v1.4 + + - Normalize Caps Lock: Caps Lock = Shift, no special bindings. + - Fix accidental Caps Lock changes from previous release. + + ## v1.3 + + - Normalize Caps Lock: Caps Lock = Shift, no special bindings. + + ## v1.2 + + - Normalize Caps Lock: Caps Lock = Shift, no special bindings. + + ## Project + + - Rename v2.0 → EurKEY Next. + - Rename bundle to `EurKEY-Next.bundle`. + - New lightweight static website at eurkey-macos.eu. + - Interactive keyboard viewer with modifier layer preview and dead key compositions. + - Layout PDF downloads. + - New monochrome macOS template icon. + - Restructure project with automated build, validation, and release pipelines. ## Installation - 1. Download `EurKEY-macOS-${{ steps.version.outputs.version }}.dmg` + 1. Download `EurKEY-Next-${{ steps.version.outputs.version }}.dmg` 2. Open the DMG - 3. Drag `EurKey-macOS.bundle` to the `Install Here (Keyboard Layouts)` folder + 3. Drag `EurKEY-Next.bundle` to the `Install Here (Keyboard Layouts)` folder 4. Log out and back in (or restart) - 5. System Settings → Keyboard → Input Sources → Add → Select EurKEY - - ## Included layouts - - - **EurKEY v1.2** — legacy version - - **EurKEY v1.3** — official spec implementation - - **EurKEY v1.4** — v1.3 with ẞ on Caps+§ - - **EurKEY v2.0** — custom edition - generate_release_notes: true + 5. System Settings → Keyboard → Input Sources → Add → Select EurKEY Next + generate_release_notes: false diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index 9d34d35..fec567e 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -38,7 +38,9 @@ jobs: - name: Generate layout JSON run: | mkdir -p eurkey-macos.eu/data - for ver in v1.2 v1.3 v1.4 v2.0; do + python3 scripts/parse_keylayout.py "src/keylayouts/EurKEY Next.keylayout" \ + -o "eurkey-macos.eu/data/eurkey-next.json" + for ver in v1.2 v1.3 v1.4; do python3 scripts/parse_keylayout.py "src/keylayouts/EurKEY ${ver}.keylayout" \ -o "eurkey-macos.eu/data/eurkey-${ver}.json" done diff --git a/README.md b/README.md index 24a8542..bc37ad4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# EurKEY-macOS +# EurKEY Next The keyboard layout for Europeans, coders, and translators. This repo contains a **modified version** of the EurKEY base layout for macOS, bundling multiple versions so users can pick what they need. -EurKEY-macOS targets MacBooks with the physical English International keyboard (ISO) instead of the ANSI layout from the official upstream. Since it is an ISO layout, it has one additional key (`` ` ``) and the big Enter key. +EurKEY Next works with both ISO and ANSI keyboards. It targets the physical English International keyboard found on European MacBooks (ISO) but is fully compatible with US ANSI keyboards. The ISO key between left Shift and Z (**`§`**/**`±`**) does not exist on ANSI — these characters are accessible via the **`⌥\`** dead key: **`⌥\`** **`s`** → §, **`⌥\`** **`S`** → ±. The keyboard layout should be compatible with the other ISO layouts typically available in Europe (e.g., German ISO). However, the printed keys will obviously be different. I tested the layout on the current tenkeyless MacBook keyboard (MacBook Air 2024). Working numpad keys are therefore not guaranteed. @@ -10,34 +10,34 @@ The keyboard layout should be compatible with the other ISO layouts typically av The bundle ships 4 layout versions: -| Version | Description | -| ------- | ----------- | -| **v1.3** | Official EurKEY spec implementation. **Recommended for most users.** | -| **v1.2** | Legacy version based on [Leonardo Schenkel's port](https://github.com/lbschenkel/EurKEY-Mac). Predates the v1.3 spec (no `¬` dead key, `§` instead of `ẞ` on Option+Shift+S). | -| **v1.4** | v1.3 with `ẞ` (capital sharp s) on Caps+`§` key. | -| **v2.0** | Custom edition — complete rework. Every key configures exactly as printed on the MacBook keyboard. Removes left/right modifier key distinction. New monochrome template icon. | +| Version | Description | +| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **EurKEY Next** | Every key configures exactly as printed on the MacBook keyboard. Removes left/right modifier key distinction. Monochrome template icon. | +| **v1.4** | v1.3 with swapped super/subscript numbers: **`⌥m`** **`1`**…**`0`** produces subscript (₁…₀), **`⌥m`** **`⇧1`**…**`⇧0`** produces superscript (¹…⁰). | +| **v1.3** | Official EurKEY spec implementation. | +| **v1.2** | Legacy version based on [Leonardo Schenkel's port](https://github.com/lbschenkel/EurKEY-Mac). Predates the v1.3 spec (no **`⌥\`** dead key, § instead of ẞ on **`⌥⇧S`**). | ## Installation -### From DMG (recommended) +### From DMG -1. Download the latest `EurKEY-macOS-YYYY.MM.DD.dmg` from [Releases](https://github.com/felixfoertsch/EurKEY-macOS/releases). +1. Download the latest `EurKEY-Next-YYYY.MM.DD.dmg` from [Releases](https://github.com/felixfoertsch/EurKEY-macOS/releases). 2. Open the DMG. -3. Drag `EurKey-macOS.bundle` to the `Install Here (Keyboard Layouts)` folder. +3. Drag `EurKEY-Next.bundle` to the `Install Here (Keyboard Layouts)` folder. 4. Log out and back in (or restart). -5. System Settings → Keyboard → Input Sources → click `+` → select the EurKEY version you want. +5. System Settings → Keyboard → Input Sources → click `+` → select EurKEY Next. ### Manual 1. Download or clone this repo. -2. Copy `EurKey-macOS.bundle` to `/Library/Keyboard Layouts/` (system-wide) or `~/Library/Keyboard Layouts/` (user-only). +2. Copy `EurKEY-Next.bundle` to `/Library/Keyboard Layouts/` (system-wide) or `~/Library/Keyboard Layouts/` (user-only). 3. Log out and back in. -4. System Settings → Keyboard → Input Sources → click `+` → select EurKEY. +4. System Settings → Keyboard → Input Sources → click `+` → select EurKEY Next. System preferences showing the edit button for input sources. Dialogue to add a new input source. -EurKEY in the input sources list. -Selecting EurKEY from the menu bar dropdown. +EurKEY Next in the input sources list. +Selecting EurKEY Next from the menu bar dropdown. ## Validation @@ -48,7 +48,7 @@ The project includes automated validation to catch regressions. The validation s python3 scripts/validate_layouts.py # parse a single layout to JSON -python3 scripts/parse_keylayout.py "EurKey-macOS.bundle/Contents/Resources/EurKEY v1.3.keylayout" --summary +python3 scripts/parse_keylayout.py "EurKEY-Next.bundle/Contents/Resources/EurKEY v1.3.keylayout" --summary # build the bundle (validates + generates Info.plist) bash scripts/build-bundle.sh @@ -57,33 +57,23 @@ bash scripts/build-bundle.sh bash scripts/build-dmg.sh ``` -## Dead key compositions (v2.0) +## Dead key compositions (EurKEY Next) -v2.0 renames all dead key states to their initializing key combination: +EurKEY Next renames all dead key states to their initializing key combination: | Key combination | Dead key symbol | | --------------- | --------------- | -| ⌥`` ` `` | `` ` `` | -| ⌥⇧`` ` `` | ~ | -| ⌥' | ´ | -| ⌥⇧' | ¨ | -| ⌥6 | ^ | -| ⌥⇧6 | ˇ | -| ⌥7 | ˚ | -| ⌥⇧7 | ¯ | -| ⌥m | α | -| ⌥⇧m | 𝕄 | -| ⌥\ | ¬ | - -## Customization with Karabiner-Elements - -macOS `.keylayout` files cannot distinguish between the FN key and other modifiers, and cannot remap FN to act as a custom modifier. To use FN (or any other key) as an additional modifier layer, use [Karabiner-Elements](https://karabiner-elements.pqrs.org/): - -1. Install Karabiner-Elements. -2. In **Simple Modifications**, remap `fn` to a modifier key (e.g., `right_option`). -3. In **Complex Modifications**, add rules that map your desired key combinations to Unicode character outputs. - -[Hammerspoon](https://www.hammerspoon.org/) is an alternative for Lua-based automation but does not intercept keystrokes at the same level as Karabiner. +| **`` ⌥` ``** | `` ` `` | +| **`` ⌥⇧` ``** | ~ | +| **`⌥'`** | ´ | +| **`⌥⇧'`** | ¨ | +| **`⌥6`** | ^ | +| **`⌥⇧6`** | ˇ | +| **`⌥7`** | ˚ | +| **`⌥⇧7`** | ¯ | +| **`⌥m`** | α | +| **`⌥⇧m`** | 𝕄 | +| **`⌥\`** | ¬ | ## Known issues @@ -100,50 +90,6 @@ Template icons switch color with the system theme (dark/light). Ukelele's GUI ch The build script (`scripts/build-bundle.sh`) generates `Info.plist` with this flag set correctly for all layout versions. -## Changelog - -### v2.0 (WIP) - -#### Layout - -- Configure every key exactly as printed on the MacBook keyboard (ISO, English International). -- Remove distinction between left/right modifier keys. -- Rename all dead key states to their initializing key combination for easier identification. -- Fix Greek dead key terminator (`Ω` → `α`) to match official EurKEY spec. -- Fix modifier key order to Apple canonical: Option+Shift (not Shift+Option). -- Enable CapsLock language switch for all layouts. -- Remove duplicate compositions: `§` from Navigators, `±` from Option+Shift+§, `±` from Mathematicians on `-`, terminator duplicates on `5`. -- Change Mathematicians (⌥⇧m) dead key terminator from invisible space to `𝕄`. - -#### Website - -- Replace Hugo with lightweight static website. -- Add interactive keyboard viewer with modifier layer preview, dead key compositions. -- Support multiple dead keys per key with click cycling (e.g., key 6: circumflex → háček → exit). -- Add layout PDF downloads. -- Add EU badge template icons for v1.2, v1.3, v1.4 matching Apple's built-in keyboard layout icon style. -- Add SVG feature card icons (dead keys, ISO enter, versions, install). - -#### DevOps - -- Use `*.bundle` format to group layout versions. -- Restructure project: track `src/`, `fonts/` as source, generate bundle at build time. -- Add `build-bundle.sh`, `build-dmg.sh`, `build-icons.sh`, `validate_layouts.py`, `parse_keylayout.py`. -- Add GitHub Actions workflows for build, release, website deployment. -- Add new monochrome macOS template icon that switches color with the system theme. - -### v1.4 - -- Adds `ẞ` (capital sharp s) on Caps+`§` key. - -### v1.3 - -- Implements the layout according to [spec](https://eurkey.steffen.bruentjen.eu/changelog.html). Based on [Leonardo Schenkel's version 1.2](https://github.com/lbschenkel/EurKEY-Mac). - -### v1.2 - -- Original macOS port by [Leonardo Brondani Schenkel](https://github.com/lbschenkel/EurKEY-Mac). - ## Attribution The original EurKEY layout is by [Steffen Brüntjen](https://eurkey.steffen.bruentjen.eu/start.html). The macOS port is originally based on the work of [Leonardo Brondani Schenkel](https://github.com/lbschenkel/EurKEY-Mac). diff --git a/eurkey-macos.eu/index.html b/eurkey-macos.eu/index.html index 2f9a722..eb9e116 100644 --- a/eurkey-macos.eu/index.html +++ b/eurkey-macos.eu/index.html @@ -3,8 +3,8 @@ - EurKEY — The European Keyboard Layout for macOS - + EurKEY Next — The European Keyboard Layout for macOS + @@ -14,7 +14,7 @@
Download @@ -30,11 +30,11 @@
-

EurKEY — The European Keyboard Layout

+

EurKEY Next — The European Keyboard Layout

The complete key map for each version, showing all modifier layers and dead key compositions.

- + @@ -43,7 +43,7 @@

Hold Shift or Option to preview modifier layers. Click a yellow dead key to see its compositions. Press Esc to go back.

- Download v2.0 PDF + Download EurKEY Next PDF
@@ -55,22 +55,22 @@
-

Dead Keys for Diacritics

+

Dead Keys for
Diacritics

Type accented characters (ä, é, ñ, č, …) using intuitive Option-key combinations. No character palette needed.

-

ISO International Layout

-

Built for the physical English International keyboard found on European MacBooks — with the extra § key and big Enter.

+

ISO + ANSI
Compatible

+

Built for ISO MacBooks, fully compatible with ANSI keyboards. All characters remain accessible via dead keys.

-

Multiple Versions

-

Ships v1.2, v1.3, v1.4, and v2.0 in a single bundle. Pick the one that fits your workflow.

+

Ships Multiple
Versions

+

Ships EurKEY Next, v1.4, v1.3, and v1.2 in a single bundle. Pick the one that fits your workflow.

-

Easy Install

+

Packaged for
Easy Installation

Download the DMG, drag the bundle to Keyboard Layouts, log out. Done in under a minute.

@@ -86,7 +86,7 @@
1

Download

-

Get the latest .dmg from GitHub Releases. Open it and drag EurKey-macOS.bundle to the Keyboard Layouts folder.

+

Get the latest .dmg from GitHub Releases. Open it and drag EurKEY-Next.bundle to the Keyboard Layouts folder.

@@ -100,11 +100,11 @@
3

Add the layout

-

Open System Settings → Keyboard → Input Sources. Click Edit…, then + to add a new input source. Search for "EurKEY" and select the version you want.

+

Open System Settings → Keyboard → Input Sources. Click Edit…, then + to add a new input source. Search for "EurKEY Next" and select it.

System Settings showing the Edit button for input sources Dialog to add a new input source - EurKEY in the input sources list + EurKEY Next in the input sources list
@@ -112,9 +112,9 @@
4

Select it

-

Click the input source icon in the menu bar and switch to EurKEY.

+

Click the input source icon in the menu bar and switch to EurKEY Next.

- Selecting EurKEY from the menu bar dropdown + Selecting EurKEY Next from the menu bar dropdown
@@ -125,7 +125,7 @@