Übersicht über die Templating-Versionen von Guide

Die Help-Center-Designpakete werden durch Guide-Vorlagen umgesetzt. Dazu gehören die Vorlagensprache Curlybars, die in den Vorlagendateien verwendet wird, sowie CSS- und JavaScript-Dateien und die Manifestdatei.

Die Guide-Vorlagen werden über die Templating API realisiert.

Weitere Informationen zu den Guide-Designs finden Sie unter Anpassen des Help-Center-Designs und in der Entwicklerdokumentation für die Help-Center-Vorlagen.

In diesem Beitrag werden folgende Themen behandelt:

• Übersicht über die Templating-Versionen von Guide
• Prüfen der verwendeten Templating-Version
• Migrieren von Templating-Version 1 auf Version 2

Übersicht über die Templating-Versionen von Guide

Version 2 der Templating API wurde am 24. February 2020 freigegeben. Diese Version gilt für das Design „Copenhagen“ und alle neuen veröffentlichten Designs.

Wenn Sie Ihr Design angepasst haben, können Sie weiterhin mit Version 1 der Templating API arbeiten und brauchen nicht auf Version 2 zu migrieren, es sei denn, Sie möchten die neuen Funktionen und die Leistungsverbesserungen nutzen. Welche Version des Frameworks Sie in Guide verwenden, können Sie wie unter Prüfen der verwendeten Templating-Version beschrieben ermitteln.

Bei Version 2 ist es nicht mehr möglich, jQuery-Anweisungen an den Stellen in einem Design zu verwenden, an denen herkömmliche JavaScript-Anweisungen wie script.js oder document_head.hbs genutzt werden können. Wenn Sie bei Version 2 auf jQuery zurückgreifen möchten, müssen Sie die jQuery-Bibliothek zu importieren.

Darüber hinaus sind in Version 2 bestimmte Helper nicht mehr verfügbar, und andere geben jetzt Datenobjekte statt HTML aus. Eine vollständige Liste finden Sie hier.

Prüfen der verwendeten Templating-Version

Die verwendete Templating-Version geht aus der Ansicht Code bearbeiten des Designs sowie aus der Manifestdatei hervor.

So prüfen Sie die verwendete Templating-Version

1. Klicken Sie in der Seitenleiste von Guide auf das Symbol Erscheinungsbild anpassen ().
2. Klicken Sie neben dem gewünschten Design auf Anpassen.
3. Klicken Sie auf Code bearbeiten.
4. Unter dem Vorlagennamen erscheint die Nummer der verwendeten Templating-Version, in diesem Beispiel Templating API v2.

   

   Die Versionsnummer entspricht dem Feld api_version in der Manifestdatei.

Migrieren von Templating-Version 1 auf Version 2

Wenn Sie Ihr Guide-Design angepasst haben, können Sie auf Version 2 migrieren, um die neuen Funktionen und die Leistungsverbesserungen zu nutzen.

So migrieren Sie auf die neueste Templating-Version

1. Laden Sie Ihr Help-Center-Design herunter (siehe Herunterladen eines Help-Center-Designs).
2. Öffnen Sie das Designpaket auf Ihrem lokalen System und bearbeiten Sie die Datei manifest.json.
3. Gehen Sie in der Datei manifest.json zum Feld api_version und ändern Sie den Wert in 2.
4. Zeigen Sie eine lokale Vorschau der Designänderungen an. Wenn Sie Helper verwenden, die in Version 2 nicht mehr unterstützt werden, erscheinen entsprechende Warnungen.
5. Wenn Sie einen nicht mehr unterstützten Helper verwenden, ersetzen Sie ihn anhand dieser Informationen durch einen unterstützten Helper.

   Zeigen Sie erneut eine Vorschau des Designs an, um sicherzustellen, dass keine Warnungen mehr ausgelöst werden.

6. Laden Sie das aktualisierte Datei auf Guide hoch (siehe Importieren des Help-Center-Designs).

   Ermitteln Sie die Templating-Version, um sicherzustellen, dass die neue Version verwendet wird.