Variables et expressions

Créez des variables réutilisables qui peuvent être référencées dans les pages et les sections

Avec les variables, vous pouvez créer du texte réutilisable qui peut être référencé conditionnellement dans des expressions et des conditions pour du contenu adaptatif.

Si vous répétez plusieurs fois le même nom, la même phrase ou le même numéro de version dans votre contenu, vous pouvez créer une variable pour garder toutes ces occurrences synchronisées et exactes — ce qui est utile si vous devez un jour les mettre à jour, ou si elles sont complexes et souvent mal saisies.

Vous pouvez créer des variables limitées à une seule page, ou à une seule section.

Créer une nouvelle variable

Pour créer une nouvelle variable, cliquez sur la Bibliothèque dans votre table des matières lors de la modification d'une demande de modification. Puis, cliquez sur Variables.

Vous pouvez utiliser le commutateur en haut pour afficher et créer des variables limitées soit à la page actuelle sur laquelle vous vous trouvez, soit à toutes les pages de la section actuelle.

En cliquant sur Créer une variable ouvrira une fenêtre modale où vous pourrez donner à votre variable un nom et une valeur.

Cliquez sur Ajouter la variable pour enregistrer votre variable.

Vous pouvez ajouter des variables à une seule page ou à une section entière. Lorsque vous mettez à jour la valeur d'une variable, chaque occurrence sera mise à jour.

Les noms de variables doivent commencer par une lettre et peuvent contenir des lettres, des chiffres et des tirets bas.

Utiliser des variables dans votre contenu

Les variables peuvent être référencées et utilisées dans une expression — que vous pouvez insérer en ligne dans votre contenu. Après avoir inséré une expression, double-cliquez dessus pour ouvrir l'éditeur d'expression.

Les expressions ne peuvent être utilisées que dans le contenu d'une page d'un document. Elles ne fonctionnent pas dans les titres de page ni dans les métadonnées de page.

Les variables définies sous votre page sont accessibles via l'objet page.vars . De même, les variables définies pour l'ensemble de votre section sont accessibles via l'objet space.vars .

Dans les expressions, les variables à l'échelle de la section se trouvent sous space.vars — l'API GitBook représente les sections sous forme d'objets space .

Vous pouvez ajouter des variables à votre contenu au sein des expressions. L'éditeur d'expressions propose des options d'autocomplétion pour vous aider à trouver la variable dont vous avez besoin.

Mettre à jour une variable

Vous pouvez mettre à jour une variable à tout moment dans le cadre d'une demande de modification. La mise à jour de sa valeur la mettra à jour dans tous les blocs d'expression qui y font référence. La variable modifiée sera publiée sur tout site publié une fois que la demande de modification aura été fusionnée.