# Documentation

## Administration

### Projets

Ces écrans vous permettent de gérer les projets.

#### Liste des projets

Sur cet écran, vous pouvez archiver ou supprimer un projet.

Un projet archivé est conservé mais n'est plus visible, y compris par ses membres. Il peut être restauré par l'administrateur.

#### Création ou modification d'un projet

##### Propriétés du projet

- Public: si le projet est public, il sera visible par tous les utilisateurs, y compris ceux qui ne sont pas membres du projet. Si le projet n'est pas public, seuls les membres du projet y ont accès, en fonction de leur rôle.

- Sous-projet de: permet de définir le projet parent. La hiérarchie des projets est limitée à 2 niveaux. Un projet parent ne peut pas être lui-même un sous-projet.

- Nom: nom d'affichage du projet (doit être unique)

- Description: texte qui apparaît sur l'écran d'aperçu du projet

- Identifiant: nom du projet utilisé de manière interne par l'application (doit être unique). Une fois le projet créé, cet identifiant ne peut pas être modifié.

- Champs personnalisés: sélectionner les champs personnalisés que vous souhaitez utiliser pour les demandes du projet. Seul l'administrateur peut définir de nouveaux champs personnalisés.

##### Dépôt

Un dépôt de sources peut être associé à chaque projet. Une fois le dépôt du projet configuré, vous pourrez le parcourir et consulter les révisions. Les révisions du dépôt apparaissent dans la vue Activité du projet.

Pour associer un dépôt au projet, cocher l'option Dépôt dans la configuration du projet. Choisir le type de dépôt et saisir ses propriétés (exemple: `svn://hote/mondepot/` pour un dépôt SVN).

##### Wiki

Chaque projet peut bénéficier d'un wiki.

Pour l'activer, cocher l'option Wiki dans la configuration du projet. Un nom de page principale doit être identiqué. Cette page sera la première page affichée lors de la consultation du wiki.

##### Membres

Cett section vous permet de définir les membres du projet ainsi que leurs rôles respectifs. Un utilisateur ne peut avoir qu'un rôle au sein d'un projet donné. Le rôle d'un membre détermine les permissions dont il bénéficie sur le projet.

##### Versions

Les versions vous permettent de suivre les changements survenus tout au long du projet. La date figurant sur la version correspond à sa date d'échéance. Les versions pour lesquelles la date n'est pas encore passée sont affichées sur la vue "Roadmap".

Vous pouvez associer une page wiki à chaque version du projet. Le contenu de chaque page apparaîtra sur la Roadmap.

Sur chaque demande, vous pouvez indiquer quelle version la prend en compte. La demande apparaîtra alors sur l' Historique (lorsque la demande sera fermée) et la Roadmap.

Vous pouvez également publier les fichiers associés aux différentes versions de l'application (voir Fichiers).

##### Catégories des demandes

Les catégories de demande vous permettent de typer les demandes. Les catégories peuvent par exemple correspondre aux différents modules du projet.

Une catégorie référencée sur des demandes ne peut pas être supprimée.

##### Forums

Chaque projet peut contenir un ou plusieurs forums de discussion.

### Utilisateurs

Ces écrans vous permettent de gérer les utilisateurs de l'application.

#### Liste des utilisateurs

Liste des utilisateurs

Statut des comptes:

- L'icône signifie que le compte est vérouillé. Un utilisateur dont le compte est vérouillé ne peut plus s'identifier pour accéder à l'application.

- L'icône signifie que le compte n'a pas encore été activé par l'utilisateur (Voir S'enregistrer).

Les boutons Vérouiller/Dévérouiller vous permettent de bloquer ou débloquer les comptes utilisateurs. Le bouton Activer vous permet d'activer manuellement le compte d'un utilisateur qui s'est enregistré en ligne.

#### Création ou modification d'un utilisateur

En mode modification, laissez le champ Mot de passe vide pour laisser le mot de passe de l'utilisateur inchangé.

Un utilisateur déclaré comme administrateur dispose de toutes les permissions sur l'application et sur tous les projets.

- Administrateur: déclare l'utilisateur comme administrateur de l'application.

