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 da central de ajuda, consulte Personalização do tema da central de ajuda e a documentação sobre a Templating API (em inglês).
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.
Versão | Data do lançamento | Página de documentação do desenvolvedor |
---|---|---|
1 | 20 de novembro de 2014 | N/D |
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
Você pode ver a versão do modelo ao editar o tema ou visualizar o arquivo de manifesto.
Como verificar a versão dos modelos
- No Administrador do Conhecimento, clique em Painel de personalização (
) na barra lateral.
- No tema que deseja visualizar, clique em Personalizar.
- Clique em Editar código.
- 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
Se você personalizou o tema da sua central de ajuda, pode atualizar para a versão de modelo mais recente para aproveitar os novos recursos, um melhor desempenho e as melhorias de acessibilidade.
Quando você migra de uma experiência de tema, novas restrições são aplicadas aos seus temas. Durante o processo de migração, suspendemos algumas limitações de tipo e de tamanho de arquivo para que você possa migrar seu tema e seus ativos para a nova experiência de tema onde ficará mais fácil trabalhar com eles.
Por exemplo, se você tiver alguns PDFs ou outros arquivos que perderam suporte nos ativos de tema, será possível migrar seu tema. Depois, você poderá exportar o tema para recuperar todos esses arquivos com mais facilidade. No entanto, não será possível duplicar ou reimportar o tema até que os arquivos que perderam suporte sejam removidos dele.
Como atualizar a versão dos modelos
- Baixe o tema da sua central de ajuda. Consulte Download de um tema da central de ajuda.
- Abra o pacote do tema localmente e edite o arquivo manifest.json.
- No arquivo manifest.json, encontre o campo
api_version
e altere o valor para a versão para a qual deseja atualizar. - 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.
- 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.
- 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.