文档 API参考

从template API v1升级

从template API v1升级

template API的第2版专注于为构建更高性能、更易于访问的指南帮助中心提供更好的基础。

了解如何检查您的主题正在使用的版本以及如何升级关于向导模板在指南帮助。

本页列出了从template API v1到template API v2的变化。

更新的助手

{{request_form}}

这个表单现在将呈现(可选)在可选字段旁边，而不是＊在必需字段旁边，以提高可访问性。

{{订阅}}

此帮助器已经过改进以提高可访问性。该组件现在是一个切换按钮，不再刷新页面，也不会为用户创建通知。

此帮助器已经过改进以提高可访问性。

{{recent_articles}}

此帮助器已经过改进以提高可访问性。

{{行动}}

此帮助器已经过改进以提高可访问性。

{{分享}}

此帮助器已经过改进以提高可访问性。

{{recent_activities}}

这个帮助器已经改进了可访问性，现在在评论计数旁边呈现一个评论气泡svg。

{{分页}}

此帮助器已更新为排除页码，以便为基于游标的分页集合做准备。

{{资产}}

如果您的主题在2018年迁移到新的自定义设计体验，您可能已经使用了{{资产"name" cdn="legacy"}}在你的主题里。这将呈现一个指向前一个资产CDN的链接，以实现向后兼容性。的cdn属性不再受支持，将被忽略。

删除了对象属性/助手

{{logo_url}}

2017年推出的新自定义设计体验提供了主题设置设置对象，包括帮助中心的徽标。使用{{settings.logo}}作为对{{logo_url}}。

{{聊天}}

此帮助器以前已弃用(呈现空字符串)，现在已被删除。

此帮助器以前已弃用(呈现空字符串)，现在已被删除。

{{chat_about_my_ticket}}

此帮助器以前已弃用(呈现空字符串)，现在已被删除。

{{section.internal}}

此属性以前已被弃用(总是返回false)，现在已被删除。

{{category_tree_with_article}}

这个助手将输出HTML标记。方法重新构建此标记类别对象。

{{section_tree_with_article}}

这个助手将输出HTML标记。方法重新构建此标记部分对象。

{{article_results}}

在搜索结果页面中使用的这个集合已经被删除，取而代之的是统一的结果集合。有关如何升级搜索页面的更多详细信息，请参阅帮助中心模板烹饪书在指南帮助。

{{post_results}}

在搜索结果页面中使用的这个集合已经被删除，取而代之的是统一的结果集合。有关如何升级搜索页面的更多详细信息，请参阅帮助中心模板烹饪书在指南帮助。

{{filter_by}}

此属性在用户配置文件页中不再可用。你可以用{{current_filter.identifier}}。

{{user_info}}

这个帮助器在头模板中不再可用。现在可以使用以下帮助程序来构建相应的菜单:{{user_avatar}}，{{user_name}}，{{my_profile}}，{{change_password}}。您可以在哥本哈根主题中找到重新实现的下拉列表的示例头模板

{{退订}}

此helper在订阅对象中不再可用。的{{订阅}}Helper现在还允许在内容已经订阅时取消订阅。的{{后}}属性输出所遵循的内容类型。

性能改进和删除的库

主题的script.js文件现在在页面主体的末尾加载，以提高页面性能。此外，本节中列出的库不再出现在template API v2中。如果您需要一个或多个这些库来定制您的主题，您仍然可以将它们添加为主题资产。看到使用您自己的帮助中心主题资产在指南帮助。

jQuery

jQuery不再像以前那样无处不在，所以不再默认包含它。哥本哈根主题现在是用普通的Javascript构建的。

如果您的主题仍然需要jQuery，您可以在文档头模板中导入它。您可以将它作为资源添加到主题中，也可以从外部源加载它。更多信息见导入或升级jQuery。

模板API v1使用jQuery 1.9.1版本。此版本不再受支持，您应该考虑升级。可以找到多个版本的jQueryhttps://cdnjs.com/libraries/jquery/。

如果您以前使用jQuery来发出Zendesk API请求，这些请求需要一个真实性令牌(亚博也称为CSRF令牌)，那么您现在需要将令牌作为JavaScript代码的一部分获取。

例子:

             

              
美元。ajax（{url：“/ api / v2 /用户/我”，数据类型：“json”}）。完成（函数（数据）{authenticityToken=数据。用户。authenticity_token；//你的请求到这里美元。ajax（{url：“/ api / v2 /请求”，方法：“职位”，数据类型：“json”，头：{“X-CSRF-Token”：authenticityToken}，数据：{“请求”：{“主题”：“救命!”，“评论”：{“身体”：“我的打印机着火了!”}}}}）。完成（函数（数据）{控制台。日志（数据）}）}）；

moment.js

虽然moment.js并不是一个文档化的API，但它在窗口对象中是可用的，并且被主题开发人员使用。

这在template API v2中不再可能了。如果需要，可以考虑在主题中导入它。

模板API v1使用的是moment.js 2.4.0版本。

normalize.css

CSS是一个小型的CSS库，它在HTML元素的默认样式中提供了跨浏览器的一致性。

这在template API v2中不再可用。如果需要，可以考虑在主题中导入它。

模板API v1使用的是normalize.css 3.0.0版本。

entypo

Entypo是一个流行的图标字体库，默认包含在哥本哈根主题中。

主题被迁移为使用内联svg，以获得更好的页面加载性能和改进的可访问性。

帮助中心将下拉功能注入到主题中。这个功能现在是通过哥本哈根主题实现的风格和脚本文件。

其他的更新

  • 帮助中心特定于移动设备的布局，最初在2017年弃用，已在template API v2中删除。

如果您的用户从移动设备访问帮助中心，请考虑更新您的主题，使其具有响应式布局。

  • 改进的模板验证-不能在条件表达式中使用帮助程序