- Notifications par mail: permet d'activer ou non l'envoi automatique de notifications par mail pour cet utilisateur

- Vérouillé: désactive le compte de l'utilisateur

### Rôles et permissions

Les rôles permettent de définir les permissions des différents membres d'un projet. Chaque membre d'un projet dispose d'un rôle unique au sein d'un projet. Un utilisateur peut avoir différents rôles au sein de différents projets.

Sur l'écran d'édition du rôle, cochez les actions que vous souhaitez autoriser pour le rôle.

Rôle et permissions

### Trackers

Les trackers permettent de typer les demandes et de définir des workflows spécifiques pour chacun de ces types de demandes (voir Workflow). Un tracker peut être exclu des vues "Historique" et "Roadmap" (en décochant les options correspondantes dans les paramètres du tracker).

Lorsque vous créez un nouveau tracker, vous pouvez choisir de copier le workflow d'un tracker existant. Cela permet d'initialiser facilement le workflow du nouveau tracker et de n'y apporter que les modifications nécessaires.

Si aucun workflow n'est défini pour un tracker, aucun utilisateur ne pourra changer le statut des demandes liés à ce tracker.

### Champs personnalisés

Les champs personnalisés vous permettent d'ajouter des informations supplémentaires sur les projets, les demandes ou les utilisateurs. Un champ personnalisé peut être de l'un des types suivants:

- Entier: entier positif ou négatif

- Texte: chaîne de caractères

- Texte long: chaîne de caractères (saisissable sur plusieurs lignes)

- Date: date

- Booléen: oui/non (case à cocher)

- Liste: valeur à sélectionner parmi une liste prédéfinie (liste déroulante)

Des éléments de validation peuvent être définis:

- Min - max length: longueurs minimales et maximales pour les champs en saisie libre (0 signifie qu'il n'y a pas de restriction)

- Expression régulière: expression régulière permettant de valider la valeur saisie

  Exemples:

  `^\[A-Z]{4}\d+$` : 4 lettres majuscules suivies d'un ou plusieurs chiffres

  `^[^0-9]*$` : chaîne ne comportant pas de chiffres

- Valeurs possibles: valeurs possibles pour les champs de type "Liste". Cliquer sur l'icône + pour ajouter une nouvelle valeur possible.

#### Champs pour les projets

- Obligatoire: champ dont la saisie est obligatoire

#### Champs pour les demandes

- Pour tous les projects: champ automatiquement associé aux demandes de tous les projets

  Si cette option n'est pas activée, chaque projet pourra choisir d'utiliser ou non le champ pour ses demandes (voir configuration du projet).

- Obligatoire: champ dont la saisie est obligatoire sur chaque demande

- Utilisé comme filtre: si l'option est cochée, le champ pourra être utilisé comme filtre sur l'écran des demandes

#### Champs pour les utilisateurs

- Obligatoire: champ dont la saisie est obligatoire

### Statut des demandes

Ces écrans vous permettent de définir les différents statuts possibles des demandes.

- Demande fermée: indique que le statut correspond à une demande considérée comme fermée

- Statut par défaut: statut appliqué par défaut aux nouvelles demandes (seul un statut peut être déclaré comme statut par défaut)

- Couleur: code couleur HTML (6 caractères) représentant le statut à l'affichage

### Workflow

Le workflow permet de définir les changements que les différents membres d'un projet sont autorisés à effectuer sur les demandes, en fonction de leur type.

Sélectionnez le rôle et le tracker pour lesquels vous souhaitez modifier le workflow, puis cliquez sur Edit. L'écran vous permet alors de modifier, pour le rôle et le tracker choisi, les changements autorisés. Les lignes représentent les statuts initiaux des demandes. Les colonnes représentent les statuts autorisés à être appliqués.

Exemple de configuration d'un workflow

Dans l'exemple ci-dessus, les demandes de type Anomalie qui sont au statut Nouveau pourront être passées au statut Assignée ou Résolue par le rôle Développeur. Celles au statut Assignée pourront être passées au statut Résolue. Le statut de toutes les autres demandes de type Anomalie ne pourra pas être modifié par le Développeur.

