Suite | Growth、Professional、EnterpriseまたはEnterprise Plus |
Support | + Guide ProfessionalまたはEnterprise |
Guideテンプレートは、ヘルプセンターのテーマパッケージをレンダリングします。テンプレートファイル、CSSファイル、JSファイル、マニフェストファイルで使用されるCurlybarsテンプレート言語が含まれています。
Guideテンプレートは、テンプレートAPIとも呼ばれます。
ヘルプセンターのテーマの詳細については、「ヘルプセンターテーマのカスタマイズ」および開発者向けドキュメントの「Templating API」を参照してください。
Guideテンプレートのバージョンについて
次の表に、Guideテンプレートのバージョン、リリース日、および関連する開発者向けドキュメントページへのリンクを示します。このドキュメントページでは、各バージョンで利用可能な機能に関する具体的な情報を確認できます。
使用しているバージョンを確認するには、「テンプレートのバージョンを調べる」を参照してください。
バージョン | リリース日 | 開発者のドキュメントページ |
---|---|---|
1 | 2014年11月20日 | 該当なし |
2 | 2020年2月24日 | テンプレートAPI v1からアップグレード |
3 | 2023年6月1日 | テンプレートAPI v2からアップグレード |
4 | 2024年7月2日 | テンプレートAPI v3からアップグレード |
テンプレートのバージョンを確認する
テーマを編集するとき、またはマニフェストファイルを見るときに、テンプレートのバージョンを確認することができます。
テンプレートのバージョンを確認するには
- ナレッジベース管理者で、サイドバーにあるデザインのカスタマイズアイコン(
)をクリックします。
- 表示したいテーマの「カスタマイズ」をクリックします。
- 「コードを編集」をクリックします。
- テーマ名の下に、「テンプレートAPI v2」などのように、テンプレートのバージョン番号が表示されます。
このバージョン番号は、マニフェストファイルの
api_version
フィールドに対応します。
テンプレートのバージョンをアップグレードする
ヘルプセンターのテーマをカスタマイズしている場合、最新のテンプレートバージョンにアップグレードすることで、新機能、パフォーマンスの向上、アクセシビリティの改善などを利用することができます。
テーマエクスペリエンスから移行した場合、移行後のテーマに新しい制限が一部適用されます。移行プロセス中は、以前のテーマやアセットを新しいテーマエクスペリエンスに移行して使いやすくするために、ファイルの種類やファイルサイズの制限をいくつか保留にしています。
たとえば、テーマアセットでサポートされなくなったPDFやその他のファイルが多数ある場合でも、テーマを移行できます。そこから、そのテーマをエクスポートし、サポートされなくなったファイルすべてを簡単に取り出すことができます。ただし、サポートされていないファイルがテーマから削除されるまで、そのテーマを複製または再インポートすることはできません。
テンプレートのバージョンをアップグレードするには
- 「ヘルプセンターのテーマをダウンロードする」の手順に従って、ヘルプセンターのテーマをダウンロードします。
- ローカルでテーマパッケージを開き、manifest.jsonファイルを編集します。
-
manifest.jsonファイルで、
api_version
フィールドを見つけ、値をアップグレードしたいバージョンに変更します。 - テーマに加えた変更をローカルでプレビューします。テーマをプレビューするときに、アップグレード先のバージョンで非推奨となったヘルパーを使用している場合は、警告が表示されます。
- 非推奨のヘルパーを使用している場合は、関連する開発者向けドキュメント(「Guideテンプレートのバージョンについて」)を参照して、ヘルパーをサポートされている同等のヘルパーに置き換えてください。
テーマをもう一度プレビューして、これ以上警告が出ないことを確認します。
- 更新されたテーマをGuideにアップロードします(「テーマやマニフェストファイルをインポートおよびダウンロードする方法」を参照)。
新しいバージョンが適用されたことは、「テンプレートのバージョンを確認する」で説明されている手順で確認できます。
13件のコメント
Dainne Kiara Lucena-Laxamana
Hi 7631589096218 !
Yes we do use HTML. For reference, you can check out these guides: Customizing the page templates with HTML and Curlybars & Customizing the CSS or JavaScript
0
Jack Brown
Hi, silly question but what language is being used for the code? HTML?
0
Mathijs Bok
I have the latest Copemhagen theme and the Dropdown snippet is already placed there. But even with replacing the snippet I still get no dropdown language menu. Also added the CSS rule, but still no result. Anyone has an idea ?
0
Toni Wowtscherk
Thank you Michaela Vlckova! Just copy pasted the JS snippet and replaced it with the dropdown snippet from the template and it works perfectly fine! Awesome!
0
Michaela Vlckova
Hi there, for all that have "dropdown" issues:
it can be fixed by adding whole dropdown section in script.js from original Copenhagen theme + adding a css rules to style dropdown and hide/show them based on aria-expanded attributes:
JS snippet:
(source from https://github.com/zendesk/copenhagen_theme/blob/master/script.js lines 316-482)
0
Dainne Kiara Lucena-Laxamana
Hi Rosa Lopez,
I went ahead & created a ticket on your behalf so we can work on the theme to see why the drop-down doesn't work. Please keep an eye out for our email!
0
Rosa Lopez
Hi, I was wondering if any of you have managed to solve this problem, as I have the same one and I can't get the dropdowns to work.
Thanks.
1
Dion
I suggest that you contact our support team and provide more details about your issue. Please be advised that we do not provide support for custom codes or custom templates as this should be directed to your developers but we will try to see if we can provide some information on your issue.
Regards,
Dion
0
Toni Wowtscherk
Kyle Jones any new leads on that? We faced the same problems and it seems like it's an Java Script issue. But couldn't figure out what exactly it might be.
0
Player Support Team
Kyle Jones hi!
Any updates on this? We are facing the same issue with drop-downs.
Thanks!
0
サインインしてコメントを残してください。