Guideテンプレートのバージョンについて

Guideテンプレートは、ヘルプセンターのテーマパッケージをレンダリングします。これには、テンプレートファイル、CSSおよびJSファイル、マニフェストファイルで使用されるCurlybarsのテンプレート言語が含まれます。

Guideテンプレートは、テンプレートAPIとしても知られています。

Guideのテーマの詳細については、「ヘルプセンターテーマのカスタマイズ」とヘルプセンターのテンプレートの開発者向けドキュメントを参照してください。

この記事では、次のトピックについて説明します。

• Guideテンプレートのバージョンについて
• テンプレートのバージョンを確認する
• Guideテンプレートのバージョン1からバージョン2へのアップグレード

Guideテンプレートのバージョンについて

2020年2月24日にリリースされたテンプレートAPI V2は、Copenhagenテーマと新しいテーマのすべてのリリースに適用されます。

テーマをカスタマイズしている場合は、テンプレートAPI V1を引き続き使用することができます。新機能を利用したり、パフォーマンスを向上させたい場合を除き、V2にアップグレードする必要はありません。使用しているフレームワークのバージョンをGuideで確認することができます（「テンプレートのバージョンを確認する」を参照）。

V2では、テーマ内のバニラJavaScript（script.jsやdocument_head.hbsなど）を使用できる場所でjQueryステートメントを使用できなくなりました。V2でjQueryを使用したい場合は、jQueryライブラリをインポートする必要があります。

また、いくつかのヘルパーを非推奨にし、HTMLではなくデータオブジェクトを出力するように変更しました。完全なリストはこちらで確認いただけます。

テンプレートのバージョンを確認する

テンプレートのバージョンは、テーマのコードを編集ビューまたはマニフェストファイルから確認することができます。

テンプレートのバージョンを確認するには

1. Guideで、サイドバーにあるデザインをカスタマイズアイコン（）をクリックします。
2. 確認したいテーマで「カスタマイズ」をクリックします。
3. 「コードを編集」をクリックします。
4. テーマ名の下には、テンプレートのバージョン番号、たとえば、「テンプレートAPI v2」と表示されます。

   

   このバージョン番号は、マニフェストファイルのapi_versionフィールドに対応しています。

Guideテンプレートのバージョン1からバージョン2へのアップグレード

Guideテーマをカスタマイズしている場合は、バージョン2にアップグレードすることで、新機能を利用したり、パフォーマンスを向上させることができます。

テンプレートのバージョンをアップグレードするには

1. ヘルプセンターテーマをダウンロードします（「ヘルプ センターのテーマをダウンロードする」を参照）。
2. テーマパッケージをローカルに開き、manifest.jsonファイルを編集します。
3. manifest.jsonファイルで、api_versionフィールドを見つけ、値を2に変更します。
4. テーマの変更をローカルでプレビューします。テーマをプレビューするときに、バージョン2で非推奨となったヘルパーを使用していると警告が表示されます。
5. 非推奨のヘルパーを使用している場合は、こちらの情報を使用して、サポートされている同等のヘルパーに置き換えてください。

   テーマを再度プレビューして、他に警告がないことを確認してください。

6. 更新されたテーマをGuideにアップロードします（「ヘルプセンターテーマのインポート」を参照してください）。

   新しいバージョンが適用されているかどうかは、テンプレートのバージョンを調べることで確認できます。