M0059 Glossary Tooltips für Gambio
Handbuch
1. Was das Modul für Sie tut
Viele Shops arbeiten mit Fachbegriffen: Materialien, Prüfsiegel, technische Kennwerte, Abkürzungen aus der Branche. Für Sie sind diese Begriffe selbstverständlich – für einen Teil Ihrer Besucher sind sie es nicht. Wer einen Begriff nicht versteht, fragt selten nach. Er verlässt die Seite.
Das Modul löst das, ohne Ihre Texte aufzublähen: Sie hinterlegen einmal zentral eine Liste von Schlagwörtern mit jeweils einer kurzen Erklärung. Überall dort, wo eines dieser Schlagwörter in Ihren Shoptexten vorkommt, wird es automatisch als erklärungsbedürftiger Begriff kenntlich gemacht. Fährt der Besucher mit der Maus darüber (oder klickt darauf – Sie entscheiden), erscheint Ihre Erklärung als kleines Einblendfenster direkt am Begriff.
Der große Vorteil: Sie pflegen die Erklärung einmal. Sie wirkt danach in jeder Artikelbeschreibung, in jedem Content-Text und in jedem Text-Widget, in dem der Begriff auftaucht – auch in Texten, die Sie erst morgen schreiben.
Auf Wunsch bündelt das Modul alle Erklärungen zusätzlich auf einer eigenen Glossarseite in Ihrem Shop. Aus der reinen Bedienhilfe wird damit eine eigenständige Seite mit echtem Inhalt – für Ihre Besucher wie für Suchmaschinen (Kapitel 5).
2. Wo Sie das Modul im Backend finden
Das Modul bringt zwei Anlaufstellen im Shop-Administrationsbereich mit.
Die Einstellungen finden Sie im Menü „Xycons-Module“ unter „Kundenkonto / Setups“. Dort gibt es für jedes installierte Modul einen eigenen Reiter; der Reiter trägt den Modultitel „Glossary Tooltips“. Hier schalten Sie das Modul ein und legen fest, wie und wo die Tooltips erscheinen.
Die Schlagwortliste selbst erreichen Sie über den Menüpunkt „Glossary Tooltips“ im Menü „Xycons-Module“. Dort legen Sie Ihre Begriffe und deren Erklärungen an.
3. Die Einstellungen im Setup
Jede Option im Setup ist dort zusätzlich mit einem kurzen Hinweistext beschrieben. Die folgende Übersicht erklärt, was die Einstellungen praktisch bedeuten – und was jeweils voreingestellt ist.
3.1 Modulstatus
Der Schalter zum Ein- und Ausschalten des kompletten Moduls. (Standard: ausgeschaltet.) Ist das Modul ausgeschaltet, erscheint im Shop keinerlei Tooltip, und es wird auch nichts zusätzlich in Ihre Seiten geschrieben – der Shop verhält sich exakt so, als wäre das Modul nicht vorhanden.
Ihre angelegten Schlagwörter bleiben dabei vollständig erhalten. Sie können das Modul also gefahrlos abschalten und später wieder einschalten, ohne etwas neu anlegen zu müssen. Solange das Modul ausgeschaltet ist, weist ein deutlich rot hinterlegter Hinweis im Backend darauf hin.
3.2 Auslöse-Modus
Hier legen Sie fest, wodurch ein Tooltip erscheint (Standard: Mouseover):
- Mouseover – die Erklärung erscheint, sobald der Besucher mit der Maus über dem Schlagwort steht, und verschwindet, wenn er es wieder verlässt.
- Klick – die Erklärung erscheint erst, wenn der Besucher das Schlagwort anklickt, und bleibt dann stehen, bis er woanders hin klickt.
Für die meisten Shops ist „Mouseover“ die richtige Wahl: Der Besucher bekommt die Information ohne jede Hürde. Auf Touchgeräten wird in beiden Betriebsarten getippt – dazu mehr in Kapitel 8.
3.3 Hinweis-Icon
Standardmäßig erkennt der Besucher ein erklärtes Schlagwort an einer gepunkteten Unterstreichung. Zusätzlich können Sie eine kleine Grafik direkt hinter dem Schlagwort anzeigen lassen – zum Beispiel ein Fragezeichen- oder Info-Symbol. Tragen Sie dazu den Dateinamen der Grafik in das Feld ein (Standard: tooltip_icon.png). Die Grafik muss auf dem Server in folgendem Ordner liegen:
/GXModules/Xycons/M0059/ModuleData/assets/images/
Eine passende Beispielgrafik wird mitgeliefert. Lassen Sie das Feld leer, wenn Sie keine Grafik wünschen.
3.4 Wie genau ein Schlagwort erkannt wird
Drei Einstellungen bestimmen, wie streng das Modul beim Erkennen eines Begriffs vorgeht. Sie wirken zusammen und sind so voreingestellt, dass sich am Verhalten eines bestehenden Shops nach einem Update nichts ändert.
| Einstellung | Was sie bewirkt |
|---|---|
| Nur ganze Wörter (Standard: nein) |
Steht diese Option auf „ja“, wird ein Schlagwort nur dann erkannt, wenn es als eigenständiges Wort im Text steht. Andernfalls greift es auch innerhalb längerer Wörter – der Eintrag „Wolle“ dann auch in „Merinowolle“, der Eintrag „Tex“ auch mitten in „Textilien“. |
| Nur einmal je Text (Standard: nein) |
Steht diese Option auf „ja“, wird ein Begriff je Textbereich nur beim ersten Vorkommen ausgezeichnet. Das hält lange Beschreibungen ruhig, in denen ein Fachbegriff zehnmal auftaucht. |
| Groß- und Kleinschreibung (Standard: genaue Schreibweise) |
Steht diese Option auf „ignorieren“, wird „Wolle“ auch dort gefunden, wo im Text „wolle“ steht. |
3.5 Anzeigebereiche
Sie bestimmen selbst, in welchen Bereichen Ihres Shops die Tooltips aktiv werden. Jeder Bereich lässt sich einzeln zu- und abschalten; alle fünf sind im Auslieferungszustand eingeschaltet.
| Bereich | Was damit gemeint ist |
|---|---|
| Produkt-Detailseite | Der Beschreibungstext eines Artikels auf seiner eigenen Seite. |
| Kategorie-Listung | Die Kurz- und Beschreibungstexte, die in Artikellisten und Übersichten erscheinen. |
| Content-Seiten | Ihre eigenen Inhaltsseiten sowie Text-Widgets, zum Beispiel auf der Startseite. |
| Produkt-TABs | Die zusätzlichen Reiter an einem Artikel, etwa für Pflegehinweise oder technische Daten. |
| Externe Content-Seiten | Inhaltsseiten, deren Inhalt aus einer eigenen Datei im Ordner „media/content“ stammt. |
3.6 Die Glossarseite
Drei weitere Einstellungen steuern die eigene Glossarseite im Shop. Was diese Seite kann und wie Sie sie einbinden, steht in Kapitel 5.
| Einstellung | Was sie bewirkt |
|---|---|
| Glossarseite im Shop (Standard: aus) |
Schaltet die öffentliche Seite frei. Solange die Option aus ist, ist die Seite für Besucher nicht erreichbar. |
| Strukturierte Daten (Standard: an) |
Gibt die Begriffe der Glossarseite zusätzlich maschinenlesbar aus. Suchmaschinen und KI-Antwortdienste erkennen die Seite dadurch zuverlässig als Glossar. |
| Verweis auf passende Artikel (Standard: an) |
Setzt hinter jede Erklärung einen Verweis auf die Shopsuche nach diesem Begriff. |
4. Schlagwörter anlegen und pflegen
Die Schlagwortliste ist das Herzstück. Sie zeigt die Einträge der gerade gewählten Sprache, alphabetisch sortiert, mit den hinterlegten Schreibweisen und einer Kurzvorschau der Erklärung.
4.1 Einen neuen Eintrag anlegen
Über die Schaltfläche zum Anlegen eines neuen Eintrags öffnen Sie die Eingabemaske. Sie besteht aus drei Feldern:
- Schlagwort – der Begriff, der in Ihren Texten erkannt werden soll. Maximal 50 Zeichen.
- Weitere Schreibweisen – optional, siehe Abschnitt 4.2.
- Tooltip-Text – die Erklärung, die dem Besucher angezeigt wird. Hier steht Ihnen der gewohnte Editor zur Verfügung: Sie können den Text formatieren, hervorheben und auch Bilder einfügen.
Ob das Schlagwort genau so geschrieben im Text stehen muss, wie Sie es eintragen, entscheiden die Einstellungen aus Abschnitt 3.4.
Innerhalb einer Sprache darf jedes Schlagwort nur einmal vorkommen. Versuchen Sie, einen bereits vorhandenen Begriff ein zweites Mal anzulegen, weist das Modul Sie darauf hin und behält Ihre Eingabe in der Maske, damit nichts verloren geht.
4.2 Weitere Schreibweisen hinterlegen
Ein Fachbegriff taucht in Texten selten in nur einer Form auf. Statt für jede Variante einen eigenen Eintrag anzulegen, tragen Sie die Varianten einfach in das Feld Weitere Schreibweisen ein – getrennt durch Semikolon:
Schurwolle;Schafwolle;Wollfaser
Alle dort genannten Formen erhalten dieselbe Erklärung wie das Hauptschlagwort. Das eignet sich für Synonyme, für die Mehrzahl, für gebräuchliche Abkürzungen und für die ausgeschriebene Variante einer Abkürzung.
4.3 Einen Eintrag ändern oder löschen
In der Liste führt das Stift-Symbol in die Bearbeitungsmaske, das Papierkorb-Symbol löscht den Eintrag. Vor dem Löschen fragt ein Fenster noch einmal nach und nennt Ihnen den betroffenen Begriff. Erst nach Ihrer Bestätigung wird der Eintrag entfernt.
Änderungen wirken sofort. Sobald Sie gespeichert haben, zeigt der Shop die neue Erklärung an allen Stellen an, an denen der Begriff vorkommt.
4.4 Suchen und blättern
Über dem Verzeichnis finden Sie ein Suchfeld. Es durchsucht Schlagwörter, weitere Schreibweisen und Erklärungstexte der gewählten Sprache – hilfreich, wenn Sie wissen wollen, ob ein Begriff bereits erklärt ist, oder wenn Sie alle Einträge zu einem Thema zusammen sehen möchten.
Längere Listen werden auf Seiten zu je 50 Einträgen aufgeteilt; unter der Liste stehen die Seitenzahlen und die Gesamtzahl der Einträge.
4.5 Mehrere Sprachen pflegen
Die Schlagwortliste wird je Sprache geführt. Über die Flaggen oberhalb der Liste wechseln Sie zwischen den aktiven Sprachen Ihres Shops; die gerade gewählte Sprache wird Ihnen darunter angezeigt.
Ein Besucher sieht immer nur die Einträge derjenigen Sprache, in der er den Shop gerade betrachtet. Legen Sie deutsche Fachbegriffe also in der deutschen Liste an und deren englische Entsprechungen in der englischen. Ein Eintrag der einen Sprache wirkt niemals in die andere hinein – so vermeiden Sie, dass ein deutscher Begriff im englischen Shop erklärt wird.
4.6 Listen austauschen und übernehmen
Für die Arbeit an größeren Glossaren gibt es zwei Werkzeuge über der Liste.
Als CSV speichern lädt die Schlagwortliste der gewählten Sprache als Tabellendatei herunter. Sie enthält je Zeile das Schlagwort, die weiteren Schreibweisen und die Erklärung und lässt sich direkt in Excel oder einer vergleichbaren Tabellenkalkulation öffnen. Das ist der bequemste Weg, um viele Einträge auf einmal zu überarbeiten – oder um sie einem Übersetzungsbüro zu übergeben.
CSV einlesen spielt eine solche Datei wieder ein. Bereits vorhandene Schlagwörter der Sprache werden dabei aktualisiert, unbekannte neu angelegt. Nach dem Einlesen meldet das Modul, wie viele Einträge angelegt, aktualisiert und übersprungen wurden.
Begriffe übernehmen aus … kopiert die Schlagwörter einer anderen Sprache in die gerade gewählte – als Arbeitsgrundlage für die Übersetzung. Begriffe, die in der Zielsprache bereits vorhanden sind, bleiben unangetastet; bereits geleistete Übersetzungsarbeit wird also nicht überschrieben.
5. Die Glossarseite im Shop
Schalten Sie im Setup die Glossarseite frei, bekommt Ihr Shop eine eigene Seite, auf der alle erklärten Begriffe der jeweiligen Sprache versammelt sind: alphabetisch geordnet, mit einer A–Z-Sprungleiste am Kopf und einer Sprungmarke je Begriff. Sie erreichen die Seite unter dieser Adresse:
shop.php?do=XyconsM0059Glossary
Warum sich das lohnt: Aus vielen kleinen Einblendungen, die eine Suchmaschine kaum bewerten kann, wird eine zusammenhängende Seite mit echtem, fachlichem Inhalt. Genau solche Seiten beantworten die Fragen, die Menschen vor einem Kauf in eine Suchmaschine tippen – und mit den strukturierten Daten (Abschnitt 3.6) erkennen auch KI-Antwortdienste unmissverständlich, dass hier ein Glossar steht.
Ist der Verweis auf passende Artikel eingeschaltet, steht hinter jeder Erklärung ein Link auf die Shopsuche nach diesem Begriff. Das führt Besucher von der Erklärung direkt zum Sortiment und verbindet die Seite mit dem Rest Ihres Shops.
Die Seite zeigt immer die Begriffe der Sprache, in der ein Besucher den Shop gerade betrachtet. Sind für eine Sprache noch keine Begriffe hinterlegt, erscheint ein entsprechender Hinweis statt einer leeren Seite.
6. So wählen Sie gute Schlagwörter
Ein Glossar wirkt am besten, wenn es sparsam eingesetzt wird. Ein paar Erfahrungswerte aus der Praxis:
- Erklären Sie, was erklärungsbedürftig ist. Fachbegriffe, Siegel, Materialbezeichnungen und Abkürzungen sind ideal. Alltagswörter sind es nicht.
- Halten Sie die Erklärung kurz. Zwei bis drei Sätze reichen. Die Einblendung ist ein Hinweis, kein Ratgeberartikel. Für die Glossarseite dürfen es ruhig ein paar Sätze mehr sein.
- Achten Sie auf kurze Begriffe. Solange die Erkennung innerhalb von Wörtern erlaubt ist, taucht ein sehr kurzes Schlagwort schnell an unerwarteter Stelle auf. Entweder Sie schalten „Nur ganze Wörter“ ein (Abschnitt 3.4), oder Sie wählen von vornherein eindeutige, längere Begriffe.
- Nutzen Sie die weiteren Schreibweisen statt mehrerer Einträge für denselben Sachverhalt. Das hält die Liste übersichtlich und die Erklärungen konsistent.
- Bauen Sie die Liste schrittweise auf. Fangen Sie mit den zehn Begriffen an, zu denen Sie im Kundenkontakt am häufigsten Fragen bekommen. Das ist erfahrungsgemäß der wertvollste Teil des Glossars.
- Vermeiden Sie Begriffe, die in Ihrer Navigation stehen. Ein Tooltip mitten im Menü wirkt schnell störend.
7. Tooltips in einem Textbereich unterdrücken
Manchmal soll ein bestimmter Text unangetastet bleiben – etwa eine rechtliche Angabe, eine Tabelle mit technischen Daten oder ein besonders gestalteter Abschnitt. Für diesen Fall gibt es einen Schalter direkt im Text.
Wechseln Sie im Editor in die Quelltextansicht des betreffenden Textbereichs und tragen Sie dort folgenden Kommentar ein:
<!-- No0059 -->
Sobald dieser Kommentar im Text gefunden wird, findet für diesen Textbereich keinerlei Tooltip-Erzeugung statt. Wo genau im Text der Kommentar steht, spielt keine Rolle.
8. Bedienung mit Tastatur und auf Touchgeräten
Ein erklärter Begriff ist nicht nur mit der Maus erreichbar. Besucher, die mit der Tastatur navigieren, springen mit der Tabulatortaste auf das Schlagwort; die Erklärung erscheint, sobald der Begriff den Fokus hat. Mit Eingabe- oder Leertaste lässt sie sich festhalten, mit der Escape-Taste wieder schließen. Vorlesesoftware kündigt die Erklärung als zugehörige Beschreibung des Begriffs an.
Auf Smartphones und Tablets gibt es keinen Mauszeiger. Dort öffnet ein Tippen auf den Begriff die Erklärung – unabhängig davon, welchen Auslöse-Modus Sie eingestellt haben. Ein Tippen an eine andere Stelle schließt sie wieder.
Würde eine Einblendung am rechten Bildrand aus dem sichtbaren Bereich hinauslaufen, richtet das Modul sie automatisch rechtsbündig am Begriff aus. Auf schmalen Bildschirmen bleibt die Erklärung dadurch vollständig lesbar.
9. Das Aussehen anpassen
Die mitgelieferte Gestaltung – gepunktete Unterstreichung am Begriff, dunkles Einblendfenster mit weißer Schrift – passt zu den meisten Designs. Möchten Sie Farben, Schriftgröße oder Breite an Ihr Design angleichen, ist das über eigenes CSS möglich.
Die Gestaltungsregeln des Moduls liegen in diesen Dateien Ihres Shops:
/GXModules/Xycons/M0059/Shop/Themes/All/Css/M0059.css (Tooltips) /GXModules/Xycons/M0059/Shop/Styles/M0059_page.css (Glossarseite)
Diese Bezeichnungen können Sie in Ihrem eigenen CSS ansprechen:
| Bezeichnung | Betrifft |
|---|---|
| xytooltip_switch | Das Schlagwort im Text, also die Stelle, die den Tooltip auslöst. |
| xytooltip_unvisible | Das Einblendfenster mit Ihrer Erklärung. |
| xytooltip_open | Ein Schlagwort, dessen Erklärung gerade festgehalten wird. |
| xytooltip_icon | Das optionale Hinweis-Icon hinter dem Schlagwort. |
| m0059-glossary | Der gesamte Inhalt der Glossarseite. |
10. Modultexte ändern
Sämtliche Texte, die das Modul im Shop und im Backend anzeigt, lassen sich an Ihre Tonalität anpassen. Nutzen Sie dafür die Shopfunktion „Texte ändern“ im Administrationsbereich Ihres Shops.
Die Texte des Backends finden Sie dort im Bereich m0059; sie beginnen einheitlich mit XYCONS_MOD0059_. Die Texte der Glossarseite – Überschrift, Einleitung und die Beschriftungen – stehen im Bereich m0059_shop. Gerade die Einleitung der Glossarseite lohnt eine eigene Formulierung: Sie ist der erste Satz, den ein Besucher dort liest.
Auf diesem Weg passen Sie die Texte je Sprache an, ohne dass eine Datei geändert werden muss – Ihre Anpassungen bleiben deshalb auch bei einem Modulupdate erhalten.
11. Shopupdate und Modulpflege
Planen Sie ein Service Pack oder ein Master-Update Ihres Shops, prüfen Sie vorher, ob das Modul und die Modulumgebung für die neue Shopversion freigegeben sind. Beginnen Sie ein Shopupdate erst, wenn die passenden Modulstände tatsächlich verfügbar sind.
Installieren Sie bei einem Shopupdate immer sowohl die neueste Modulversion als auch die neueste Version der Modulumgebung. Beide gehören zusammen; eine veraltete Modulumgebung kann auch ein aktuelles Modul ausbremsen.
Lassen Sie das Shopupdate durch uns durchführen, aktualisieren wir vorhandene Xycons-Module und die Modulumgebung immer mit, sofern für die Ziel-Shopversion verfügbar.
12. Wenn einmal etwas nicht erscheint
Sollte ein Tooltip nicht auftauchen, arbeiten Sie diese Punkte der Reihe nach ab – in aller Regel klärt sich die Sache dabei:
- Ist das Modul eingeschaltet? Prüfen Sie den Modulstatus im Setup. Ist es ausgeschaltet, sehen Sie dort einen rot hinterlegten Hinweis.
- Ist der betroffene Bereich aktiviert? Produkt-Detailseite, Kategorie-Listung, Content-Seiten, Produkt-TABs und externe Content-Seiten werden getrennt geschaltet.
- Stimmt die Sprache? Einträge wirken nur in der Sprache, in der sie angelegt wurden.
- Stimmt die Schreibweise? Solange die genaue Schreibweise verlangt wird, muss das Schlagwort im Text exakt so stehen wie im Eintrag. Tragen Sie die Variante als weitere Schreibweise nach oder schalten Sie die Groß- und Kleinschreibung auf „ignorieren“.
- Steht „Nur ganze Wörter“ auf ja? Dann wird ein Begriff innerhalb eines längeren Wortes bewusst nicht erkannt.
- Steht der Sperrkommentar im Text? Enthält der Textbereich den Kommentar aus Kapitel 7, wird dort bewusst nichts erzeugt.
- Zeigt der Shop noch eine zwischengespeicherte Seite? Leeren Sie den Shop-Cache und laden Sie die Seite im Browser neu.
Führt die Glossarseite ins Leere, prüfen Sie zusätzlich, ob die Option „Glossarseite im Shop“ eingeschaltet ist und ob der Cache Ihres Shops nach der Installation geleert wurde.
Bleibt danach etwas unklar, melden Sie sich gern bei uns – am besten mit der Adresse der betroffenen Seite und dem Begriff, um den es geht.
Wir wünschen Ihnen viel Erfolg beim Einsatz dieses Moduls!
