Zum Hauptinhalt springen

Einbindung

Die eine Zeile​

Die Zeile gehört in die Seitenvorlage, die alle Seiten Ihrer Website verwenden, in den <head> oder vor </body>:

<script src="https://leichtesprache.participaite.de/plugin/leichte-sprache.js" data-site="IHRE-KENNUNG" defer></script>

Ohne weitere Angaben findet das Plugin den Inhaltsbereich selbst und zeigt unten rechts einen schwebenden Button, der über feste Leisten am unteren Fensterrand wie Cookie-Hinweise nach oben ausweicht. defer hält den Aufbau der Seite nicht auf. Alles Weitere stellen Sie mit data-*-Attributen ein (Konfiguration), den fertigen Einbau prüfen Sie mit der Prüfliste.

Bis Oktober 2026 hieß die Adresse https://leichtesprache.yavio.ai/plugin/leichte-sprache.js. Ältere Einbindungen funktionieren damit weiter, Sie müssen nichts ändern. Bei der nächsten Änderung an der Seitenvorlage können Sie auf die neue Adresse umstellen.

Freischaltung​

Das Plugin übersetzt nur auf freigeschalteten Websites. Wir vergeben eine Kennung (den Wert für data-site) und hinterlegen die Adressen Ihrer Seiten, etwa https://www.stadt.de/ und https://stadt.de/, sowie ein Stundenkontingent für neue Übersetzungen. Test- und Vorschau-Systeme mit eigener Adresse schalten wir mit frei, wenn Sie uns die Adressen an info@participaite.de schicken. Auf einer Adresse ohne Freischaltung erscheint der Button, meldet beim Einschalten aber „Leichte Sprache ist gerade nicht möglich.“

Erlaubt Ihr System nur eine Skript-Adresse ohne weitere Attribute, hängen Sie die Kennung an:

https://leichtesprache.participaite.de/plugin/leichte-sprache.js?site=IHRE-KENNUNG

Automatische Aktualisierung oder feste Version​

Skript-AdresseVerhalten
https://leichtesprache.participaite.de/plugin/leichte-sprache.jsImmer die aktuelle Version. Browser laden eine neue Version spätestens nach 5 Minuten.
https://leichtesprache.participaite.de/plugin/v0.3.3/leichte-sprache.jsGenau Version 0.3.3. Diese Datei ändert sich nie.

Wir empfehlen die Adresse ohne Versionsnummer. Muss bei Ihnen jede Änderung an eingebundenen Skripten freigegeben werden, binden Sie eine feste Version ein und ändern später die Nummer in der Adresse. Adressen mit Versionsnummer bleiben dauerhaft gültig. Verbesserungen am Übersetzungsmodell wirken auch bei einer festen Version.

Wo der Button erscheint​

Standard ist unten rechts. data-position wählt eine andere Stelle (bottom-left, middle-right, middle-left, top-right, top-left), data-offset den Abstand zum Fensterrand.

<script src="https://leichtesprache.participaite.de/plugin/leichte-sprache.js"
data-site="IHRE-KENNUNG" data-position="bottom-left" data-offset="24,80" defer></script>

Einbau in das CMS​

Die Zeile gehört in das Template bzw. Layout aller Seiten, nicht in einzelne Seiten. Geben Sie sie nur für nicht angemeldete Besucherinnen und Besucher aus, nicht im Seiten-Editor und nicht in der Vorschau, damit nie eine Übersetzung über die Seitenbearbeitung gespeichert wird. Viele Bearbeitungsmodi erkennt das Plugin zusätzlich selbst (Redaktionsmodus).

Im TypoScript-Setup der Seite. includeJSFooter nimmt nur eine Adresse, die Kennung steht deshalb in der Adresse:

page.includeJSFooter.leichteSprache = https://leichtesprache.participaite.de/plugin/leichte-sprache.js?site=IHRE-KENNUNG
page.includeJSFooter.leichteSprache.external = 1
page.includeJSFooter.leichteSprache.defer = 1

# nicht für angemeldete Redakteurinnen und Redakteure
[backend.user.isLoggedIn]
page.includeJSFooter.leichteSprache >
[END]

Mit weiteren data-*-Attributen geht es über headerData:

page.headerData.110 = TEXT
page.headerData.110.value = <script src="https://leichtesprache.participaite.de/plugin/leichte-sprache.js" data-site="IHRE-KENNUNG" data-placement="above" defer></script>

[backend.user.isLoggedIn]
page.headerData.110 >
[END]

Redaktionsmodus​

Das Plugin startet nicht, wenn es Zeichen eines Bearbeitungsmodus sieht (unser WordPress-Plugin schaltet diese Erkennung ab, weil es Bearbeitungsansichten selbst auslässt):

  • WordPress: Admin-Leiste oder angemeldete Nutzerin bzw. angemeldeter Nutzer (#wpadminbar, body.logged-in), Customizer-Vorschau
  • TYPO3: Admin-Panel, Vorschau-Hinweis und Frontend-Editing
  • Drupal: Toolbar oder angemeldete Nutzerin bzw. angemeldeter Nutzer (#toolbar-administration, body.user-logged-in)
  • Joomla und Neos: deren Bearbeitungsoberflächen
  • jedes System: bearbeitbare Bereiche mit Text (contenteditable) und der Bearbeitungsmodus des Browsers (designMode)

Die Konsole meldet dann [Leichte Sprache] CMS editing mode (…): plugin not started. Sind Sie im CMS angemeldet, testen Sie deshalb in einem privaten Browserfenster. Die Erkennung ist nur eine zusätzliche Sicherung neben den Regeln oben. data-admin-check="false" schaltet sie ab, das empfehlen wir nicht.