15. Gestionnaire de Documents

La documentation est probablement le délivrable le plus important d’un projet après le logiciel lui-même. Tuleap propose un service spécifique pour la gestion de la documentation.

Bien que le gestionnaire de documents de Tuleap ne soit pas comparable à un système de gestion documentaire dédié, il est cependant extrêmement pratique pour gérer les documents critiques pour votre communauté d’utilisateurs. Quelques exemples : manuel d’installation, d’administration ou d’utilisation, documentation des API, Foire aux Questions, etc…

Les fonctionnalités du gestionnaire de documents sont les suivantes :

  • Le gestionnaire peut gérer n’importe quel type de document.
  • Les documents sont stockés dans des dossiers. Vous pouvez avoir des sous-dossiers dans un dossier.
  • Les documents peuvent être édités en ligne (si ils sont embarqués au format text ou html).
  • Les règles de droits d’accès peuvent être définies pour chaque dossier ou document.
  • Les documents possèdent des propriétés.

15.1. Structure

Vous pouvez structurer comme vous voulez votre gestionnaire de document en créant des dossiers et sous-dossiers pour classer vos documents.

Dossiers et sous-dossiers

15.2. Actions

Le gestionnaire de document permet certaines actions sur les dossiers ou documents. Ces action sont disponible ou pas suivant les permissions. Pour afficher le paneau des actions, il vous suffit de cliquer sur l’icône en forme de crayon à côté du titre de l’élément.

Actions

Nous allons maintenant décrire toutes les actions qui peuvent être effectuées :

15.2.1. Nouveau Document

Cette action est seulement disponible pour les dossiers et permet à l’utilisateur de créer un nouveau document. Quand vous selectionnez cette action, une fenêtre « Nouveau document » est affichée, où vous pouvez entrer les informations concernant le nouveau document.

Créer un nouveau document

Le nouveau document hérite des permissions du dossier parent.

15.2.1.1. Propriétés

Le titre du document est obligatoire. L’utilisateur peut fournir une description. En fonction du projet, il peut y avoir des propriétés supplémentaires requise pour définir le document.

15.2.1.2. Type de document

5 types de documents sont disponibles :

  • Vide: le document ne sera pas typé. L’utilisateur pourra choisir le type définitif après la création.
  • Lien: autorise l’utilisateur à pointer un document avec une URL. Le document ne sera pas stocké localement dans le manager.
  • Wiki: le document peut être créé avec le service wiki.Entrez juste le nom correspondant à la nouvelle page wiki. Vous pouvez également utiliser une page wiki existante.
  • Fichier: n’importe quel type de documents peut être chargé. Depuis une présentation PowerPoint à une simple image ou un document office. Les fichiers sont versionnés ainsi vous pouvez ajouter de nouvelles versions sur les documents existants.
  • Fichier embarqués: les documents de type texte ou html peuvent être édités en ligne et sont versionnés.

15.2.1.3. Chemin

Par défaut, le sytème crée un document dans le dossier qui a été sélectionné. L’utilisateur peut aussi choisir un autre dossier. Il peut également sélectionner la position du nouveau document dans le dossier : au début ou à la fin.

15.2.2. Nouveau Dossier

Cette action est seulement disponible pour les dossiers et permet à l’utilisateur de créer un sous-dossier.

Créer un nouveau dossier

Le nouveau dossier hérite des permissions du dossier parent.

15.2.2.1. Propriétés

Comme pour les documents, le titre des dossier est obligatoire. L’utilisateur peut fournir une description. Selon les projets, il peut y avoir des propriétés supplémentaires requises pour définir les dossiers.

15.2.2.2. Chemin

Comme pour les documents, par défaut, le système crée un dossier dans le dossier qui a été sélectionné. L’utilisateur peut aussi choisir un autre dossier. Il peut également sélectionner la position du nouveau dossier : au début ou à la fin.

15.2.3. Propriétés

Cette action permet à l’utilisateur de voir les propriétés d’un document ou d’un dossier, si il en a les droits. Si il a les permissions requises, il sera capable de modifier ces propriétés.

