Les références dans Tuleap
Les références permettent de créer automatiquement des liens entre différents éléments de Tuleap à partir d’un simple texte.
Concrètement, lorsqu’un utilisateur écrit une référence dans un commentaire, un champ texte, une page Wiki ou un message de commit, Tuleap peut reconnaître cette référence et la transformer automatiquement en lien cliquable vers l’élément concerné.
Une référence repose généralement sur un mot-clé, suivi d’un identifiant. Cela permet de relier facilement des informations entre elles, sans avoir à copier manuellement des liens.
Les références peuvent aussi être utilisées pour pointer vers un élément situé dans un autre projet, à condition que l’utilisateur dispose des permissions nécessaires pour y accéder. Si l’utilisateur n’a pas les droits de consultation sur l’élément référencé, celui-ci ne lui sera pas présenté.
Il existe deux types de références dans Tuleap : les références système et les références projet.
Les références système sont définies au niveau de la plateforme. Elles sont communes à tous les projets et sont souvent liées à un service Tuleap, comme les trackers, les documents, les fichiers ou le Wiki. Elles ne peuvent pas être modifiées directement, mais elles peuvent être activées ou désactivées.
Les références projet, elles, sont propres à un projet. Elles peuvent être créées, modifiées ou supprimées par les administrateurs du projet afin de répondre aux besoins spécifiques de leur équipe ou de leur organisation.
Si vous souhaitez plus d’informations sur les références des artifacts spécifiquement, consultez cet article.
Créer des références systèmes
Pour accéder aux références systèmes depuis l’administration de la plateforme, cliquez sur “Références de projets prédéfinis” dans le menu latéral, cela vous enverra directement à la gestion des références système.
Pour créer ou modifier une référence système, l’administrateur plateforme doit renseigner plusieurs informations :
Le mot-clé de la référence permet à Tuleap de reconnaître le texte à transformer automatiquement en lien. Il doit être court et explicite, afin que les utilisateurs comprennent facilement à quoi correspond la référence.
La description permet d’expliquer brièvement l’objectif de la référence. Elle s’affiche lorsque l’utilisateur passe sa souris sur une référence reconnue.
La nature correspond au type d’objet que la référence va désigner dans Tuleap (artifact, Build Jenkins, Commit, Ficher, etc..). C’est une sorte de catégorie qui permet à Tuleap de savoir quel type d’élément est concerné par la référence.
Le lien de la référence correspond à l’adresse vers laquelle l’utilisateur sera redirigé lorsqu’il clique sur la référence. C’est donc la destination concrète du lien. Ce lien peut pointer vers une page Tuleap, mais aussi vers une page externe. Cela permet, par exemple, de créer des références vers un autre outil utilisé par l’organisation.
Il est également possible d’utiliser des variables dans le lien. Ces variables sont automatiquement remplacées par les informations contenues dans la référence, comme le nom court du projet, l’identifiant du projet ou les paramètres saisis par l’utilisateur. Cela permet de créer des liens dynamiques, adaptés au texte reconnu par Tuleap.
