Guide Templating steuert die Darstellung der Help Center Design-Pakete. Hierzu gehört auch die Vorlagensprache „Curlybars“, die in den Vorlagendateien, den CSS- und JS-Dateien sowie in der Manifestdatei verwendet wird.
Guide Templating wird auch als die Vorlagen-API bezeichnet.
Weitere Informationen zu den Guide-Designs finden Sie unter Anpassen des Help-Center-Designs und in der Dokumentation für Entwickler unter Templating API (Englisch).
Überblick über die Vorlagenversionen von Guide
In der folgenden Tabelle sind die Vorlagenversionen von Guide mit ihrem jeweiligen Veröffentlichungsdatum aufgeführt. Außerdem enthält sie Links zu konkreten Informationen über die jeweils verfügbaren Funktionen in der Dokumentation für Entwickler.
Wie Sie feststellen, welche Version Sie verwenden, erfahren Sie im Abschnitt Überprüfen Ihrer Vorlagenversion.
| Version | Veröffentlichungsdatum | Seite in der Dokumentation für Entwickler |
|---|---|---|
| 1 | 20. November 2014 | – |
| 2 | 24. Februar 2020 | Upgrading from templating API v1 (Englisch) |
| 3 | 1. Juni 2023 | Upgrading from templating API v2 (Englisch) |
| 4 | 2. Juli 2024 | Upgrading from templating API v3 (Englisch) |
Überprüfen der Vorlagenversion
Sie können die Vorlagenversion sehen, wenn Sie das Design bearbeiten oder die Manifestdatei öffnen.
So überprüfen Sie die Vorlagenversion
- Klicken Sie in der Seitenleiste von Wissensadministrator auf das Symbol Erscheinungsbild anpassen (
). - Klicken Sie neben dem gewünschten Design auf Anpassen.
- Klicken Sie auf Code bearbeiten.
- Die Vorlagenversionsnummer ist unter dem Namen des Designs angegeben. Sie lautet beispielsweise „Vorlagen-API v2“.
Diese Versionsnummer entspricht dem Feld
api_versionin der Manifestdatei.
Upgraden der Vorlagenversion
Wenn Sie Ihr Help-Center-Design angepasst haben, können Sie auf die neueste Vorlagenversion upgraden, die neue Funktionen, mehr Leistung und verbesserte Barrierefreiheit bietet.
Für migrierte Designs gelten neue Beschränkungen, die nachfolgend beschrieben sind. Während der Migration selbst werden bestimmte Beschränkungen für Dateitypen und -größen vorübergehend ausgesetzt, damit Sie Ihr Design samt Assets in das neue Design-Erlebnis importieren können; dort ist die Bearbeitung einfacher.
Auch wenn es in den Assets für das alte Design beispielsweise PDFs oder andere Dateien gibt, die nicht mehr unterstützt werden, können Sie das Design migrieren. Danach können Sie das Design exportieren, um alle diese Dateien schnell abzurufen. Sie können das Design aber erst duplizieren und erneut importieren, wenn Sie die nicht unterstützten Dateien aus dem Design entfernt haben.
So upgraden Sie auf die neue Vorlagenversion
- Laden Sie Ihr Help-Center-Design herunter. Weitere Informationen finden Sie unter Herunterladen eines Help-Center-Designs.
- Öffnen Sie das Designpaket lokal und bearbeiten Sie die Datei manifest.json.
- Suchen Sie in der Datei manifest.json das Feld
api_versionund tragen Sie als Wert die Version ein, auf die Sie upgraden möchten. - Zeigen Sie eine lokale Vorschau Ihres Designs an. Wenn Sie Helper verwenden, die in der neuen Version als veraltet gelten, werden beim Aufrufen der Designvorschau entsprechende Warnungen angezeigt.
- Lesen Sie in diesem Fall in der entsprechenden Dokumentation für Entwickler nach, wie Sie den betreffenden Helper durch eine unterstützte Variante ersetzen können (siehe Übersicht über die Vorlagenversionen von Guide).
Rufen Sie die Designvorschau erneut auf und vergewissern Sie sich, dass keine weiteren Warnungen angezeigt werden.
- Laden Sie das aktualisierte Design in Guide hoch. Weitere Informationen finden Sie unter Importieren eines Help-Center-Designs.
Sie können sich vergewissern, dass die neue Version aktiviert ist, indem Sie Ihre Vorlagenversion überprüfen.