Sobre as versões de modelos do Guide

Qual é o meu plano?

Os modelos do Guide renderizam os pacotes de tema da central de ajuda. Eles contêm a linguagem de modelos Curlybars que é usada nos 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 de desenvolvedor sobre modelos da central de ajuda.

Este artigo abrange os seguintes tópicos:

• Sobre as versões de modelos do Guide
• Verificação da versão dos seus modelos
• Atualização da versão dos seus modelos do Guide

Sobre as versões de modelos do Guide

A tabela a seguir indica as versões de modelos do Guide, as datas de lançamento e os links para a página de documentação de desenvolvedor relacionada em que você encontra informações específicas sobre o que está disponível em cada versão.

Para verificar qual versão você está usando, consulte Verificação da versão dos seus modelos.

Tabela 1.

Versão	Data do lançamento	Página de documentação do desenvolvedor
1	20 de novembro de 2014	Indisponível
2	24 de fevereiro de 2020	Atualização da Templating API v1
3	1º de junho de 2023	Atualização da Templating API v2
4	2 de julho de 2024	Atualização da Templating API v3

Verificação da versão dos seus modelos

É possível verificar a versão dos modelos na visualização Editar código no seu tema ou no arquivo de manifesto.

Como verificar a versão dos 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, você verá o número de versão do modelo, 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 dos seus modelos do Guide

Se você personalizou seu tema do Guide, pode atualizar para a versão de modelo mais recente para aproveitar os novos recursos, um melhor desempenho e as melhorias de acessibilidade.

Como atualizar a versão dos modelos

1. Baixe o tema da sua central de ajuda. Consulte Download de um tema da central de ajuda.
2. Abra o pacote do tema localmente e edite o arquivo manifest.json.
3. No arquivo manifest.json, encontre o campo api_version e altere o valor para a versão para a qual deseja atualizar.
4. Visualize as alterações do tema localmente. Quando você visualiza o tema, recebe avisos de que está usando auxiliares que foram preteridos na versão para a qual está atualizando.
5. Se você está usando um auxiliar preterido, confira a documentação do desenvolvedor relacionada (consulte Sobre as versões de modelos do Guide) para substituir o auxiliar por um equivalente compatível.

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

6. Carregue o tema atualizado no Guide (consulte Importação do tema da sua central de ajuda).

   Você pode conferir se a nova versão foi aplicada verificando a versão dos seus modelos.