Afficher et editer les propriétés

Depuis le paneau des propriétés, il est possible de voir/éditer les permissions, voir l’historique et d’accèder aux actions (mise à jour/déplacement/suppression).

15.2.4. Notifications

Cette action permet à l’utilisateur de s’abonner à toute modification d’un élément. Ainsi il pourra être prévenu de l’ajout d’un document dans un dossier, de la modification d’un document, de son déplacement, … Il suffit de cocher la case prévue à cet effet.

Notifications

15.2.5. Historique

Cette action permet à l’utilisateur de voir les journaux et les anciennes versions (si disponibles).

Historique

15.2.6. Mise à jour

Cette action permet à l’utilisateur de mettre à jour le nom d’une page wiki ou l’url d’un lien.

Mise à jour d'un lien

15.2.7. Nouvelle version

Cette action permet à l’utilisateur de mettre à jour un document de type fichier ou fichier embarqué.

Créer une nouvelle version d'un fichier embarqué

15.2.8. Permissions

Cette action permet à l’utilisateur de gérer les permissions d’un document ou d’un dossier. Les permissions d’un dossier peuvent être appliquées recursivement à sa sous-hiérarchie.

Definir les permissions

Il y a 3 types de permission.

15.2.8.1. Lecteurs

Ceux qui peuvent lire un document ou accèder au contenu d’un dossier.

« lecture » signifie accès au document/dossier, voir ses propriétés, voir son historique.

Merci de noter que si un utilisateur ne peut pas lire un dossier alors il ne pourra pas accèder à tout les éléments en dessous de lui, quelques soient leurs permissions.

15.2.8.2. Rédacteurs

Les Rédacteurs sont des lecteurs qui peuvent modifier un document ou créer un sous-élément dans un dossier.

« Modifier » signifie mettre à jour/ajouter une nouvelle version, modifier un lien ou le nom d’un page wiki, modifier les propriétés, déplacer un élément ou le supprimer.

15.2.8.3. Gestionnaires

Les gestionnaires sont des rédacteurs qui peuvent aussi définir les permissions d’un document ou d’un dossier. Ils peuvent aussi consulter les historique d’accès à un document.

15.2.9. Déplacer

Les documents ou les dossiers peuvent être déplacés au sein des documents du projet.

L’utilisateur ne peut déplacer un élément que si les dossiers source et destination sont modifiables.

Vous pouvez déplacer un item de différentes façons.

La façon usuelle est de selectionner « déplacer » dans le menu popup d’un élément. Vous aurez alors à choisir un dossier de destination (ou éventuellement le laisser au même endroit) et la nouvelle position (au début, à la fin ou à une position spécifique). Les permissions de l’élément ne seront pas changées.

Déplacer un document

Si vous ne voulez que réordonner le contenu d’un dossier, vous pouvez cliquer sur les raccourcis à coté de « déplacer » dans le menu popup : décaler d’une place vers le haut, d’une place vers le bas, placer au début du dossier ou à la fin.

Raccourcis pour déplacer un élément au sein d'un dossier

15.2.10. Delete

Les documents ou dossiers peuvent être supprimés. Si un utilisateur veut supprimer un dossier, il sera averti que tous les sous-éléments seront supprimés (si il a les permissions ad-hoc).

Pour pouvoir supprimer un élément, l’utilisateur doit avoir le droit « rédacteur » sur le répertoir parent.

15.3. Administration

15.3.1. Permissions

Cette section définie qui peut administrer le gestionnaire de documents.

Les administrateurs du gestionnaire de documents ont tous les droits sur tous les éléments du gestionnaires.

15.3.2. Afficher les permissions

Cette section permet de définir la vue par défaut du gestionnaire de documents. Ce paramètre peut être surchargé par les préférences de l’utilisateur.

15.3.3. Propriétés

Cette section gère les propriétés des documents. Chaque propriété peut être valuée lors de la soumission ou de l’édition d’un document.

Il n’y a pas de permissions spécifiques aux propriétés. Si un utilisateur peut lire(modifier) un document, il peut également lire(modifier) chacune de ses propriétés.