Sylius Media Alt Text: Konfiguration

Konfiguration des Sylius Media Alt Text Plugins: globaler Schalter im Admin, Alt-Texte pro Bild und Sprache pflegen, dekorative Bilder und der Backfill-Befehl mit allen Optionen.

English Version

Zurück zur Übersicht

Sylius Media Alt Text: Konfiguration

Diese Dokumentation bezieht sich immer auf die aktuellste veröffentlichte Version.

Das Plugin hat keine YAML-Konfiguration und liest keine Umgebungsvariablen. Es gibt genau eine Einstellung, und die liegt im Admin.

Einstellung im Admin

Admin-Sidebar > MMKreativ Plugins > Bild-Alt-Texte (englisch „Image Alt Texts“), erreichbar unter /admin/media-alt-text/settings (der Präfix folgt Deinem konfigurierten Admin-Pfad). Zugriff hat, wer ROLE_ADMINISTRATION_ACCESS besitzt.

Einstellung	Standard	Beschreibung
Alt-Texte ausgeben	an	Schaltet die Ausgabe in Storefront und Shop API ein oder aus

Die Einstellung gilt für den ganzen Shop, nicht pro Channel und nicht pro Sprache.

Ist die Ausgabe aus:

verhalten sich Storefront und Shop API wie ohne das Plugin: Bilder werden durch den Produkt- bzw. Kategorienamen beschrieben, die Shop API lässt alt weg
verschwinden die Alt-Text-Felder aus den Bildformularen im Admin
bleiben die gespeicherten Texte erhalten und kommen zurück, sobald Du wieder einschaltest
nimmt die Admin API weiterhin Alt-Texte an und liefert sie aus

Headless-Clients lesen den Zustand über GET /api/v2/shop/media-alt-text-settings, siehe Shop API.

Alt-Texte pflegen

Jedes Produktbild, Kategoriebild und Admin-Avatar zeigt den Alt-Text-Editor in der eigenen Bild-Karte:

ein Schalter Dekoratives Bild
pro aktivierter Shop-Sprache eine ausklappbare Sektion; die Standardsprache steht vorn und startet offen, ebenso Sektionen mit Fehlern, und eine Sprache mit Text trägt ein Badge „ausgefüllt“
jeder Text ist auf 255 Zeichen begrenzt, Leerzeichen am Rand werden entfernt, eine leere Sprache wird nicht gespeichert (ein vorhandener Text dieser Sprache wird gelöscht)

Beim Taxon sitzt der Editor rechts neben jedem Bild, beim Produkt in jeder Bild-Karte des Medien-Abschnitts.

Wie ein Text gewählt wird

Text in der angefragten Sprache
Text in der Standardsprache des Shops
Der Name von Produkt bzw. Kategorie in der angefragten Sprache, ersatzweise ein Name in einer anderen Sprache (bei Avatars der Vor- und Nachname, sonst der Benutzername)

Ein Bild gilt als dekorativ, sobald eine seiner Zeilen so markiert ist. Dann ist der Alt-Text leer (alt=""), und der Fallback greift nicht.

Ein dekoratives Bild ohne Text speichert eine leere Zeile in der Standardsprache, weil das Kennzeichen an der Zeile hängt.

Backfill-Befehl

mmd:media-alt-text:backfill füllt fehlende Texte mit dem Produkt- bzw. Kategorienamen vor, damit Redakteure etwas zum Verfeinern haben.

Option	Standard	Beschreibung
`--type`, `-t`	`product`, `taxon`	Bildtyp, mehrfach angebbar. Erlaubt sind `product`, `taxon` und `avatar`
`--locale`, `-l`	alle aktivierten Shop-Sprachen	Sprache, mehrfach angebbar
`--force`	aus	Ersetzt auch vorhandene Texte
`--dry-run`	aus	Nur berichten, nichts schreiben

bin/console mmd:media-alt-text:backfill --dry-run
bin/console mmd:media-alt-text:backfill --locale=de_DE --type=product

Der Befehl:

füllt eine Sprache nur aus einem Namen, der in genau dieser Sprache geschrieben ist (kein Rückgriff auf eine andere Sprache)
lässt vorhandene Texte stehen, außer mit --force
fasst als dekorativ markierte Bilder nie an
überspringt Avatars, solange Du nicht --type=avatar angibst
kürzt Namen auf 255 Zeichen
meldet am Ende, wie viele Bilder er geprüft hat, wie viele Texte er angelegt oder ersetzt hat und wie viele er unverändert ließ
beendet sich bei einem unbekannten Typ oder einer nicht aktivierten Sprache mit Fehlermeldung, ohne etwas zu schreiben

Ein Produktname ist ein Startpunkt für Redakteure, keine Bildbeschreibung. Prüfe die erzeugten Texte, bevor Du Dich auf sie verlässt.

Praxisbeispiele

Neuer Shop, Texte nach und nach pflegen: Plugin installieren, nichts weiter tun. Bilder ohne Text geben weiter den Produktnamen aus, Redakteure ergänzen Texte beim Bearbeiten der Produkte.

Bestehender Shop mit vielen Produkten: Erst ein Probelauf, dann nur die Standardsprache füllen:

bin/console mmd:media-alt-text:backfill --dry-run
bin/console mmd:media-alt-text:backfill --locale=de_DE

Plugin vorübergehend ausblenden: Schalter „Alt-Texte ausgeben“ ausschalten. Es geht nichts verloren, die Felder im Admin sind weg und der Shop verhält sich wie vorher.