---
title: "Références"
slug: "documentation-references"
tags: ["Liens Automatiques", "Références Tuleap", "Traçabilité Documents"]
updated: 2026-03-17T11:10:35Z
published: 2026-03-17T11:10:35Z
canonical: "help.tuleap.com/documentation-references"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.tuleap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Références

Les références sont un outil puissant qui permet de créer des liens entre les objets Tuleap. À partir d'un modèle de texte, Tuleap crée automatiquement des hyperliens vers l'objet souhaité.

### Qu’est‑ce qu’une référence dans Tuleap ?

Dans Tuleap, une référence est un moyen de **créer des liens automatiques** **entre différents objets** (artifacts, documents, commits, pages wiki, etc.) directement à partir d’un texte. Cela facilite la **traçabilité** et la **navigation entre éléments liés**. Lors de la saisie d'un **commentaire de suivi** ou d'un **message de commit**, tout texte contenant le modèle `XXX #NNN` sera interprété comme une référence à l'objet de type `XXX` avec le numéro d'identification `NNN`

Par exemple, `artifact #123` est reconnu comme une référence à un `artifact` numéro `123` , **Tuleap crée donc automatiquement un** **hyperlien** qui pointe directement vers les détails de **l'artifact 123**.

Il est également possible de faire référence à un objet appartenant à **un autre projet**. Dans ce cas, il faudra utiliser `XXX#project_id:NNN` ou `XXX #project_name:NNN` pour faire référence à l'objet `XXX` numéro `NNN` appartenant au projet dont l'ID est `project_id` ou dont le nom court est `project_name`

Par exemple, `doc #myproj:567` est une référence au document `567` du projet `myproj`.

Certains modèles de référence peuvent nécessiter plusieurs paramètres. Dans ce cas, utiliser `/` comme séparateur entre les paramètres. Par exemple, `git #a_repo/6eef1d01` crée une référence au commit Git `6eef1d01` dans le dépôt `a_repo`.

Les plateformes et les projets peuvent définir [leurs propres références](https://docs.tuleap.com/user-guide/project-admin.html#reference-overview) (défini par les administrateurs de projet).

**Une référence documentaire correspond à :**

- Un lien vers un document stocké dans Tuleap.
- Une mention explicite d’un document dans un artifact ou une description.
- Un rattachement logique entre un document et un élément du projet.

**Les références permettent :**

- D’éviter la duplication des fichiers.
- De garantir une source unique de vérité.
- De faciliter l’accès à l’information.

### Où trouver les références dans Tuleap ?

**Dans le MediaWiki du projet**

Le wiki est la zone principale pour :

- Rédiger la documentation.
- Structurer les contenus thématiques.
- Lier des pages entre elles.

Chaque page peut inclure des références internes ou externes.

**Dans les documents**

La zone Documents permet de :

- Stocker des fichiers PDF, Word, Excel, images, etc.
- Maintenir une arborescence structurée de documents.

Les références peuvent être :

- Insérées dans les fichiers eux-mêmes.
- Ajoutées via commentaires ou métadonnées.

**Dans les tâches, stories et artifacts**

Dans les tickets ou artifacts on utilise des références croisées (liens vers wiki ou autre élément Tuleap) pour expliquer, documenter ou préciser un besoin.

### Les types de références

| **Type** | **Utilisation** | **Exemple** |
| --- | --- | --- |
| **Référence interne** | Lien vers une page wiki ou un artifact | [[User%20Guide]] |
| **Référence externe** | Lien vers une ressource externe | [Documentation officielle de Git]([https://git-scm.com/doc](https://git-scm.com/doc)) |
| **Référence de document joint** | Lien vers un fichier dans « Documents » | Documents/Specs/Architecture.pdf |

### Comment ajouter une référence

**Dans le MediaWiki du projet**

1. On ouvre la page Wiki à modifier.
2. On ajoute une référence puis on enregistre.

```plaintext
[[NomDeLaPage]]
        ou
        [Texte du lien](URL)
```

**Dans un ticket / artifact**

Dans la zone de description du commentaire on insère le lien, puis on enregistre.

```plaintext
Voir la documentation : [[PageWiki]]
```

### Conseils

- Utiliser des noms **clairs et cohérents** : Guide_Utilisateur_Tuleap, Processus_Dev.
- **Vérifier régulièrement** que les liens ne sont pas cassés.
- **Mettre à jour** les contenus obsolètes après les réunions d’équipe.

Une référence est un lien court (par exemple : bug #123, task #123) formé par un mot clé et un identifiant précédé du caractère '#'. Chaque artefact a un identifiant unique et possède une référence propre qui peut être utilisé dans l'ensemble de la plateforme Tuleap pour créer un lien vers cet élément

## Related

- [La gestion des artifacts](/la-gestion-des-artifacts.md)