Variables

ConceptVariable

Une variable permet d'injecter une chaîne de caractères dans le texte au moment de la publication. Une option permet de définir si sa valeur est statique ou si elle doit pouvoir être modifiée au moment de la publication. Dans ce cas, avant la génération d'un document, le rédacteur choisit de conserver ou de personnaliser la valeur par défaut de chaque variable utilisée dans le document, via un cartouche de paramétrage implémenté sur tous les items de publication.

Truc & astuceAvantages des variables

  • Évitent les ré-écritures (des mêmes termes) et simplifient donc les mises à jour (en cas de changement de ces termes) ;

  • Augmentent la ré-utilisation, entre plusieurs documents, de fragments de contenus dont seuls certains termes doivent différer en publication ;

  • Les variables à valeur statique peuvent être utilisées pour insérer des termes ou des codes métier (pour lesquels une syntaxe ou orthographe doit être respectée) dans le contenu des documents.

  • Les variables dynamiques permettent de publier plusieurs versions d'un même document en les adaptant avant la génération.

ExempleExemples d'usages

  • Nom d'une application ou d'un produit,

  • Numéro d'un modèle ou d'une version,

  • Terme métier,...

ExempleAperçu de l'item

ProcédureUtiliser les variables

Créer l'item Variable
Insérer une variable dans un champ de texte éligible
Rafraîchir et paramétrer la liste des variables sur l'item de publication
Les valeurs choisies sont insérées dans le document généré
Procédure
  1. Créez un item Variable et saisissez son titre de gestion[1] ainsi que sa valeur par défaut.

    RemarqueValeur par défaut

    La valeur par défaut est utilisée pour les publications de relecture mais aussi en publication, si elle n'est pas surchargée dans le cartouche de paramétrage des variables.

    Truc & astuceListe des valeurs possibles

    Vous pouvez saisir une liste de valeurs qui seront proposées comme une liste de choix dans le cartouche de paramétrage des Variables au moment de la publication (si la variable n'est pas statique). Pour afficher cette liste, placez votre curseur avant le premier caractère de la valeur par défaut et/ou commencez votre saisie pour affiner la liste.

    Édition de l'item Variable

    Paramétrage de l'item de publication

    ComplémentAperçu

    Créer l'item Variable
  2. Liez l'item Variable aux endroits souhaités du contenu textuel du document.

    ComplémentComment insérer une variable dans le contenu ?

    Au choix :

    • Cliquez sur le bouton Variable de la barre d'édition lorsque le curseur se trouve dans un bloc de texte éligible puis sélectionnez la Variable cible depuis le menu de sélection.

      Remarque : Si besoin, le menu de sélection d'un item permet de créer un nouvel item Variable :

    • Glissez-déposez l'item Variable de l'explorateur sur le curseur dans le bloc de texte cible.

    → La variable est insérée à l'endroit du curseur.

    ComplémentAperçu

    Insérer une variable dans un champ de texte éligible
  3. Avant de générer un document, rafraîchissez () la liste des variables dans le cartouche de paramétrage de l'item de publication et surchargez les variables pertinentes.

    Truc & astucePour en savoir plus

    ComplémentAperçu

    Rafraîchir et paramétrer la liste des variables sur l'item de publication
  4. Résultat

    Les valeurs choisies sont insérées dans le document généré.

    ComplémentAperçu

    Les valeurs choisies sont insérées dans le document généré

ÉcranCartouche de paramétrage des Variables

Le cartouche de paramétrage des variables est disponible sur tous les items de publication (Publications du Guide, du Site de référence, de Formation).

  1. Rafraîchir
    Rafraîchir

    Cliquez sur Rafraîchir pour lancer l'analyse du document et mettre à jour la liste des variables trouvées dans l'arborescence de l'item.

    ConseilConseil

    Cliquez sur Rafraîchir pour actualiser la liste avant chaque génération.

  2. Liste des variables
    Liste des variables

    Le cartouche de paramétrage liste toutes les Variables « non statiques » trouvées dans l'arborescence d'un item de publication.

  3. Zoom sur une variable
    Zoom sur une variable

    Pour chaque item Variable :

    • La zone de gauche rappelle le Titre de gestion de la variable.

    • La zone de droite permet de modifier la valeur par défaut de la variable pour cette publication et/ou d'accéder à la Liste des valeurs possibles si elle a été paramétrée au niveau de l'item Variable.

      (longueur maximale conseillée : 50 caractères).

    Truc & astuceOuvrir l'item associé

    Double-cliquez sur le nom de l'item pour l'ouvrir.