La création de modèles Guide permet d’assurer 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èles, les fichiers CSS et JS et le fichier de manifeste.
On utilise aussi le nom API de création de modèles.
Pour en savoir plus sur les thèmes Guide, consultez Personnalisation du thème de votre centre d’aide et la section sur les modèles du centre d’aide dans la documentation destinée aux développeurs.
Au sujet des versions de la création de modèles Guide
Le tableau suivant répertorie les versions de la création de modèles, avec leur date de sortie et des liens vers la page de la documentation destinée aux développeurs correspondante à laquelle vous trouverez des informations spécifiques sur ce qu’inclut chaque version.
Pour savoir quelle version vous utilisez, consultez Vérification de votre version de la création de modèles.
| Version | Date de sortie | Page de la documentation pour les développeurs |
|---|---|---|
| 1 | 20 novembre 2014 | S.O. |
| 2 | 24 février 2020 | Mise à niveau de l’API de création de modèles v1 |
| 3 | 1er juin 2023 | Mise à niveau de l’API de création de modèles v2 |
| 4 | 2 juillet 2024 | Mise à niveau de l’API de création de modèles v3 |
Vérification de votre version de la création de modèles
Pour savoir quelle version de création de modèles vous utilisez, allez à la vue Modifier le code de votre thème ou consultez le fichier de manifeste.
Pour vérifier la version de création de modèles
- Dans Guide, cliquez sur l’icône du panneau de personnalisation (
) dans la barre latérale. - Cliquez sur Personnaliser sur le thème que vous voulez consulter.
- Cliquez sur Modifier le code.
- Sous le nom du thème, vous verrez le numéro de la version de création de modèles, p. ex. API de création de modèles v2.
Ce numéro de version correspond au champ
api_versiondans le fichier de manifeste.
Mise à niveau de votre version de la création de modèles Guide
Si vous avez personnalisé votre thème Guide, vous pouvez mettre à niveau et passer à la dernière version de la création de modèles pour profiter des nouvelles fonctionnalités, de meilleures performances et d’une accessibilité améliorée.
Pour mettre la version de création de modèles à niveau
- Téléchargez votre thème du centre d’aide (consultez Téléchargement d’un thème de votre centre d’aide).
- Ouvrez le package du thème en local et modifiez le fichier manifest.json.
- Dans le fichier manifest.json, cherchez le champ
api_versionet remplacez la valeur par celle de la version à laquelle vous voulez passer. - Consultez l’aperçu des modifications 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 à laquelle vous avez choisi de passer.
- Si vous utilisez un assistant abandonné, référez-vous à la documentation destinée aux développeurs correspondante (consultez Au sujet des versions de la création de modèles Guide) pour savoir comment remplacer l’assistant par un équivalent pris en charge.
Affichez à nouveau l’aperçu de votre thème pour vous assurer qu’il n’y a pas d’autres avertissements.
- Chargez le thème mis à jour dans Guide (consultez Importation d’un thème de votre centre d’aide).
Vous pouvez vous assurer que la nouvelle version a bien été appliquée en vérifiant votre version de la création de modèles.