### Listes de valeurs

Les listes de valeurs utilisées par l'application (exemple: les priorités des demandes) peuvent être personnalisées. Cet écran vous permet de définir les valeurs possibles pour chacune des listes suivantes:

- Activités (utilisées pour le suivi du temps passé)

- Priorités des demandes

- Catégories de documents

### Notifications par mail

Cet écran vous permet de sélectionner les actions qui donneront lieu à une notification par mail aux membres du projet.

Remarque: l'envoi de mails doit être activé dans la configuration de l'application si souhaitez effectuer des notifications.

### Authentification

Par défaut, redMine s'appuie sur sa propre base de données pour authentifier les utilisateurs, à l'aide d'un mot de passe spécifique.

Si vous disposez déjà d'un ou plusieurs référentiels externes d'utilisateurs (annuaires LDAP), vous pouvez les déclarer afin qu'ils soient utilisés pour l'authentification sur redMine. Cela permet aux utilisateurs d'accéder à redMine avec leurs identifiants et mots de passe habituels.

Pour chaque référentiel déclaré, vous pouvez spécifier si les comptes peuvent être créés à la volée dans redMine. Si c'est le cas, les comptes utilisateurs sont automatiquement créés à la première connexion de l'utilisateur (sans droits spécifiques sur les projets), à partir des informations disponibles dans le référentiel. Sinon, l'administrateur doit au préalable créer le compte de l'utilisateur dans redMine.

#### Annuaire LDAP

- Nom: nom d'affichage du référentiel

- Hôte: nom d'hôte du serveur LDAP

- Port: port de connexion au serveur LDAP

- Compte: DN du compte de connexion au LDAP (laisser vide si l'annuaire autorise l'accès anonyme en lecture)

- Mot de passe: mot de passe du compte de connexion

- Base DN: DN de base utilisé pour la recherche des utilisateur dans l'annuaire

- Filtre LDAP: Filtre de recherche des utilisateurs dans l'annuaire (optionnel)

- Attributs LDAP:

  - Identifiant: nom de l'attribut LDAP utilisé comme identifiant de l'utilisateur (ex: uid)

  - Prénom: nom de l'attribut LDAP contenant le prénom de l'utilisateur (ex: givenName)

  - Nom: nom de l'attribut LDAP contenant le nom de l'utilisateur (ex: sn)

  - Email: nom de l'attribut LDAP contenant l'adresse mail de l'utilisateur (ex: mail)

Les attributs "Prénom", "Nom" et "Email" doivent être renseigné si les comptes sont créés à la volée.

### Configuration

Cet écran vous permet de modifier les paramètres de configuration de l'application. Tous ces paramètres sont conservés dans la base de données de l'application. Ils sont donc conservés lorsque vous effectuez une mise à jour de votre installation.

- Titre de l'application

  Titre qui apparaît en en-tête des pages de l'application.

- Sous-titre de l'application

  Sous-titre qui apparaît en en-tête des pages de l'application.

- Texte d'accueil

  Texte affiché sur la page d'accueil de l'application. Ce texte peut contenir des balises HTML.

- Langue par défaut

  La langue par défaut est sélectionnée lorsque l'application n'a pas pu déterminer la langue définie au niveau du navigateur de l'utilisateur.La langue par défaut est également utilisée lors de l'envoi de mail à plusieurs utilisateurs.

  Défaut: Anglais

- Format de date

  Cette option permet de choisir le format d'affichage des dates dans l'application:

  - Basé sur la langue : les dates seront affichées selon le format de date défini pour chaque langue (JJ/MM/AAAA pour le français)

  - ISO 8601: les dates seront toujours affichées au format ISO (AAAA-MM-JJ)

  Défaut: Basé sur la langue

- Authentif. obligatoire

  Si cette option est cochée, aucune page de l'application n'est accessible sans s'être identifié. Elle permet donc ne rendre accessible l'application qu'aux utilisateurs qui disposent d'un compte valide.

  Défaut: Non

