ReNeo beschrieben. kbdneo verwendet Reneo als Ergänzung.

docs/Benutzerhandbuch/Bildschirmtastatur.md

@@ -4,9 +4,7 @@ Mit der Bildschirmtastatur lässt sich am Bildschirm die Belegung der Tastatur a
 So kann man schnell nachschauen, wo ein bestimmtes Zeichen zu finden ist, ohne die Tastatur zu bekleben oder die Tasten zu vertauschen.
 
 ## Windows
-Unter Windows ist eine Bildschirmtastatur direkt in den [NeoVars-Treiber](../Einrichtung/neovars.md#bildschirmtastatur) integriert. Dort wird sie mit Mod3+F1 aktiviert.
+Unter Windows ist eine Bildschirmtastatur direkt in [ReNeo](../Einrichtung/reneo.md#bildschirmtastatur) integriert. Dort wird sie mit ++Mod3+F1++ aktiviert. Dies gilt gleichermaßen bei der Verwendung von [kbdneo](../Einrichtung/kbdneo.md) / ReNeo.
-
-Bei Verwendung von [kbdneo](../Einrichtung/kbdneo.md) kann eine ähnliche Bildschirmtastatur unter Verwendung des AHK-Zusatzskripts (kbdneo_ahk.exe) nachgerüstet werden. Sie wird dann mit Mod4+F7 aktiviert.
 
 ## Linux
 Für [Linux](../Einrichtung/Linux.md) gibt es bislang vier Programme, die die Tastatur am Bildschirm anzeigen:

docs/Einrichtung/kbdneo.md

@@ -4,6 +4,9 @@ kbdneo ist ein natives Tastaturlayout für Windows. Es wird nach der Installatio
 
 kbdneo gibt es ebenso in den Varianten [Bone](../Layouts/bone.md) und [NeoQwertz](../Layouts/neoqwertz.md).
 
+!!! important "Hinweis"
+    Aus technischen Gründen unterstützt das native Layout nicht den vollständigen Funktionsumfang von Neo. Um dies zu erreichen, bitte nach erfolgreicher Installation von kbdneo den Abschnitt [Ergänzung der Funktionalität](#erganzung-der-funktionalitat) beachten.
+
 ## Download
 
 Die verschiedenen Varianten von kbdneo sind unter folgenden Links verfügbar:
@@ -59,32 +62,6 @@ In der oberen Auswahlliste wählt man nun statt des Systemstandards explizit Neo
 !!! example "Screenshot"
     ![screenshot](images/kbdneo_settings4.png)
 
-### Ergänzendes AutoHotkey-Skript
-
-Einige spezielle Funktionen lassen sich nicht über einen nativen Tastaturtreiber belegen. Dazu gehören die Pfeiltasten, Entfernen, Seite hoch/runter, Einfügen, Pos1 und Ende. Ebenso ist das [Einrasten](../Benutzerhandbuch/Einrasten.md) von Modifiern (Capslock bzw. Mod4-Lock) treibertechnisch nicht direkt möglich.
-
-Diese beiden Mängel werden durch ein ergänzendes, auf AutoHotkey basierendes Skript behoben, das beim Anmelden ausgeführt werden sollte. Dies ist ebenfalls im Archiv unter `kbdneo2.exe` enthalten. Es rüstet die fehlenden Funktionen nach und ermöglicht Capslock, Mod4-Lock und eine vollständige vierte Ebene.
-
-Der einfachste Weg dazu ist hier, eine Verknüpfung auf `kbdneo2.exe` im Autostart-Menü anzulegen.
-
-!!! important "Ausführen mit Administrator-Rechten"
-    Wenn ein Programm mit Adminrechten gestartet wird, bleibt das Neo-Layout aktiv. Die Funktionen des Ergänzungsskripts laufen dagegen leider nicht automatisch im Admin-Modus, wenn das Skript normal gestartet wurde.
-
-    Zur Abhilfe kann man das Skript dann ein zweites Mal (als Administrator) ausführen. Den aufpoppenden Dialog bestätigt man und hat anschließend das Skript bis zum Abmelden / Neustart für alle Programme aktiv.
-
-Falls es gewünscht ist, die zusätzlichen Funktionen auch in Programmen mit Administrator-Rechten zur Verfügung zu haben, ist ein anderer Weg als über Autostart erforderlich. Stattdessen wird mittels der _Aufgabenplanung_ (engl. _Task Scheduler_) ein neuer Task in der Aufgabenplanungsbibliothek (engl. Task Scheduler Library) erstellt:
-
-!!! example "Screenshot"
-    ![screenshot](images/kbdneo_settings5.png)
-
-- Mit der Einstellung _Run with highest privileges_ läuft das Skript automatisch im Administrator-Modus.
-- Unter _Triggers_ ist ein neuer Trigger mit Aufgabenstart „Bei Anmeldung“ hinzuzufügen.
-- Bei _Actions_ wird eine neue Aktion gesetzt, die die `kbdneo2.exe` ausführt.
-- Bei Notebooks sollte man noch unter _Conditions_ die Option deaktivieren, dass der Task nur bei Strombetrieb gestartet wird.
-- Da der Task dauerhaft läuft, sollte man eventuell unter _Settings_ die Option deaktivieren, bei der die Aufgabe nach längstens drei Tagen automatisch beendet wird.
-
-Zu beachten ist, dass ein bereits vorhandener Autostart-Eintrag von `kbdneo2.exe` wieder entfernt wird.
-
 ### Deinstallation
 
 Die Deinstallation läuft am Besten in umgekehrter Reihenfolge zur Installation ab:
@@ -97,22 +74,55 @@ Die Deinstallation läuft am Besten in umgekehrter Reihenfolge zur Installation
 Auch bei einem Wechsel des Layouts, z.B. von Neo nach Bone, wird zuerst die vollständige Deinstallation empfohlen. Auf den Neustart im letzten Schritt kann verzichtet werden, wenn man anschließend eine Installation des anderen Layouts nach Anleitung vornimmt.
 
 
+## Ergänzung der Funktionalität
+
+Einige spezielle Funktionen lassen sich nicht über einen nativen Tastaturtreiber belegen. Dazu gehören auf Ebene 4 die Pfeiltasten, Entfernen, Seite hoch/runter, Einfügen, Pos1 und Ende. Ebenso ist das [Einrasten](../Benutzerhandbuch/Einrasten.md) von Modifiern (Capslock bzw. Mod4-Lock) treibertechnisch nicht direkt möglich. Einige Programme, die auf Windows wie Linux laufen, haben zudem Schwierigkeiten mit den Zeichen der dritten Ebene.
+
+Diese Mängel können dadurch behoben werden, wenn ergänzend zu kbdneo auch [ReNeo](reneo.md) installiert und gestartet wird ([hier beschrieben](reneo.md#installation)). Es läuft dann automatisch im Erweiterungsmodus und ergänzt kbdneo um die fehlenden Funktionen.
+
+Der einfachste Weg dazu ist hier, eine Verknüpfung auf `reneo.exe` im Autostart-Menü anzulegen.
+
+!!! important "Ausführen mit Administrator-Rechten"
+    Wenn ein Programm mit Adminrechten gestartet wird, bleibt das Neo-Layout aktiv. Die Funktionen von ReNeo laufen dagegen leider nicht automatisch im Admin-Modus, wenn es regulär gestartet wird.
+
+    Zur Abhilfe kann man ReNeo ein zweites Mal (als Administrator) ausführen. Den aufpoppenden Dialog bestätigt man und hat anschließend die Funktionalität bis zum Abmelden / Neustart für alle Programme aktiv.
+
+Falls es gewünscht ist, die zusätzlichen Funktionen auch in Programmen mit Administrator-Rechten zur Verfügung zu haben, ist ein anderer Weg als über Autostart erforderlich. Stattdessen wird mittels der _Aufgabenplanung_ (engl. _Task Scheduler_) ein neuer Task in der Aufgabenplanungsbibliothek (engl. Task Scheduler Library) erstellt:
+
+!!! example "Screenshot"
+    ![screenshot](images/kbdneo_settings5.png)
+
+- Mit der Einstellung _Run with highest privileges_ läuft das Skript automatisch im Administrator-Modus.
+- Unter _Triggers_ ist ein neuer Trigger mit Aufgabenstart „Bei Anmeldung“ hinzuzufügen.
+- Bei _Actions_ wird eine neue Aktion gesetzt, die `reneo.exe` ausführt.
+- Bei Notebooks sollte man noch unter _Conditions_ die Option deaktivieren, dass der Task nur bei Strombetrieb gestartet wird.
+- Da der Task dauerhaft läuft, sollte man eventuell unter _Settings_ die Option deaktivieren, bei der die Aufgabe nach längstens drei Tagen automatisch beendet wird.
+
+!!! warning "Zu beachten"
+    Zu beachten ist, dass ein evtl. bereits vorhandener Autostart-Eintrag von `reneo.exe` wieder entfernt wird.
+
+
 ## Features
 
 ### Bildschirmtastatur
 
-Die Bildschirmtastatur (BST) von Windows ist nicht kompatibel mit auf Neo basierenden Layouts. Daher stellt Neo eine eigene BST (im Stile von NeoVars, jedoch abgespeckt) bereit. Wenn man das Ergänzungsskript gestartet hat, wird die Tastatur mit ++Mod4+F7++ eingeblendet bzw. versteckt. Sie zeigt die Zeichen der jeweils aktiven Ebene an, abhängig von den gedrückten Mod-Tasten.
+Die Bildschirmtastatur (BST) von Windows ist nicht kompatibel mit auf Neo basierenden Layouts. Alternativ kann daher die BST von ReNeo genutzt werden, die mit ++Mod3+F1++ eingeblendet bzw. versteckt wird. Sie zeigt die Zeichen der jeweils aktiven Ebene an, abhängig von den gedrückten Mod-Tasten.
 
 ### Wechseln zwischen Neo und Qwertz
 
 Wenn beide Layouts in Windows für den Benutzer eingerichtet sind, kann man zwischen ihnen mit ++Windows+Space++ umschalten. Die Umschaltung wirkt sich standardmäßig auf alle bereits gestarteten Anwendungen aus.
 
+ReNeo erkennt ebenfalls den Wechsel und verhält sich entsprechend der Einstellung `standaloneMode` (siehe [hier](reneo.md#konfiguration)). Es ist sinnvoll, diese Option auf `false` zu stellen, damit sich ReNeo beim Wechsel zu Qwertz ebenfalls deaktiviert – sinnvoll, wenn man z.B. für andere Nutzer das Layout schnell auf Qwertz schalten möchte.
+
 
 ## Häufige Fehler
 
 ### Mein ß ist ein ö!
 
-Dieser Fehler tritt auf, wenn das Ergänzungsskript gestartet wird, aber Neo _zum Zeitpunkt des Programmstarts_ nicht das aktive Layout war. 
+!!! fail "Obsoleter Fehler"
+    In früheren Versionen wurde statt ReNeo ein Ergänzungsskript verwendet, das auf AutoHotkey basiert. Die Nutzung von ReNeo führt nicht zum beschriebenen Fehler.
+
+Der beschriebene Fehler tritt auf, wenn das Ergänzungsskript gestartet wird, aber Neo _zum Zeitpunkt des Programmstarts_ nicht das aktive Layout war.
 
 **Abhilfe:** Entweder Neo als primäres Layout einrichten (siehe [Manuelle Installation](#manuelle-installation)), oder das Layout temporär zu Neo umschalten, bevor das Skript gestartet wird.
 
@@ -132,4 +142,7 @@ Wenn man das Layout in den Spracheinstellungen hinzugefügt hat, es aber nicht i
 
 ### Manche Tasten auf Ebene 4 erzeugen falsche oder zusätzliche Aktionen
 
+!!! fail "Obsoleter Fehler"
+    In früheren Versionen wurde statt ReNeo ein Ergänzungsskript verwendet, das auf AutoHotkey basiert. Die Nutzung von ReNeo führt nicht zum beschriebenen Fehler.
+
 Dies wird vorkommen, wenn mehr als ein [Ergänzungsskript](#erganzendes-autohotkey-skript) gleichzeitig läuft. Hier bitte überprüfen, dass genau ein Skript läuft, und dass dieses zum aktiven Layout passt (also beispielsweise `kbdbone.exe` zum Bone-Layout).

docs/Einrichtung/reneo.md

@@ -1,3 +1,125 @@
 # <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="1em"><path fill="currentColor" d="M3,12V6.75L9,5.43V11.91L3,12M20,3V11.75L10,11.9V5.21L20,3M3,13L9,13.09V19.9L3,18.75V13M20,13.25V22L10,20.09V13.1L20,13.25Z" /></svg> ReNeo
 
---8<-- "fehlender Inhalt.md"
+ReNeo implementiert das Neo-Tastaturlayout und seine Verwandten (Bone, NeoQwertz usw.) für Windows. Es eignet sich zum Ausprobieren, für die kurzfristige Nutzung an fremden Rechnern, aber auch zur dauerhaften Installation ohne Administratorrechte. ReNeo kann dabei in zwei Varianten genutzt werden:
+
+  1. Im _Standalone-Modus_ ersetzt ReNeo alle Tastendrücke des nativen Layouts (in der Regel Qwertz) durch das gewünschte Neo-Layout. Dafür muss zum Systemstart nur die `reneo.exe` ausgeführt werden.
+  1. Im _Erweiterungsmodus_ installiert man zusätzlich den nativen Neo-Treiber [kbdneo](kbdneo.md) bzw. dessen Varianten für Bone oder NeoQwertz. ReNeo ergänzt dann automatisch alle Funktionen, die nativ nicht umsetzbar sind (Capslock, Steuertasten auf Ebene 4, Compose, bessere Kompatibilität mit bestimmten Programmen, usw.).
+
+## Installation
+
+  - Aktuelles ReNeo-Release [herunterladen](../Download/index.md) und in ein Verzeichnis mit Schreibrechten entpacken (z.B. `C:\Users\[USER]\ReNeo`).
+  - (optional) `config.json` nach eigenen Wünschen [anpassen](#konfiguration)
+  - `reneo.exe` starten oder zum Autostart hinzufügen. Über das Trayicon kann das Programm deaktiviert und beendet werden.
+
+kbdneo kann nachträglich installiert werden, ohne dass Einstellungen geändert werden müssen.
+
+### Deinstallation
+
+Es genügt, das ReNeo-Verzeichnis zu löschen und ggf. das Programm aus dem Autostart zu entfernen.
+
+
+## Funktionen
+
+### Allgemein
+
+  - Unterstützt von Haus aus die folgenden Neo-basierten Layouts: Neo, Bone, NeoQwertz, AdNW, KOY, Mine
+    - ein Wechsel zwischen diesen Layouts erfolgt über das Traymenü
+    - weitere Layouts können in `layouts.json` (siehe [Layouts anpassen](#layouts-anpassen)) hinzugefügt und/oder angepasst werden
+  - Alle Zeichen von toten Tasten und [Compose-Sequenzen](#compose) im Linux-kompatiblen Format. Diese sind auch durch den Nutzer erweiterbar. Beim Start werden alle `.module`-Dateien im Verzeichnis `compose/` geladen.
+  - Capslock (beide Shift-Tasten) und Mod4-Lock (beide Mod4-Tasten)
+  - ++Shift+Pause++ (de-)aktiviert ReNeo
+  - Bildschirmtastatur: Wird über Traymenü ein- und ausgeschaltet, oder per Shortcut ++Mod3+F1++. Die Anzeige wechselt zwischen den Ebenen, wenn Modifier gedrückt werden.
+
+### Als Erweiterung zum nativen Treiber
+
+- Steuertasten auf Ebene 4
+- Wird das native Layout als Neo-verwandt erkannt (kbdneo.dll, kbdbone.dll, kbdgr2.dll), schaltet ReNeo automatisch in den Erweiterungsmodus. Das Umschalten zwischen nativen Layouts über die Windows-Einstellungen ist ganz normal möglich.
+- Verbesserte Kompatibilität mit Qt- und GTK-Anwendungen. Workaround für [diesen Bug](https://git.neo-layout.org/neo/neo-layout/issues/510).
+- Compose-Taste ++Mod3+Tab++ sendet keinen (zusätzlichen) Tab mehr an die Anwendung. Workaround für [diesen Bug](https://git.neo-layout.org/neo/neo-layout/issues/397).
+
+### Bildschirmtastatur
+Mit der Tastenkombination ++Mod3+F1++ erhält man eine graphische Zusammenfassung der Neo-Tastatur. Sie erleichtert das Finden eines noch nicht so vertrauten Zeichens und hilft zudem beim Erlernen des Blindschreibens, da der Blick auf den Bildschirm und nicht auf die Tastatur gerichtet ist. Werden während der Anzeige der Tastatur verschiedene Modifier (++Shift++, ++Mod3++, ++Mod4++) oder Kombinationen gedrückt, so springt die Abbildung automatisch in die entsprechende Ebene.
+
+![image](images/reneo-bst.png)
+
+Die Bildschirmtastatur ist halbtransparent und kann am linken oder rechten Rand angefasst und vergrößert oder verkleinert werden. Hält man sie an einer beliebigen Taste fest, lässt sie sich frei auf dem Bildschirm verschieben. Sie kann durch erneutes Drücken von ++Mod3+F1++ beendet werden.
+
+<!-- 
+### Unicode
+
+Sämtliche Unicode-Zeichen lassen sich direkt durch Eingabe ihres [Codepoints](https://en.wikipedia.org/wiki/Unicode#Architecture_and_terminology) (in hexadezimaler Schreibweise) generieren. Dazu ist die Compose-Sequenz `♫uu`, gefolgt vom Codepoint und einem Leerzeichen, einzugeben. Führende Nullen werden ignoriert.
+
+!!! example "Beispiele"
+    - A (U+0041): `♫uu41␣`
+    - ʒ (U+0292): `♫uu292␣`
+    - ♥ (U+2665): `♫uu2665␣`
+    - 🚀 (U+1F680): `♫uu1f680␣`
+
+### Römische Zahlen
+
+Ähnlich wie bei Unicode-Zeichen können auch römische Zahlen automatisch generiert werden. Dazu wird die Compose-Sequenz `♫rn` (kleine Buchstaben) bzw. `♫RN` (große Buchstaben) verwendet. Beispielsweise erzeugt `♫rn74␣` die Zeichenfolge ⅼⅹⅹⅰⅴ, und `♫RN74` entsprechend ⅬⅩⅩⅠⅤ.
+-->
+
+## Konfiguration
+
+ReNeo kann mit zwei Konfigurationsdateien angepasst werden.
+
+Die Datei `config.json` hat folgende Optionen:
+
+  - `standaloneMode`:
+    - **true** (Standard): Das native Layout (z. B. QWERTZ) wird von ReNeo mit dem ausgewählten Neo-Layout ersetzt.
+      
+        !!! tip "Hinweis"
+            Ist das native Layout bereits Neo-verwandt (wie kbdneo), verändert ReNeo das Layout nicht und schaltet stattdessen automatisch in den Erweiterungsmodus.
+    
+    - **false**: Ist das native Layout Neo-verwandt, schaltet ReNeo in den Erweiterungsmodus. Bei allen anderen Layouts deaktiviert sich ReNeo automatisch.
+
+  - `standaloneLayout`: Das Layout, das für den Standalone-Modus genutzt werden soll. Dies lässt sich auch über das Traymenü auswählen, unter allen Layouts, in die `layouts.json` definiert sind.
+  - `oskNumpad`: Soll das Numpad in der Bildschirmtastatur angezeigt werden?
+  - `sendKeyMode`:
+    - **fakeNative** (Standard): Buchstaben und Sonderzeichen, die im nativen Layout existieren, werden über entsprechende Tastenanschläge und -kombinationen simuliert. So sieht es für Anwendungen aus, als ob das native Layout ganz normal verwendet wird.
+    - **honest**: Sonderzeichen werden grundsätzlich als Unicode-Pakete gesendet.
+
+        !!! warning "Experimentell"
+            Diese Einstellung ist experimentell und nicht empfohlen. Es können falsche oder auch gar keine Zeichen bei einigen Anwendungen ankommen. Nur verwenden, wenn man weiß, was man tut.
+
+
+## Für Fortgeschrittene und Bastler
+
+!!! important "Hinweis"
+    Die nachfolgenden Abschnitte sind nicht notwendig zur Verwendung von ReNeo. Sie sind dann von Interesse, wenn man Layouts nach eigenen Wünschen detailliert anpassen oder komplett eigene Layouts erstellen möchte.
+
+### Layouts anpassen
+
+In `layouts.json` können Layouts angepasst und hinzugefügt werden. Jeder Eintrag besitzt folgende Parameter:
+
+  - `name`: Name des Layouts, so wie er im Menü angezeigt wird.
+  - `dllName` (optional): Name der zugehörigen nativen Treiber-DLL. Existiert diese nicht, kann der Parameter weggelassen werden.
+  - `modifiers`: Scancodes der Modifier Shift, Mod3 und Mod4 (links und rechts). Mit `+` am Ende wird das Extended-Bit gesetzt, zum Beispiel `36+` für die rechte Shift-Taste.
+  - `capslockableKeys`: Array von Scancodes, die von Capslock beeinflusst werden sollen. Typischerweise sind das alle Buchstaben, inklusive „äöüß“.
+  - `map`: Das tatsächliche Layout in Form von Arrays mit sechs Elementen (für die sechs Ebenen) für jeden Scancode. Jeder Eintrag enthält dabei
+    - `keysym`: X11-Keysym der Taste, entweder aus `keysymdef.h` oder in der Form `U1234` für Unicode-Zeichen. Wird für Compose benutzt.
+    - **Entweder** `vk`: Windows Virtual Key aus dem Enum `VKEY` in `mapping.d`. Nur genutzt für Steuertasten.
+    - **Oder** `char`: Unicode-Zeichen, das mit der Taste erzeugt werden soll.
+  - `label` (optional): Beschriftung für die Bildschirmtastatur. Als Fallback wird der Wert von `char` genutzt.
+
+Zum Erstellen neuer Layouts hat sich folgender Arbeitsablauf bewährt:
+
+  1. Bestehendes Layout kopieren und neuen Namen eintragen
+  1. Die Zeilen der Buchstabentasten (also ab Scancode `0C`) neu ordnen, sodass diese auf der Tastatur von oben links nach unten rechts gelesen in der richtigen Reihenfolge sind.
+  1. Mit Blockauswahl die Scancodes eines bestehenden Layouts kopieren, und die (jetzt falsch geordneten) Scancodes des neuen Layouts überschreiben.
+  1. Mit Blockauswahl Ebenen 3 und 4 eines bestehenden Layouts kopieren, und Ebenen 3 und 4 des neuen Layouts überschreiben.
+  1. `modifiers` und `capslockableKeys` ggf. anpassen
+
+So bleiben Ebenen 3 und 4 an der richtigen Stelle, und die anderen Ebenen werden nach der neuen Buchstabenanordnung permutiert.
+
+### Compose
+
+ReNeo lädt beim Start automatisch alle Compose-Sequenzen, die sich im Verzeichnis `compose/` neben der .exe-Datei befinden. Das Format entspricht dem unter Linux üblichen Format von [XCompose](https://wiki.ubuntuusers.de/Sonderzeichen/#Eigene-Tastenkombinationen). Neben den `.module`-Dateien gibt es auch `.remove`-Dateien. Deren Inhalt _löscht_ eine identische Definition, was notwendig ist, falls mehrere Module-Dateien dieselbe Tastenkombination unterschiedlich belegen wollen.
+
+Mehr Information über tote Tasten und Compose-Sequnzen gibt es [hier](../Benutzerhandbuch/Tote-Tasten-und-Compose.md).
+
+
+## Für Entwickler
+
+Aktuelle Angaben zur Mitarbeit am Projekt finden sich auf der [Projektseite](https://github.com/Rojetto/ReNeo/#f%C3%BCr-entwickler).