Gérer un fichier Artidoc

La configuration d’un Artidoc

En haut de votre document, vous retrouverez plusieurs fonctionnalités pour organiser votre rédaction :

• Mettre le texte en gras, en italique.

• Faire des listes à puces,  numérotées.

• Ajouter/supprimer un lien.

• Ajouter une image.

• Etc…

Vous retrouverez également sur la droite la table des matières qui se remplira automatiquement lors de la rédaction de votre document. Lorsqu’elle est assez longue, il vous suffit de cliquer sur un titre de section afin que Tuleap vous redirige directement à cette section.

Grâce au trois petits points en haut vous avez également la possibilité d’ouvrir votre artidoc en plein écran ainsi que de le configurer plus

L’onglet “Sélection du tracker” vous permet de changer le tracker sur lequel est basé votre artidoc mais sans supprimer les artifact créés depuis le document. Vous gardez toute votre rédaction basée sur le tracker précédent.

L’onglet “Sélection des champs” s’active lorsque vous avez au moins un artifact créé dans votre document artidoc. Cet onglet vous permet de choisir quels sont les champs que vous souhaitez faire apparaître dans votre artidoc.

Les champs sélectionnés dans cet exemple ressortent bien dans mon artidoc sous mon premier bug. Ils se mettent automatiquement à jour dans votre artidoc s’ils sont changés directement dans le tracker.

L’onglet “Fonctionnalités expérimentales” vous permet de participer à l’amélioration d’Artidoc en testant l’affichage des versions et en faisant des retours aux équipes de Tuleap. Il vous suffit de cliquer sur le bouton afin d’activer la fonctionnalité.

Information

Les données affichées seront fictives tant que la fonctionnalité n’aura pas été totalement terminée par nos équipes.

La rédaction dans Artidoc

Avec le petit “+” vous pouvez commencer à intégrer des éléments dans votre document :

• Du texte libre : ceci vous permet ma rédaction de tout texte relié à aucun élément, ni aucun artifact.

• Créer un “nom du tracker sur lequel est basé l’artidoc” : ceci vous permet de créer un artifact (dans cet exemple un bug) directement depuis votre document artidoc. Vous retrouverez cet artifact ainsi que tous ses éléments dans le tracker dédié.

• Importer un “nom du tracker sur lequel est basé l’artidoc” : ceci vous permet d’importer un artifact déjà existant dans le tracker sur lequel est basé votre artidoc afin de l’intégrer à la documentation.

Rédaction de texte libre dans Artidoc

Création d’un artifact depuis Artidoc

Importation d’un artifact dans Artidoc

Dans chaque artifact de votre document, qu’il soit créé depuis le fichier ou importé, il est possible d'accéder directement à ses informations depuis votre document Artidoc.