> ## Documentation Index
> Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt
> Use this file to discover all available pages before exploring further.

# Glossar

> Fachbegriffe in Produktbeschreibungen automatisch verlinken und in einem alphabetischen Index zusammenfassen.

Technische Produktbeschreibungen stecken voller Begriffe, die der Fachmann kennt und der Käufer nicht. Wer nicht weiß, was eine Angabe bedeutet, kann zwei Produkte nicht vergleichen und kauft im Zweifel keines von beiden.

Das Glossar-Modul löst das, ohne dass Sie jede Produktbeschreibung anfassen müssen: Sie pflegen die Begriffe einmal zentral, und WEBSALE V8s sucht sie selbstständig in allen Produktbeschreibungen und verlinkt sie. Ein Klick öffnet die Erklärung.

Das Glossar-Modul ist kostenpflichtig und muss von der WEBSALE-Technik freigeschaltet werden.

## Was das Modul leistet

| Leistung | |
| - | - |
| Automatische Verlinkung | Der Shop findet die Begriffe in den Produktbeschreibungen selbst und setzt die Links |
| Automatischer Index | Ein alphabetisch sortiertes Verzeichnis aller Begriffe entsteht ohne Ihr Zutun |
| Mehrsprachigkeit | Je Sprache eigene Begriffe und eigene Sortierregeln |

Die Begriffe und ihre Beschreibungen geben Sie im Online-Servicebereich ein. Dort erzeugen Sie anschließend auch das Glossar.

