Les variables sont des éléments textuels réutilisables qui vous permettent de définir une valeur une fois et de l’insérer à travers plusieurs articles et pages de catégories. Lorsque la valeur change, vous mettez à jour la variable en un seul endroit et chaque article qui l’utilise se met à jour automatiquement.
Par exemple, si votre email de support apparaît dans 40 articles et change, mettre à jour la variable une fois met à jour instantanément les 40 articles.
Quand utiliser les variables
Utilisez des variables pour le contenu court basé sur du texte qui :
- Apparaît dans plusieurs articles ou pages de catégorie.
- Il est probable que cela évolue avec le temps, comme les coordonnées, numéros de version, noms de produits, URL, étiquettes de champs ou avertissements.
- Il faut rester cohérent dans toute la base de connaissances.
Pour des contenus plus longs ou formatés tels que des paragraphes, tableaux, appels ou images, utilisez plutôt Snippets .
Variables vs. extraits
| Variables | Extraits | |
|---|---|---|
| Type de contenu | Texte brut, chiffres, liens, phrases courtes. | Des blocs formatés tels que paragraphes, tableaux, images, callouts et code. |
| Utilisation typique | Noms de produits, numéros de version, emails de support. | Avertissements, étapes partagées, blocages de contact, avertissements répétés. |
| Limite de caractères | 300 caractères. | Pas de limite de caractères. |
| Prise en main de la mise en forme | Mise en page basique uniquement en ligne. | Mise en forme complète de l’éditeur. |
| Inséré via | Barra d’outils, syntaxe de fusion de code ou commande de barre oblique. | Structure de la barre d’outils ou de fusion de codes. |
Commencez avec les variables
Créer et gérer des variables
Créez une variable et configurez son nom, fusionnez le code, la langue et le contenu. Modifier, supprimer, supprimer en bloc et consulter les dépendances des articles.
En savoir plus →Utilisation et traduction des variables
Insérez des variables dans les articles à l’aide de la barre d’outils, fusionnez la syntaxe du code ou commandez barre oblique. Traduisez les variables pour des bases de connaissances multilingues.
En savoir plus →Meilleures pratiques
- Utilisez des variables pour le contenu qui change, pas pour le contenu qui reste fixe. Les variables sont les plus précieuses lorsque le contenu doit être mis à jour périodiquement. Si une valeur est peu susceptible de changer, l’écrire en ligne est plus simple et plus facile à revoir.
- N’utilisez des variables que lorsque le même contenu apparaît à trois endroits ou plus. Si quelque chose apparaît dans un ou deux articles, mettre à jour ces éléments directement est plus rapide que de créer et de gérer une variable.
- Utilisez des noms descriptifs et spécifiques. Nommez les variables afin que les contributeurs puissent identifier la bonne en un coup d’œil. Par exemple,
SupportEmailouProductVersion_iOSest plus clair queemail1ouv1. Des noms vagues ralentissent l’écriture et entraînent l’insertion d’une mauvaise variable. - Définir intentionnellement le champ d’application du langage. Utilisez Global pour des valeurs identiques dans toutes les langues, comme un nom de produit jamais traduit. Utilisez des variables spécifiques à la langue pour les valeurs qui diffèrent selon la localité, comme un numéro de téléphone régional ou une URL localisée.
- Vérifiez la colonne Utilisé dans avant de modifier ou supprimer. Une modification d’une variable met à jour immédiatement chaque article qui l’utilise, y compris les articles publiés. Avant de faire un changement, examinez les articles affectés afin de vérifier que la valeur mise à jour se lit correctement dans tous les contextes.
- N’utilisez pas de variables dans les extraits. Les variables à l’intérieur des extraits ne s’affichent pas correctement dans l’aperçu de l’éditeur ni dans les exportations PDF. Si un extrait a besoin de valeurs dynamiques, gérez-les séparément.