Überblick
Dieser Artikel beschreibt, wie Eye-Able Assist in eine Drupal-Installation ab Version 10.3 integriert wird. Die Einbindung erfolgt über ein benutzerdefiniertes Modul und eine lokal gehostete Library. Assist wird dabei als Block eingebunden, über den das Eye-Able-Icon angezeigt und die Toolbar geöffnet wird.
Voraussetzungen
Für die Nutzung von Assist in Drupal müssen einige grundlegende Voraussetzungen erfüllt sein. Erforderlich ist eine Drupal-Installation ab Version 10.3 sowie ein gültiger Vertrag mit Eye-Able. Der Service wird pro Domain gebucht. Daher wird eine Eye-Able Assist Lizenz für die jeweilige Domain benötigt.
Funktionsweise
Das Drupal-Modul stellt einen Block bereit, der im Layout der Website platziert werden kann. Dieser Block lädt eine JavaScript-Datei, welche das Eye-Able-Icon einbindet. Über dieses Icon können Nutzerinnen und Nutzer die Assist-Toolbar öffnen und verwenden.
Schritte für den Einbau
1. Modul bereitstellen
Zunächst wird das Eye-Able Drupal Modul in das Drupal-Projekt eingebunden. Laden Sie dazu das Modul hier herunter und legen Sie es im Verzeichnis /web/modules/custom/eyeable_integration ab.
2. Eye-Able-Dateien als Drupal-Library installieren
Damit Assist lokal gehostet werden kann, müssen die Eye-Able-Dateien als Drupal-Library installiert werden. In Drupal-Projekten ist composer/installers in der Regel bereits vorhanden.
In der composer.json wird unter repositories ein zusätzlicher Eintrag ergänzt, über den die Eye-Able-Dateien geladen werden:
{
"type": "package",
"package": {
"name": "eye-able/eye-able-assist",
"version": "1.15.25",
"type": "drupal-library",
"extra": {
"installer-name": "eye-able-assist/public"
},
"dist": {
"url": "https://cdn.eye-able.com/localHosting/EyeAble_LocalHosting.zip",
"type": "zip"
}
}
}
Anschließend wird die Library per Composer installiert:
composer require eye-able/eye-able-assist:^1.0
Nach der Installation befinden sich die Dateien unter
web/libraries/eye-able-assist/public.
Der Ordner enthält die Unterverzeichnisse css, font, images, js, lang und tts.
Der Ordner public ist zwingend erforderlich, da das Script sonst nicht funktioniert.
3. Modul aktivieren
Im nächsten Schritt wird das Eye-Able Drupal Modul im Drupal-Backend aktiviert. Öffnen Sie den Bereich Erweitern und aktivieren Sie dort das Modul Eye-Able Integration.
4. Block platzieren
Nach der Aktivierung steht der Eye-Able-Block zur Verfügung. Dieser wird unter Struktur → Blocklayout in einer geeigneten Region platziert.
Für ein schwebendes Icon ist die Wahl der Region unerheblich, beispielsweise kann die Fußzeile genutzt werden. Soll das Icon an einer festen Position erscheinen, platzieren Sie den Block an der gewünschten Stelle, etwa vor oder nach dem Hauptmenü.
5. Block konfigurieren
Nach der Platzierung wird der Block konfiguriert. Dabei sind folgende Punkte relevant:
-
Der Blocktitel sollte ausgeblendet werden, indem die Option „Titel anzeigen“ deaktiviert wird.
-
Die Eye-Able-Konfigurationsdatei muss eingefügt werden. Diese wird im Eye-Able-Dashboard unter
"Eye-Able Assist → Installation → Lokales Hosting einrichten → Konfigdatei herunterladen"
bereitgestellt.
-
Die Konfigurationsdatei enthält den Lizenzschlüssel für die gebuchte Domain.
-
Für die Symbol-Position kann zwischen „Automatisch“ (schwebendes Symbol) und „Blockposition“ (Anzeige am Blockort) gewählt werden.
-
Die Sichtbarkeit des Blocks kann optional eingeschränkt werden.
-
Ist das Config Management aktiv, müssen die Änderungen exportiert und committet werden.
Datenschutz
Bei dieser Einbindungsart werden alle Eye-Able-Dateien vom eigenen Server geladen. Es finden keine Anfragen an Eye-Able-Server statt, auch nicht für die Screenreader-Funktion.
Eye-Able sollte dennoch in den Datenschutztexten der Website erwähnt werden. Ein vorgefertigter Datenschutztext steht hier im Eye-Able-Dashboard zur Verfügung.
Aktualisierung der Library
Die Eye-Able-Dateien werden nicht automatisch aktualisiert. Da die in der composer.json hinterlegte URL keine Versionsnummer enthält, erkennt Composer keine Änderungen.
Für eine Aktualisierung müssen die bestehenden Library-Dateien gelöscht und anschließend composer install erneut ausgeführt werden. Die aktuell eingesetzte Version kann anhand des Dateinamens der minimierten CSS-Datei geprüft werden, beispielsweise
css/eyeAble.1.14.17.min.css.
Alternativ können die Dateien auch direkt aus dem Eye-Able-Dashboard heruntergeladen, manuell in den Library-Ordner kopiert und anschließend committet werden.