Au sujet des versions de la création de modèles Guide

La création de modèles Guide assure le rendu des packages de thèmes du Centre d’aide. Cela inclut le langage de création de modèles Curlybars utilisé dans les fichiers de modèle, les fichiers CSS et JS et le fichier de manifeste.

On l’appelle aussi l’API de création de modèles.

Pour en savoir plus au sujet des thèmes Guide, consultez Personnalisation du thème de votre Centre d’aide et la documentation sur les modèles du Centre d’aide destinée aux développeurs.

Cet article aborde les sujets suivants :

• Au sujet des versions de la création de modèles Guide
• Vérification de votre version de la création de modèles
• Mise à niveau de la version 1 de la création de modèles Guide à la version 2

Au sujet des versions de la création de modèles Guide

L’API de création de modèles V2 est sortie le 24 février 2020 et s’applique au thème Copenhagen et à tous les nouveaux thèmes.

Si vous avez personnalisé votre thème, vous pouvez continuer d’utiliser l’API de création de modèles V1 et n’êtes pas obligé de mettre à jour à V2, sauf si vous voulez profiter des nouvelles fonctionnalités et des performances améliorées. Vous pouvez vérifier la version du framework que vous utilisez dans Guide (consultez Vérification de votre version de la création de modèles).

Avec V2, vous ne pouvez plus utiliser de déclarations jQuery dans un thème là où vous pouviez utiliser JavaScript (par exemple script.js ou document_head.hbs). Si vous voulez utiliser jQuery avec V2, vous devez importer la bibliothèque jQuery.

Nous avons aussi abandonné certains assistants et modifié certains autres pour que la sortie soit des objets de données au lieu de HTML. Vous trouverez la liste complète ici.

Vérification de votre version de la création de modèles

Vous pouvez voir votre version de la création de modèles à partir de la vue Modifier le code de votre thème ou dans le fichier de manifeste.

Pour vérifier la version de la création de modèles

1. Dans Guide, cliquez sur l’icône du panneau de personnalisation () dans la barre latérale.
2. Cliquez sur Personnaliser sur le thème que vous voulez afficher.
3. Cliquez sur Modifier le code.
4. Sous le nom du thème, vous voyez le numéro de version de la création de modèles, par exemple API de création de modèles v2.

   

   Le numéro de version correspond au champ api_version dans le fichier de manifeste.

Mise à niveau de la version 1 de la création de modèles Guide à la version 2

Si vous avez personnalisé votre thème Guide, vous pouvez mettre à niveau et passer à la version 2 pour profiter des nouvelles fonctionnalités et des performances améliorées.

Pour mettre la version de la création de modèles à niveau

1. Téléchargez votre thème du Centre d’aide (consultez Téléchargement d’un thème de votre Centre d’aide).
2. Ouvrez le package du thème en local et modifiez le fichier manifest.json.
3. Dans le fichier manifest.json, cherchez le champ api_version et remplacez sa valeur par 2.
4. Affichez l’aperçu de votre thème en local. Quand vous affichez l’aperçu de votre thème, vous verrez des avertissements si vous utilisez des assistants qui ont été abandonnés dans la version 2.
5. Si vous utilisez un assistant abandonné, ces informations vous expliquent comment le remplacer par un équivalent pris en charge.

   Affichez à nouveau l’aperçu de votre thème pour vous assurer qu’aucun avertissement ne s’affiche.

6. Chargez le thème mis à jour dans Guide (consultez Importation de votre thème du Centre d’aide).

   Vous pouvez vérifier que la nouvelle version a été appliquée en vérifiant votre version de la création de modèles.