# rosmord/mac_transliteration_keyboards architecture

> Architecture diagram of the GitHub repository rosmord/mac_transliteration_keyboards, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rosmord/mac_transliteration_keyboards
- Repository: https://github.com/rosmord/mac_transliteration_keyboards

## Overview

##### Project type and purpose
- The README explains installation steps and usage; the code files themselves are static keyboard definitions (“.keylayout” + “.icns”) organized by layout (US, French) and by encoding (leyden vs legacy).

##### File structure
- Top level:
– Mac/
· egtrl-*-leyden.keylayout & .icns (the current recommended keyboards)
· legacy/ (old/non-leyden keyboards)
– pictures/ (screenshots illustrating installation)
– README.md, LICENSE, .gitignore
- No “src” or “backend” code—this is purely a packaging/distribution repository.

##### Key insights from README
- Describes usage of Ukulele to create keyboards (external tool)
- Details installation path (`~/Library/Keyboard Layouts`) and activation via System Preferences
- Distinguishes recommended “leyden” keyboards vs legacy versions

a. Main components
1. Repository (Git)
– pictures/ (installation docs)
– README.md (instructions)
2. External Tool: Ukulele (used to author keyboards)
3. User Installation Environment
– Installation folder: `~/Library/Keyboard Layouts`
– macOS Keyboard System Preferences
4. Consumer Applications (Text editors, word processors)
b. Relationships and interactions
- Developer/Contributor uses Ukulele → generates or updates .keylayout + .icns → commits to Repository
- End-user clones/downloads Repository → copies selected .keylayout/.icns into `~/Library/Keyboard Layouts` → opens System Preferences → enables custom keyboards → uses in any text app
c. Architectural patterns/principles
- Separation of concerns:
– Asset definitions (Mac/) vs Documentation (README + pictures/)
– Current vs legacy encodings clearly separated
- Conventional macOS installation path
d. Key technologies/frameworks
- Ukulele (keyboard creation)
- macOS Keyboard subsystem
- Unicode (transliteration standard)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer/Author Components
    Developer["Developer/Contributor"]:::dev
    Ukulele["Ukulele (Authoring Tool)"]:::dev
    Developer -->|"author using"| Ukulele
    Ukulele -->|"generates .keylayout + .icns"| Repository["Repository (Git)"]:::dev

    %% Repository Contents
    subgraph "Repository (Git)"
        direction TB
        subgraph "Mac Layouts (leyden)"
            direction TB
            U1["egtrl-us-leyden.keylayout"]:::file
            U1IC["egtrl-us-leyden.icns"]:::file
            F1["egtrl-fr-leyden.keylayout"]:::file
            F1IC["egtrl-fr-leyden.icns"]:::file
        end
        subgraph "Legacy Layouts"
            direction TB
            L1["egtrl-us-0313.keylayout"]:::file
            L1IC["egtrl-us-0313.icns"]:::file
            L2["egtrl-us-0486.keylayout"]:::file
            L2IC["egtrl-us-0486.icns"]:::file
            L3["egtrl-fr-0313.keylayout"]:::file
            L3IC["egtrl-fr-0313.icns"]:::file
            L4["egtrl-fr-0486.keylayout"]:::file
            L4IC["egtrl-fr-0486.icns"]:::file
        end
        subgraph "Documentation & Assets"
            direction TB
            R["README.md"]:::doc
            P["pictures/"]:::doc
            GITIGNORE[".gitignore"]:::doc
            LICENSE["LICENSE"]:::doc
        end
    end

    %% Installation Flow
    Repository -->|"git clone or download"| InstallFolder["~/Library/Keyboard Layouts"]:::user
    InstallFolder -->|"auto-discover"| Preferences["System Preferences"]:::user
    Preferences -->|"enable keyboards"| KeyboardSubsystem["macOS Keyboard Subsystem"]:::user
    KeyboardSubsystem -->|"provides input"| Applications["Applications (Text Editors, Word Processors)"]:::user

    %% Click Events
    click U1 "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/egtrl-us-leyden.keylayout"
    click U1IC "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/egtrl-us-leyden.icns"
    click F1 "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/egtrl-fr-leyden.keylayout"
    click F1IC "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/egtrl-fr-leyden.icns"
    click L1 "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-us-0313.keylayout"
    click L1IC "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-us-0313.icns"
    click L2 "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-us-0486.keylayout"
    click L2IC "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-us-0486.icns"
    click L3 "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-fr-0313.keylayout"
    click L3IC "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-fr-0313.icns"
    click L4 "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-fr-0486.keylayout"
    click L4IC "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/Mac/legacy/egtrl-fr-0486.icns"
    click R "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/README.md"
    click P "https://github.com/rosmord/mac_transliteration_keyboards/tree/master/pictures/"
    click GITIGNORE "https://github.com/rosmord/mac_transliteration_keyboards/blob/master/.gitignore"
    click LICENSE "https://github.com/rosmord/mac_transliteration_keyboards/tree/master/LICENSE"

    %% Styles
    classDef dev fill:#bbdefb,stroke:#1e88e5,color:#0d47a1;
    classDef user fill:#c8e6c9,stroke:#43a047,color:#1b5e20;
    classDef file fill:#f0f4c3,stroke:#f9a825,color:#827717;
    classDef doc fill:#fff9c4,stroke:#f9a825,color:#f57f17;
```
