Sobre as versões de modelos do Guide

Os modelos do Guide renderizam os pacotes de temas da Central de Ajuda. Eles contêm a linguagem de modelos Curlybars que é usada em arquivos de modelo, arquivos CSS e JS e no arquivo de manifesto.

Os modelos do Guide também são conhecidos como a Templating API.

Para saber mais sobre os temas do Guide, consulte Personalização do tema da Central de Ajuda e a documentação do desenvolvedor Help Center Templates.

Este artigo abrange os seguintes tópicos:

• Sobre as versões de modelos do Guide
• Verificação da versão de modelos
• Atualização da versão 1 de modelos do Guide para a versão 2

Sobre as versões de modelos do Guide

A Templating API v2 foi lançada em 24 de fevereiro de 2020 e essa versão se aplica ao tema Copenhagen e a todos os lançamentos de temas.

Se você personalizou seu tema, pode continuar usando a Templating API v1 e não precisa atualizar para a v2, a menos que você queria desfrutar dos novos recursos e do desempenho aprimorado que a v2 oferece. É possível verificar qual versão da estrutura que você está usando no Guide (consulte Verificação da versão de modelos).

Na v2, você não precisa mais usar instruções jQuery em um tema onde você poderia usar o Vanilla JavaScript (como script.js ou document_head.hbs). Para usar o jQuery na v2, você precisa importar a biblioteca do jQuery.

Inclusive, descontinuamos alguns auxiliares e alteramos alguns deles para gerar a saída de objetos de dados em vez de HTML. Consulte a lista completa aqui.

Verificação da versão de modelos

Você pode ver a versão de modelos na visualização Editar código em seu tema ou no arquivo de manifesto.

Como verificar a versão de modelos

1. No Guide, clique no ícone Painel de personalização () na barra lateral.
2. No tema que deseja visualizar, clique em Personalizar.
3. Clique em Editar código.
4. Sob o nome do tema, verá o número da versão de modelos, por exemplo, Templating API v2.

   

   Esse número de versão corresponde ao campo api_version no arquivo de manifesto.

Atualização da versão 1 de modelos do Guide para a versão 2

Se você personalizou seu tema do Guide, você pode atualizar para a versão 2 para aproveitar os novos recursos e o desempenho aprimorado.

Como atualizar a versão de modelos

1. Baixe seu tema da Central de Ajuda (consulte Download de um tema da Central de Ajuda).
2. Abra o pacote de temas localmente e edite o arquivo manifest.json.
3. No arquivo manifest.json, encontre o campo api_version e altere o valor para 2.
4. Visualize as alterações de seu tema localmente. Quando você visualiza o tema, você recebe avisos se estiver usando auxiliares que foram descontinuados na versão 2.
5. Se você estiver usando um auxiliar descontinuado, use estas informações para substituir o auxiliar por um equivalente com suporte.

   Visualize seu tema novamente para verificar se há mais avisos.

6. Importe seu tema atualizado para o Guide (consulte Importação de um tema da Central de Ajuda).

   É possível verificar se a nova versão foi aplicada ao fazer a Verificação da versão de modelos.