summaryrefslogtreecommitdiffstats
path: root/redmine/public/manual
diff options
context:
space:
mode:
Diffstat (limited to 'redmine/public/manual')
-rw-r--r--redmine/public/manual/administration.html121
-rw-r--r--redmine/public/manual/images/issues_list.pngbin0 -> 8055 bytes
-rw-r--r--redmine/public/manual/images/users_edit.pngbin0 -> 2700 bytes
-rw-r--r--redmine/public/manual/images/users_list.pngbin0 -> 6502 bytes
-rw-r--r--redmine/public/manual/images/workflow.pngbin0 -> 4967 bytes
-rw-r--r--redmine/public/manual/index.html64
-rw-r--r--redmine/public/manual/projects.html109
-rw-r--r--redmine/public/manual/stylesheets/help.css70
8 files changed, 364 insertions, 0 deletions
diff --git a/redmine/public/manual/administration.html b/redmine/public/manual/administration.html
new file mode 100644
index 000000000..22016c4d6
--- /dev/null
+++ b/redmine/public/manual/administration.html
@@ -0,0 +1,121 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<head>
+<title>redMine - Aide en ligne</title>
+<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+<meta name="description" content="redMine" />
+<meta name="keywords" content="issue,bug,tracker" />
+<link href="stylesheets/help.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+<p align="right">[ <a href="index.html">Index</a> ]</p>
+<h1>Administration</h1>
+Sommaire:
+<ol>
+ <li><a href="administration.html#users">Utilisateurs</a></li>
+ <li><a href="administration.html#roles">Rôles et permissions</a></li>
+ <li><a href="administration.html#trackers">Trackers</a></li>
+ <li><a href="administration.html#custom_fields">Champs personnalisés</a></li>
+ <li><a href="administration.html#issue_statuses">Statuts de demande</a></li>
+ <li><a href="administration.html#workflow">Workflow</a></li>
+ <li><a href="administration.html#enumerations">Listes de valeurs</a></li>
+ <li><a href="administration.html#mail_notifications">Notifications par mail</a></li>
+ <li><a href="administration.html#app_info">Informations</a></li>
+</ol>
+
+
+<h2><a name="users"></a>1. Utilisateurs</h2>
+<p>Ces écrans vous permettent de gérer les utilisateurs de l'application.</p>
+<h3>1.1 Liste des utilisateurs</h3>
+<center><img src="images/users_list.png"><br />
+<i><small>Liste des utilisateurs</small></i></center>
+<h3>1.2 Création ou modification d'un utilisateur</h3>
+<ul>
+ <li><b>Administrateur</b>: déclare l'utilisateur comme administrateur de l'application.</li>
+ <li><b>Notifications par mail</b>: permet d'activer ou non l'envoi automatique de notifications par mail pour cet utilisateur</li>
+ <li><b>Verrouillé</b>: désactive le compte de l'utilisateur</li>
+</ul>
+<p>En mode modification, laissez le champ <b>Password</b> vide pour laisser le mot de passe de l'utilisateur inchangé.</p>
+<p>Un utilisateur déclaré comme administrateur dispose de toutes les permissions sur l'application et sur tous les projets.</p>
+
+
+<h2><a name="roles"></a>2. Rôles et permissions</h2>
+<p>Les rôles permettent de définir les permissions des différents membres d'un projet.<br />
+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.</p>
+<p>Sur l'écran d'édition du rôle, cochez les actions que vous souhaitez autoriser pour le rôle.</p>
+
+
+<h2><a name="trackers"></a>3. Trackers</h2>
+<p>Les trackers permettent de typer les demandes et de définir des workflows spécifiques pour chacun de ces types.</p>
+
+<h2><a name="custom_fields"></a>4. Champs personnalisés</h2>
+<p>Les champs personnalisés vous permettent d'ajouter des informations supplémentaires sur les demandes.</p>
+Un champ personnalisé peut être de l'un des types suivants:
+<ul>
+ <li><b>Integer</b>: entier positif ou négatif</li>
+ <li><b>String</b>: chaîne de caractère</li>
+ <li><b>Date</b>: date</li>
+ <li><b>Boolean</b>: booléen (case à cocher)</li>
+ <li><b>List</b>: valeur à sélectionnée parmi une liste prédéfinie (liste déroulante)</li>
+</ul>
+Des éléments de validation peuvent être définis:
+<ul>
+ <li><b>Required</b>: champ dont la saisie est obligatoire sur les demandes</li>
+ <li><b>For all projects</b>: champ automatiquement associé à l'ensemble des projets</li>
+ <li><b>Min - max length</b>: longueurs minimales et maximales pour les champs en saisie libre (0 signifie qu'il n'y a pas de restriction)</li>
+ <li><b>Regular expression</b>: expression régulière permettant de valider la valeur saisie</li>
+ <li><b>Possible values (only for lists)</b>: valeurs possibles pour les champs de type "List". Les valeurs sont séparées par le caractère |</li>
+</ul>
+<p>Si l'option <b>For all projects</b> n'est pas activée, chaque projet pourra ou non utilisé le champ personnalisé pour ses demandes
+(voir <a href="projects.html#settings">Project settings</a>).</p>
+
+
+<h2><a name="issue_statuses"></a>5. Statuts des demandes</h2>
+<p>Cet écran vous permet de définir les différents statuts possibles des demandes.</p>
+<ul>
+ <li><b>Closed</b>: indique que le statut correspond à une demande considérée comme fermée</li>
+ <li><b>Default</b>: statut appliqué par défaut aux nouvelles demandes (seul un statut peut être déclaré comme statut par défaut)</li>
+ <li><b>HTML color</b>: code de couleur HTML représentant le statut à l'affichage</li>
+</ul>
+
+
+<h2><a name="workflow"></a>6. Workflow</h2>
+<p>Le workflow permet de définir quels changements les différents membres d'un projet sont autorisés à effectuer sur le statut des demandes, en fonction de leur type.</p>
+<p>Sélectionnez le rôle et le type de demande pour lesquels vous souhaitez modifier le workflow, puis cliquez sur <b>Edit</b>.
+L'écran vous permet alors de modifier, pour le rôle et le type de demande choisi, les changements autorisés.</p>
+<p>Les lignes représentent les statuts initiaux des demandes. Les colonnes représentent les statuts autorisés à être appliqués.</p>
+<p>Dans l'exemple ci-dessous, les demandes de type Bug au statut New pourront être passées au statut Assigned ou Resolved par le rôle Développeur.<br />
+Celles au statut Assigned pourront être passées au statut Resolved.<br />
+Le statut de toutes les autres demandes de type Bug ne pourra pas être modifié par le Développeur.</p>
+<center><img src="images/workflow.png"><br />
+<i><small>Exemple de configuration d'un workflow</small></i></center>
+<p><b>Remarque</b>: pour qu'un rôle puisse changer le statut des demandes, la permission <i>"Changer le statut des demandes"</i> doit lui être explicitement donnée indépendemment de la configuration du workflow (voir <a href="#roles">Roles et permissions</a>).
+
+
+<h2><a name="enumerations"></a>7. Listes de valeurs</h2>
+<p>Les listes de valeurs utilisées par l'application (exemple: les priorités des demandes) peuvent être personnalisées en fonction de vos besoins.<br />
+Cet écran vous permet de définir les valeurs possibles pour chacune des listes suivantes:</p>
+<ul>
+ <li><b>Priorités des demandes</b></li>
+ <li><b>Catégories de documents</b></li>
+</ul>
+
+
+<h2><a name="mail_notifications"></a>8. Notifications par mail</h2>
+<p>Cet écran vous permet de sélectionner les actions qui donneront lieu à une notification par mail aux membres du projet.</p>
+<p><b>Remarque</b>: l'envoi de mails doit être activé dans la configuration de l'application si souhaitez effectuer des notifications.</p>
+
+
+<h2><a name="app_info"></a>9. Informations</h2>
+<p>Affiche des informations relatives à l'application</p>
+<ul>
+ <li><b>Version</b>: version de l'application</li>
+ <li><b>Database</b>: type de base de données utilisée</li>
+</ul>
+
+
+</body>
+</html>
+
diff --git a/redmine/public/manual/images/issues_list.png b/redmine/public/manual/images/issues_list.png
new file mode 100644
index 000000000..2fa6dc1b6
--- /dev/null
+++ b/redmine/public/manual/images/issues_list.png
Binary files differ
diff --git a/redmine/public/manual/images/users_edit.png b/redmine/public/manual/images/users_edit.png
new file mode 100644
index 000000000..3a4797e9d
--- /dev/null
+++ b/redmine/public/manual/images/users_edit.png
Binary files differ
diff --git a/redmine/public/manual/images/users_list.png b/redmine/public/manual/images/users_list.png
new file mode 100644
index 000000000..0c9ef86ec
--- /dev/null
+++ b/redmine/public/manual/images/users_list.png
Binary files differ
diff --git a/redmine/public/manual/images/workflow.png b/redmine/public/manual/images/workflow.png
new file mode 100644
index 000000000..26071cade
--- /dev/null
+++ b/redmine/public/manual/images/workflow.png
Binary files differ
diff --git a/redmine/public/manual/index.html b/redmine/public/manual/index.html
new file mode 100644
index 000000000..3f0cb1e6f
--- /dev/null
+++ b/redmine/public/manual/index.html
@@ -0,0 +1,64 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<head>
+<title>redMine - Aide en ligne</title>
+<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+<meta name="description" content="redMine" />
+<meta name="keywords" content="issue,bug,tracker" />
+<link href="stylesheets/help.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+<h1>Aide</h1>
+
+<p>Documentation en ligne redMine</p>
+
+Sommaire:
+<ul>
+
+ <li>
+ <a href="administration.html">Administration</a>
+ <ol>
+ <li><a href="administration.html#users">Utilisateur</a></li>
+ <li><a href="administration.html#roles">Rôles et permissions</a></li>
+ <li><a href="administration.html#trackers">Trackers</a></li>
+ <li><a href="administration.html#custom_fields">Champs personnalisés</a></li>
+ <li><a href="administration.html#issue_statuses">Statuts de demande</a></li>
+ <li><a href="administration.html#workflow">Workflow</a></li>
+ <li><a href="administration.html#enumerations">Liste de valeurs</a></li>
+ <li><a href="administration.html#mail_notifications">Notifications par mail</a></li>
+ <li><a href="administration.html#app_info">Informations</a></li>
+ </ol>
+ </li>
+
+ <li><a href="projects.html">Projets</a>
+ <ol>
+ <li><a href="projects.html#overview">Aperçu</a></li>
+ <li><a href="projects.html#issues">Demandes</a>
+ <ul>
+ <li>Liste des demandes</li>
+ <li>Nouvelle demande</li>
+ <li>Changer le statut d'une demande</li>
+ </ul>
+ </li>
+ <li><a href="projects.html#reports">Rapports</a></li>
+ <li><a href="projects.html#news">Annonces</a></li>
+ <li><a href="projects.html#changelog">Historique</a></li>
+ <li><a href="projects.html#documents">Documents</a></li>
+ <li><a href="projects.html#members">Membres</a></li>
+ <li><a href="projects.html#files">Fichiers</a></li>
+ <li><a href="projects.html#settings">Configuration</a></li>
+ <ul>
+ <li>Projet</li>
+ <li>Membres</li>
+ <li>Versions</li>
+ <li>Catégories de demande</li>
+ </ul>
+ </ol>
+ </li>
+
+
+</ul>
+
+</body>
+</html> \ No newline at end of file
diff --git a/redmine/public/manual/projects.html b/redmine/public/manual/projects.html
new file mode 100644
index 000000000..13922f69d
--- /dev/null
+++ b/redmine/public/manual/projects.html
@@ -0,0 +1,109 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+
+<head>
+<title>redMine - Aide en ligne</title>
+<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+<meta name="description" content="redMine" />
+<meta name="keywords" content="issue,bug,tracker" />
+<link href="stylesheets/help.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+<p align="right">[ <a href="index.html">Index</a> ]</p>
+<h1>Projets</h1>
+Sommaire:
+<ol>
+ <li><a href="projects.html#overview">Aperçu</a></li>
+ <li><a href="projects.html#issues">Demandes</a>
+ <ul>
+ <li>Liste des demandes</li>
+ <li>Nouvelle demande</li>
+ <li>Changer le statut d'une demande</li>
+ </ul>
+ </li>
+ <li><a href="projects.html#reports">Rapports</a></li>
+ <li><a href="projects.html#news">Annonces</a></li>
+ <li><a href="projects.html#changelog">Historique</a></li>
+ <li><a href="projects.html#documents">Documents</a></li>
+ <li><a href="projects.html#members">Membres</a></li>
+ <li><a href="projects.html#files">Fichiers</a></li>
+ <li><a href="projects.html#settings">Configuration</a></li>
+ <ul>
+ <li>Projet</li>
+ <li>Membres</li>
+ <li>Versions</li>
+ <li>Catégories de demande</li>
+ </ul>
+</ol>
+
+
+<h2><a name="overview"></a>1. Aperçu</h2>
+<p>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.
+
+
+<h2><a name="issues"></a>2. Demandes</h2>
+<h3>2.1 Liste des demandes</h3>
+Par défaut, l'ensemble des demandes sont affichées. Vous pouvez utiliser les différents filtres pour limiter l'affichage à certaines demandes seulement.<br />
+Lorsque vous appliquez un filtre, il reste en place durant toute votre session. Vous pouvez le redéfinir, ou le supprimer en cliquant sur <b>Annuler</b>.
+<center><img src="images/issues_list.png"><br />
+<i><small>Liste des demandes</small></i></center>
+
+<h3>2.2 Nouvelle demande</h3>
+<p>TODO</p>
+
+<h3>2.3 Changer le statut d'une demande</h3>
+<p>TODO</p>
+
+
+<h2><a name="reports"></a>3. Rapports</h2>
+<p>Synthèse du nombre de demandes par statut et selon différents critères (tracker, priorité, catégorie).
+Des liens directs permettent d'accéder à la liste détaillée des demandes pour chaque critère.</p>
+
+
+<h2><a name="news"></a>4. Annonces</h2>
+<p>Les nouvelles vous permettent d'informer les utilisateurs sur l'activité du projet.</p>
+
+
+<h2><a name="changelog"></a>5. Historique</h2>
+<p>Cette page présente l'ensemble des demandes résolues dans chacune des versions du projet.
+Certains types de demande peuvent être exclus de cet affichage (voir <a href="administration.html#trackers">Trackers</a>).</p>
+
+
+<h2><a name="documents"></a>6. Documents</h2>
+<p>Les documents sont groupés par catégories (voir <a href="administration.html#enumerations">Listes de valeurs</a>).<br />
+Un document peut contenir plusieurs fichiers (exemple: révisions ou versions successives)</p>
+
+
+<h2><a name="members"></a>7. Membres</h2>
+<p>Affichage de l'ensemble des membres du projet, par rôle</p>
+
+
+<h2><a name="files"></a>8. Fichiers</h2>
+<p>Ce module vous permet de publier les fichiers de l'application (sources, binaires, ...) pour chaque version de l'application .</p>
+
+<h2><a name="settings"></a>9. Configuration</h2>
+<h3>9.1 Projet</h3>
+<ul>
+ <li><b>Public</b>: si le projet est public, il sera visible (consultation des demandes, des documents, ...) pour l'ensemble des utilisateurs, y compris ceux qui ne sont pas membres du projet.<br />
+ Si le projet n'est pas public, seuls les membres du projet y ont accès, en fonction de leur rôle.</li>
+ <li><b>Champs personnalisés</b>: sélectionner les champs personnalisés que vous souhaitez utiliser au sein du projet.<br />
+ Seul l'administrateur peut ajouter de nouveaux champs personnalisés.</li>
+</ul>
+<h3>9.2 Membres</h3>
+<p>Cette section vous permet de définir les membres du projet ainsi que leurs rôles respectifs.<br />
+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.</p>
+
+<h3>9.3 Versions</h3>
+<p>Les versions vous permettent de suivre les changements survenus tout au long du projet.
+A la fermeture d'une demande, vous pouvez indiquer quelle version la prend en compte.<br />
+Vous pouvez par ailleurs publier les différentes versions de l'application (voir <a href="projects.html#files">Fichiers</a>).
+</p>
+
+
+<h3>9.4 Catégories de demande</h3>
+<p>Les catégories de demande vous permettent de typer les demandes. Les catégories peuvent par exemple correspondre aux modules de l'application.</p>
+
+
+</body>
+</html>
+
diff --git a/redmine/public/manual/stylesheets/help.css b/redmine/public/manual/stylesheets/help.css
new file mode 100644
index 000000000..f67bc72bf
--- /dev/null
+++ b/redmine/public/manual/stylesheets/help.css
@@ -0,0 +1,70 @@
+/* andreas08 - an open source xhtml/css website layout by Andreas Viklund - http://andreasviklund.com . Free to use in any way and for any purpose as long as the proper credits are given to the original designer. Version: 1.0, November 28, 2005 */
+
+/**************** Body and tag styles ****************/
+
+
+
+body{
+font:76% Verdana,Tahoma,Arial,sans-serif;
+line-height:1.4em;
+color:#303030;
+margin: 20px;
+}
+
+a{
+color:#467aa7;
+font-weight:bold;
+text-decoration:none;
+background-color:inherit;
+}
+
+a:hover{color:#2a5a8a; text-decoration:none; background-color:inherit;}
+a img{border:none;}
+
+p{padding:0 0 0.2em 0;}
+p form{margin-top:0; margin-bottom:20px;}
+
+h1 {
+display:block;
+
+font-size:1.7em;
+font-weight:normal;
+letter-spacing:-1px;
+color:#505050;
+background-color:inherit;
+}
+
+h2 {
+display:block;
+margin: 30px 0 0 0;
+font-size:1.5em;
+font-weight:normal;
+letter-spacing:-1px;
+color:#505050;
+background-color:inherit;
+}
+
+hr { border:0px; border-bottom:1px dashed #000000; }
+
+
+/**************** Misc classes and styles ****************/
+
+.splitcontentleft{float:left; width:49%;}
+.splitcontentright{float:right; width:49%;}
+.clear{clear:both;}
+.small{font-size:0.8em;line-height:1.4em;padding:0 0 0 0;}
+.hide{display:none;}
+.textcenter{text-align:center;}
+.textright{text-align:right;}
+.important{color:#f02025; background-color:inherit; }
+
+.box{
+margin:0 0 20px 0;
+padding:10px;
+border:1px solid #c0c0c0;
+background-color:#fafbfc;
+color:#505050;
+line-height:1.5em;
+}
+
+