- Enregistrement autorisé

  Si cette option est cochée, la procédure d'enregistrement en ligne est disponible. L'envoi de mails doit être correctement configuré pour que les utilisateurs puissent activer leur compte (voir S'enregistrer)

  Défaut: Oui

- Mot de passe perdu

  Si cette option est cochée, la procédure de changement de mot de passe est disponible. L'envoi de mails doit être correctement configuré pour que les utilisateurs puissent choisir un nouveau mot de passe.

  Défaut: Oui

- Taille max des fichiers

  Taille maximale des fichiers pouvant être envoyés à l'application (en kilo-octets).

  Défaut: 2048 (soit 2Mo)

- Limite export demandes

  Nombre maximale de demandes contenues dans les exports CSV et PDF.

  Défaut: 500

- Adresse d'émission

  Adresse mail utilisée comme adresse d'émission (champ From des mails) lors de l'envoi de messages aux utilisateurs.

- Nom d'hôte

  Nom d'hôte de l'application. Ce nom est utilisé pour l'écriture des URL dans les mails envoyés aux utilisateurs.

- Formatage du texte

  Définit la méthode de formatage appliquée aux champs "description" des demandes, annonces, documents...

  L'option "Textile" n'est disponible que si la libraire ruby RedColth est installée. Consulter la page d'information pour savoir si vous disposez de cette librairie.

- Compression historique wiki

  Permet d'activer la compression de l'historique des pages wiki stockées dans la base de données (diminution de l'espace occupé).

  Défaut: désactivé

- Limite du contenu des flux RSS

  Nombre maximal d'enregistrements contenus dans les flux RSS.

  Défaut: 15

- Récupération auto. des commits

  Si cette option est activée, l'application récupère automatiquement les nouvelles révisions apportées sur le dépôt de sources du projet lorsqu'un utilisateur consulte le dépôt.

  Défaut: Oui

  Vous pouvez désactiver cette option et automatiser l'appel à Repository#fetch_changesets pour récupérer régulièrement les révisions de l'ensemble des dépôts en arrière plan.

  Exemple : `ruby script/runner "Repository.fetch_changesets"`

- Activer les WS de gestion des dépôts

  Cette option ne doit être activée que si vous avez installé le script de création automatique des dépôts.

  Défaut: Non

### Informations

Affiche des informations relatives à l'application et à son environnement.

## Projets

### Aperçu du projet

L'aperçu vous présente les informations générales relatives au projet, les principaux membres, les dernières annonces, ainsi qu'une synthèse du nombre de demandes ouvertes par tracker.

### Planning

#### Calendrier du projet

Le calendrier présente les tâches qui commencent ou se terminent au cours du mois sélectionné (mois en cours par défaut). Les tâches correspondent aux demandes pour lesquelles la date de début et d'échéance sont renseignées.

- Le symoble représente le début d'une tâche

- Le symbole représente la fin d'une tâche

- Le symbole représente une tâche qui débute et se termine le jour même

En cliquant sur le lien Options, vous pouvez sélectionner les trackers que vous souhaitez afficher. Si le projet contient des sous-projets, vous pouvez également afficher l'ensemble des demandes du projet et de ses sous-projets.

#### Diagramme de Gantt

Le diagramme de Gantt représente pour la période choisie l'ensemble des tâches et leurs taux d'avancement.

L'avancement est représenté en bleu. Le retard en rouge.

Diagramme de Gantt

En cliquant sur le lien Options, vous pouvez sélectionner les trackers que vous souhaitez afficher. Si le projet contient des sous-projets, vous pouvez également afficher l'ensemble des demandes du projet et de ses sous-projets.

### Gestion des demandes

#### Liste des demandes

Par défaut, l'ensemble des demandes ouvertes du projet sont affichées. Différents filtres vous permettent de sélectionner les demandes à afficher.

Une fois appliqué, un filtre reste valable durant toute votre session. Vous pouvez le redéfinir, ou le supprimer en cliquant sur Effacer.

Liste des demandes

### Rapports

Cet écran présente la synthèse du nombre de demandes par statut et selon différents critères (tracker, sous-projet, priorité, catégorie, auteur). Des liens permettent d'accéder à la liste détaillée des demandes pour chaque critère.

### Activité

Cette page présente par mois (le mois en cours par défaut) et par jour, les événements intervenus sur le projet.

- Nouvelles demandes

- Révisions apportées sur le dépôt (si le projet dispote d'un dépôt SVN)

- Annonces publiées

- Fichiers ajoutés

- Documents ajoutés

- Modifications apportées aux pages wiki (sir le projet a activé son wiki)

### Historique

Cette page présente l'ensemble des demandes résolues dans chacune des versions du projet.

### Roadmap

Cette page présente la liste des versions du projets dont la date n'est pas encore passée. Pour chaque version, la liste des demandes liées à cette version est affichée. Le ratio demandes fermées / demandes ouvertes est représenté sous forme d'une barre de progression.

### Annonces

Les nouvelles vous permettent d'informer les utilisateurs sur l'activité du projet. Les membres autorisés peuvent soumettre des commentaires sur les annonces publiées.

### Documents

Les documents sont groupés par catégories (voir Listes de valeurs). Un document peut contenir plusieurs fichiers (exemple: révisions ou versions successives).

### Wiki

#### Syntaxe wiki

##### Mise en forme

- `*gras*`

- `_italique_`

- `+souligné+`

- `-rayé-`

- `??citation??`

- `@code@`

- `h1. titre de la page`

- `h2. titre de niveau 2`

- `h3. titre de niveau 3`

##### Liens

- Lien externe : `http://www.redmine.org`

- Lien externe avec texte spécifique : `"Redmine":http://www.redmine.org`

- Lien vers une page wiki (éventuellement d'un autre projet) :

  - `[[Nom de page]]`

  - `[[Nom de page|Titre]]`

  - `[[Projet:]]`

  - `[[Projet:|Titre]]`

  - `[[Projet:Nom de page]]`

  - `[[Projet:Nom de page|Titre]]`

- Lien vers une demande : `#52`

- Lien vers une révision du dépôt (commit) : `r52`

##### Images

- Image externe : `!http://foo.bar/mon_image.jpg!`

- Image attachée à la page wiki : `!mon_image.jpg!`

- Image flotante à droite : `!>mon_image.jpg!`

### Fichiers

Ce module vous permet de publier les différents fichiers (sources, binaires, ...) pour chaque version du projet.

## Comptes utilisateurs

### Mon compte

#### Informations

Cet écran vous permet de modifier les informations relatives à votre compte: nom, prénom, adresse mail, langue (Anglais, Allemand, Espagnol ou Français).

Si la case Notifications par mail est décochée, aucune notification par mail ne vous sera envoyée.

#### Changement de mot de passe

Pour changer votre mot de passe, saisissez votre mot de passe actuel et le nouveau mot de passe souhaité (double saisie pour confirmation). Le mot de passe doit avoir une longueur comprise entre 4 et 12 caractères.

Si votre compte utilise une authentification externe (un annuaire LDAP), vous ne pouvez pas changer votre mot de passe dans redMine.

### Ma page

Cette page vous permet d'afficher de manière synthétique des informations sur vos projets.

Pour personnaliser votre page, cliquer sur le lien Personnaliser cette page. Vous pouvez alors sélectionner les informations à afficher et les positionner où vous le souhaitez sur la page, par glisser-déposer.

### Mot de passe perdu

En cas de perte de votre mot de passe, une procédure par mail vous permet d'en choisir un nouveau.

Sur l'écran d'authentification, cliquez sur Mot de passe perdu. Saisissez ensuite votre adresse mail dans le champ prévu et validez. Un mail vous est alors transmis. Il contient un lien qui vous permettra d'accéder à la page de choix du nouveau mot de passe.

Si votre compte utilise une authentification externe (un annuaire LDAP), cette procédure n'est pas disponible.

### S'enregistrer

L'enregistrement vous permet d'obtenir un compte sans intervention de l'administrateur.

Sur l'écran d'authentification, cliquez sur S'enregistrer. Complétez le formulaire d'inscription et validez. Un mail vous est alors transmis. Pour activer votre compte, utilisez le lien présent dans le mail qui vous a été envoyé.

La possibilité de s'enregistrer peut avoir été désactivée par l'administrateur.