Wegweiser: [Online-Servicebereich](https://dokumentation.websale.de/v8s/online-servicebereich)

### Sprachabhängige Sortierung

Der Index sortiert nach den Regeln der jeweiligen Sprache. In einem deutschsprachigen Shop erscheinen unter "A" deshalb auch die Begriffe mit "Ä", entsprechend DIN 5007-1. Für andere Sprachen gelten andere Regeln.

### Schreibweisen und Wortformen

Die Suche in den Produktbeschreibungen unterscheidet Groß- und Kleinschreibung. Sie findet außerdem nur die Wortform, die Sie eingetragen haben.

> [!WARNING]
>
> Der Shop erkennt weder eine abweichende Schreibweise noch eine andere Wortform von selbst. Steht "Akku" im Glossar, bleibt "Akkus" in der Produktbeschreibung unverlinkt, und "akku" ebenso. Sie müssen jede Form eintragen, die in Ihren Beschreibungen tatsächlich vorkommt.

Im Deutschen betrifft das vor allem Einzahl und Mehrzahl, denn Substantive stehen ohnehin groß. Im Englischen betrifft es zusätzlich fast jeden Begriff, weil er am Satzanfang groß und sonst klein geschrieben wird.

Damit Sie deswegen keine Beschreibung mehrfach anlegen müssen, können Sie im Servicebereich **mehrere Begriffe zu einem Eintrag** zusammenfassen und dabei festlegen, welcher dieser Begriffe im Index erscheint.

Der Doppelnutzen: Die Beschreibung steht nur einmal und ist damit nur einmal zu pflegen, und der Index bleibt aufgeräumt, weil dort nicht "Akku", "Akkus" und "akku" nebeneinander stehen.

## Schritt 1: Das Modul aktivieren

Der Parameter steht in der `shop.config` im Abschnitt `<Basic>`.

```ini theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
<Basic>
   ...
   Glossary-Allow = yes
   ...
</Basic>
```

Enthalten Ihre Produktbeschreibungen HTML-Entitäten, brauchen Sie zusätzlich einen zweiten Parameter im selben Abschnitt.

```ini theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
<Basic>
   ...
   GlossarySupportHTMLEncoding-Allow = yes
   ...
</Basic>
```

Steht in der Produktbeschreibung `&auml;` statt "ä", findet die Glossarsuche den Begriff "Akkulaufzeit für Geräte" ohne diesen Parameter nicht, weil sie nach dem Klartext sucht. Mit dem Parameter berücksichtigt sie die kodierte Schreibweise.

Referenz: [Abschnitt Basic](https://dokumentation.websale.de/v8s/referenz/konfigurationen/shopkonfiguration-shop-config/grundlagen-und-technik.md#basic)

## Schritt 2: Die beiden Templates zuweisen

Das Glossar braucht zwei eigene Templates: eines für die Erklärung eines einzelnen Begriffs und eines für den Index.

```ini theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
<Templates>
   ...
   GlossaryDescr = ws_glossary_descr.htm
   GlossaryIndex = ws_glossary_index.htm
   ...
</Templates>
```

| Eintrag | Zeigt |
| - | - |
| `GlossaryDescr` | die Erklärung eines Begriffs, standardmäßig in einem Popup-Fenster |
| `GlossaryIndex` | das alphabetische Verzeichnis, als eigene Shopseite |

Referenz: [Abschnitt Templates](https://dokumentation.websale.de/v8s/referenz/konfigurationen/shopkonfiguration-shop-config/grundlagen-und-technik.md#templates)

## Schritt 3: Das Template für die Erklärung anlegen

Dieses Template ist kurz. Es zeigt den Begriff und seine Beschreibung.

```html theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{Glossary-Data}
   <h1>~Glossary-Name~</h1>
   <p>~Glossary-Descr~</p>
{/Glossary-Data}
```

Die Klammerung `{Glossary-Data}` greift nur, wenn zu dem angeforderten Begriff tatsächlich eine Beschreibung gefunden wurde. Bauen Sie den Gegenzweig `{!Glossary-Data}` mit einem Hinweis dazu, sonst sieht der Käufer im Fehlerfall ein leeres Fenster und weiß nicht, ob es noch lädt.

Referenz: [Glossary-Data](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md#das-beschreibungstemplate) · [Glossary-Name](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md#das-beschreibungstemplate) · [Glossary-Descr](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md#das-beschreibungstemplate)

## Schritt 4: Die Größe des Popup-Fensters festlegen

Die Maße des Fensters stehen im Bereich `WS-Config` der Produktdetailansicht `ws_product.htm`, also dort, wo die verlinkten Begriffe stehen.

```html theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{WS-Config}
   ...
   GlossaryWindowWidth  = 740
   GlossaryWindowHeight = 480
   ...
{/WS-Config}
```

Ohne diese Angaben öffnet der Shop das Fenster 540 Pixel breit und 450 Pixel hoch. Das reicht für einen Satz, aber nicht für eine ausführliche Erklärung mit Abbildung.

Referenz: [WS-Config](https://dokumentation.websale.de/v8s/referenz/tags/ws/shop-seite-und-technik.md#die-tags-im-uberblick)

## Schritt 5: Das Template für den Index anlegen

Der Index besteht aus zwei Teilen: der Buchstabenleiste und der Liste der Begriffe zum gewählten Buchstaben.

![Glossarindex2](https://mintcdn.com/websaleag-44ee7ea6/kWrWhXMhC1RLz3Kh/images/glossarindex2.jpg?fit=max\&auto=format\&n=kWrWhXMhC1RLz3Kh\&q=85\&s=8b72170daf9b169e617ceeaa3a763ae7)

```html theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{CAT-AdvData($Glossary,99)}

   ~Glossary-Index~

   {@Glossary-Data}
      <a href="~Glossary-DescrLink~">~Glossary-Name~</a><br>
   {/@Glossary-Data}

{/CAT-AdvData($Glossary,99)}
```

| Tag | Erzeugt |
| - | - |
| `Glossary-Index` | die Tabelle der Buchstaben, aus den im Servicebereich hinterlegten Buchstabenkombinationen |
| `@Glossary-Data` | die Schleife über alle Begriffe zum gewählten Buchstaben |
| `Glossary-DescrLink` | den Link auf die Erklärung des Begriffs |

`Glossary-Data` verhält sich hier anders als in Schritt 3. Als Schleife durchläuft es die Begriffsliste, als Klammerung lädt es die eine angeforderte Beschreibung. Dasselbe Tag, zwei Aufgaben, abhängig vom Typ.

> [!WARNING]
>
> Ältere Beispiele öffnen den Link hier mit `window.open` und übergeben die Fenstereigenschaften als einzelne Argumente, etwa `scrollbars='yes', resizable='no', width='740'`. Das ist kein gültiger Aufruf. `window.open` erwartet alle Eigenschaften als **eine** Zeichenkette, durch Kommas getrennt. Übergeben als einzelne Argumente werden sie ignoriert, und das Fenster öffnet in Standardgröße.

Wenn Sie im Index ebenfalls ein Fenster öffnen wollen, schreiben Sie es so:

```html theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{@Glossary-Data}
   <a href="#" onclick="window.open('~Glossary-DescrLink~','Glossar','scrollbars=yes,resizable=no,width=740,height=480'); return false;">~Glossary-Name~</a><br>
{/@Glossary-Data}
```

Ein zusätzliches Tag `Glossary-ListLink` liefert den Link zurück auf den Index, und zwar auf den aktuellen Buchstaben und den aktuellen Begriff. Im Fenster mit der Erklärung können Sie damit einen Weg zurück in die Liste anbieten.

Referenz: [Glossary-Index](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md#das-indextemplate) · [Glossary-DescrLink](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md#das-indextemplate) · [Glossary-ListLink](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md#das-indextemplate) · [CAT-AdvData()](https://dokumentation.websale.de/v8s/referenz/tags/cat/navigation-und-kategoriebaum.md#cat-advdata)

## Schritt 6: Den Index verlinken

Damit der Index auch ohne den Umweg über einen Begriff in der Produktbeschreibung erreichbar ist, setzen Sie einen Link mit dem Parameter `act=glossary_index`.

```html theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
<a href="~WS-Link~&act=glossary_index">Zum Glossar</a>
```

Dieser Link gehört an eine Stelle, die auf allen Seiten sichtbar ist, beispielsweise in die Fußzeile. Ein Glossar, das man nur über einen zufällig passenden Begriff in einer Produktbeschreibung erreicht, wird kaum gefunden.

Referenz: [WS-Link()](https://dokumentation.websale.de/v8s/referenz/tags/ws/shop-seite-und-technik.md#die-tags-im-uberblick)

## Die Anzeige der Begriffe selbst gestalten

Standardmäßig erzeugt der Shop für jeden gefundenen Begriff einen Link, der ein Popup-Fenster öffnet. Wollen Sie stattdessen eine Ebene über der Seite oder einen Tooltip zeigen, überschreiben Sie diesen Link mit dem Parameter `AltGlossaryLink` im Bereich `WS-Config`.

In Ihrem eigenen Markup stehen drei Platzhalter zur Verfügung, die der Shop je Begriff ersetzt.

| Platzhalter | Wird ersetzt durch |
| - | - |
| `~WS-Link~` | die Adresse der Erklärungsseite |
| `~PhraseID~` | die interne Nummer des Begriffs |
| `~Glossary-Name~` | der Begriff selbst, wie er in der Beschreibung steht |

```html theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{WS-Config}
   ...
   AltGlossaryLink = <a href="#" class="glossar" data-id="~PhraseID~" onclick="zeigeGlossar('~WS-Link~','~PhraseID~'); return false;">~Glossary-Name~</a>
   ...
{/WS-Config}
```

> [!WARNING]
>
> Der Platzhalter `~Glossary-Name~` muss in Ihrem Markup vorkommen, sonst verschwindet der Begriff aus dem Fließtext. Der Shop ersetzt das gefundene Wort vollständig durch das, was Sie hier hinterlegen.

Die Maße aus `GlossaryWindowWidth` und `GlossaryWindowHeight` wirken nur auf den Standardlink. Sobald Sie `AltGlossaryLink` setzen, bestimmen Sie die Darstellung vollständig selbst.

Referenz: [WS-Config](https://dokumentation.websale.de/v8s/referenz/tags/ws/shop-seite-und-technik.md#die-tags-im-uberblick)

## Styles

Der Shop erzeugt die Glossar-Elemente selbst und vergibt dabei feste Klassennamen. Über diese gestalten Sie sie.

| Klasse | Formatiert |
| - | - |
| `glossary_descr_link` | den verlinkten Begriff in der Produktbeschreibung |
| `glossary_index_table` | die Tabelle mit der Buchstabenleiste |
| `glossary_index` | einen nicht gewählten Buchstaben |
| `glossary_index_selected` | den gewählten Buchstaben |
| `glossary_index_invalid` | einen Buchstaben ohne Begriffe |

Heben Sie `glossary_index_invalid` deutlich ab, beispielsweise ausgegraut und ohne Zeigerwechsel. Sonst klickt der Käufer auf einen Buchstaben und landet auf einer leeren Liste.

Referenz: Styles für Glossar

## Verwandte Themen

* Wegweiser: Online-Servicebereich
* Referenz: [Abschnitt Basic](https://dokumentation.websale.de/v8s/referenz/konfigurationen/shopkonfiguration-shop-config/grundlagen-und-technik.md#basic)
* Referenz: [WS-Config](https://dokumentation.websale.de/v8s/referenz/tags/ws/shop-seite-und-technik.md#die-tags-im-uberblick)


## Related topics

- [Glossary- (Glossar)](https://dokumentation.websale.de/v8s/referenz/tags/glossary-glossar.md)
- [Glossar: Fachbegriffe der WEBSALE-Dokumentation](https://dokumentation.websale.de/glossar.md)
- [Styles für Module und Schnittstellen](https://dokumentation.websale.de/v8s/referenz/styles/module-und-schnittstellen.md)
- [Spezielle Online-Dienste](https://dokumentation.websale.de/v8s/online-servicebereich/spezielle-online-dienste.md)
- [Grundlagen und Technik](https://dokumentation.websale.de/v8s/referenz/konfigurationen/shopkonfiguration-shop-config/grundlagen-und-technik.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.