Macro-variables
Les rédacteurs de documentation sont souvent confrontés au besoin de réutiliser un morceau de texte plusieurs fois. Dans de tels cas, ils recourent souvent à des solutions évidentes, Ctrl + C et Ctrl + V, ou ressaisissent les informations nécessaires à chaque fois.
Pour éviter une certaine monotonie dans le processus de rédaction de la documentation, Dr.Explain a une fonctionnalité qui augmentera considérablement votre productivité, à savoir les macro-variables de texte. Elles sont utiles si vous utilisez fréquemment les mêmes morceaux de texte dans votre manuel, tels que le nom de l'entreprise, le nom du produit, les coordonnées, etc. Les variables sont particulièrement utiles lorsque vous devez écrire plusieurs fois un même texte qui change périodiquement, par exemple la version du programme documenté.
Fonctionnement des macro-variables
Supposons que vous devrez écrire plusieurs fois la version du programme ou l'adresse e-mail dans le manuel. Au lieu de les écrire à chaque fois, définissez une variable. Ainsi, la prochaine fois vous n'aurez pas à taper le texte, mais juste à sélectionner la variable avec la valeur appropriée.
Si vous devez modifier le numéro de version ou l'adresse e-mail de contact dans l'ensemble du projet, mettez simplement à jour la valeur de la variable dans les paramètres du projet. Dr.Explain apportera automatiquement des modifications à toutes les pages contenant cette variable dans le texte.
Pour ajouter des variables à votre projet, cliquez sur l'icône dans la section Objets spéciaux ou ouvrez la section Variables dans les paramètres du projet. Ensuite, nommez la variable et définissez-lui une valeur.
Ainsi, lorsque vous travaillerez sur le projet, les noms des variables seront visibles dans l'éditeur, et leurs valeurs réelles seront substituées dans le fichier exporté.