From 1cb5fc747f10a5e5c2698ac6f5637b9c447e6bdf Mon Sep 17 00:00:00 2001 From: Jean-Philippe Lang Date: Sun, 15 Jul 2007 10:11:25 +0000 Subject: Slight documentation update. git-svn-id: http://redmine.rubyforge.org/svn/trunk@589 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- doc/UPGRADING | 13 +- doc/docbook/en/redmine-userdoc-en.xml | 278 ++++++++++++++++----- doc/docbook/fr/redmine-userdoc-fr.xml | 453 ++++++++++++++++++++++++++-------- 3 files changed, 577 insertions(+), 167 deletions(-) (limited to 'doc') diff --git a/doc/UPGRADING b/doc/UPGRADING index 21ed4d14f..af92ee319 100644 --- a/doc/UPGRADING +++ b/doc/UPGRADING @@ -5,8 +5,6 @@ Copyright (C) 2006-2007 Jean-Philippe Lang http://redmine.rubyforge.org/ -Note that Rails 1.2.2 is required for version 0.4.2 and later - == Upgrading from 0.3.0 and above 1. Uncompress program archive in a new directory: @@ -15,9 +13,14 @@ Note that Rails 1.2.2 is required for version 0.4.2 and later 3. Copy your database settings (database.yml) into the new config directory 4. Migrate your database: - rake migrate RAILS_ENV="production" - -Note: settings previously defined in custom_config.rb are now stored + rake db:migrate RAILS_ENV="production" + +Note 1: Rails 1.2.2 is required for version 0.4.2 and later. + +Note 2: when upgrading your code with svn update, don't forget to clear +the application cache (RAILS_ROOT/tmp/cache) before restarting. + +Note 3: settings previously defined in custom_config.rb are now stored in database, as of version 0.4.2. Go to "Admin -> Settings" to edit them. diff --git a/doc/docbook/en/redmine-userdoc-en.xml b/doc/docbook/en/redmine-userdoc-en.xml index 16fae473f..d3093114d 100644 --- a/doc/docbook/en/redmine-userdoc-en.xml +++ b/doc/docbook/en/redmine-userdoc-en.xml @@ -11,6 +11,115 @@ Projects These screens allow you to manage projects. + +
+ Project list + + On this screen, you can archive or delete projects. + + An archived project is no longer visible by users. It can be + un-archived by the administrator. +
+ +
+ Settings + + + +
+ Project properties + + + + + + Public : if it’s a + public project, it can be viewed (request consultation, + documents consultation, ...) for all the users, including those + who are not project members. If it’s not a public project, only + the project members have access to it, according to their + role. + + + + Subproject of: lets you define the + parent project. The hierarchy of the projects is limited to 2 + levels. A parent project cannot be itself a sub-project. + + + + Name: project display name (must be + unique). + + + + Description: description that appears + on the project overview. + + + + Identifier: name of the project used + in an internal way by the application (must be unique). Once the + project created, this identifier cannot be modified. + + + + Customized fields : + Select the customized fields that you want to use. Only the + administrator can define new customized fields. + + + + +
+ +
+ Repository + + A source repository can be associated with each project. Once + the repository configured, you will be able to browse it and view + the revisions. The revisions appear in the Activity view. +
+ +
+ Wiki + + Each project can have its own wiki. To activate it, check the + Wiki option in the project settings and give the name for the main + page. +
+ +
+ Members + + This screen allows you to define the project members as well + as their corresponding roles. A user can have only one role in a + given project. The role of a member determines the permissions they + have in a project. +
+ +
+ Versions + + Versions allow you to follow the changes made during all the + project. For instance, at the close of an Issue, you can indicate + which version takes it into account. You can display the various + versions of the application (see Files). +
+ +
+ Request categories + + Issue categories allow you to organize Issues. Categories can + correspond to different project modules. +
+ +
+ Forums + + Each project can contain one or more discussion forums. +
+
@@ -470,6 +579,27 @@ Default: English + + Date format + + Lets you choose how dates are displayed: + + + + Language based: the dates will be displayed according to + the format defined for each language (MM/JJ/AAAA for + English) + + + + ISO 8601: the dates will be always displayed with the ISO + format (YYYY-MM-DD) + + + + Default: Language based + + Authent. required @@ -538,6 +668,52 @@ "Textile" option is only available if RedColth ruby library is present. + + + Wiki history compression + + Lets you activate compression for wiki history storage + (reduces database size). + + Default: disabled + + + + Feed content limit + + Maximum number of records contained in RSS feeds. + + Default: 15 + + + + Autofetch commits + + If this option is activated, the application automatically + retrieves the new revisions when a user consults the + repository. + + Default: Yes + + You can disable this option and automate the call to + Repository#fetch_changesets to regularly retrieve the revisions for + all of the repositories in background. + + Example : ruby script/runner + "Repository.fetch_changesets" + + + + Enable WS for repository + management + + This option should be activated only if you installed the + script for automatic SVN repository creation. + + Default: No + + +
@@ -666,12 +842,55 @@ criterion. +
+ Activity + + This page displays for each month (current month by default) and + per day, the events occurred on the project. + + + + New issues + + + + Repository changesets + + + + News + + + + Added files + + + + Added documents + + + + Wiki edits + + + + +
+
Change log This page presents the entire list of the resolved Issues for each - version of the project. Certain types of Issues can be excluded from - this display. + version of the project. Certain trackers can be excluded from this + display. +
+ +
+ Roadmap + + This page displays the list of the versions of the projects whose + date did not pass yet. For each version, the list of the related issues + is displayed. Certain trackers can be excluded from this display.
@@ -694,61 +913,6 @@ This module allows you to display various folders (sources, binaires, ...) for each version of the application.
- -
- Settings - - - -
- Project features - - - - - - Public : if it’s a - public project, it can be viewed (request consultation, documents - consultation, ...) for all the users, including those who are not - project members. If it’s not a public project, only the project - members have access to it, according to their role. - - - - Customized fields : - Select the customized fields that you want to use. Only the - administrator can define new customized fields. - - - - -
- -
- Members - - This screen allows you to define the project members as well as - their corresponding roles. A user can have only one role in a given - project. The role of a member determines the permissions they have in - a project. -
- -
- Versions - - Versions allow you to follow the changes made during all the - project. For instance, at the close of an Issue, you can indicate - which version takes it into account. You can display the various - versions of the application (see Files). -
- -
- Request categories - - Issue categories allow you to organize Issues. Categories can - correspond to different project modules. -
-
diff --git a/doc/docbook/fr/redmine-userdoc-fr.xml b/doc/docbook/fr/redmine-userdoc-fr.xml index f32f0bb54..966f1446f 100644 --- a/doc/docbook/fr/redmine-userdoc-fr.xml +++ b/doc/docbook/fr/redmine-userdoc-fr.xml @@ -11,6 +11,149 @@ 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. + + +
+
@@ -53,12 +196,14 @@ signifie que le compte n'a pas encore été - activé par l'utilisateur . + activé par l'utilisateur (Voir S'enregistrer). Les boutons Vérouiller/Dévérouiller vous permettent de bloquer - ou débloquer les comptes utilisateurs. + 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.
@@ -125,7 +270,18 @@ Trackers Les trackers permettent de typer les demandes et de définir des - workflows spécifiques pour chacun de ces types. + 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.
@@ -146,8 +302,8 @@ - Texte long: chaîne de caractères, avec - champ à plusieurs lignes + Texte long: chaîne de caractères + (saisissable sur plusieurs lignes) @@ -155,11 +311,11 @@ - Booléen: booléen (case à cocher) + Booléen: oui/non (case à cocher) - Liste: valeur à sélectionnée parmi une + Liste: valeur à sélectionner parmi une liste prédéfinie (liste déroulante) @@ -167,16 +323,6 @@ Des éléments de validation peuvent être définis: - - Obligatoire: champ dont la saisie est - obligatoire sur les demandes - - - - Pour tous les projects: champ - automatiquement associé à l'ensemble des projets - - Min - max length: longueurs minimales et maximales pour les champs en saisie libre (0 signifie qu'il n'y a @@ -198,8 +344,8 @@ Valeurs possibles: valeurs possibles pour - les champs de type "Liste". Les valeurs sont séparées par le - caractère | + les champs de type "Liste". Cliquer sur l'icône + pour ajouter une + nouvelle valeur possible. @@ -228,13 +374,23 @@ Pour tous les projects: champ - automatiquement associé aux demandes de l'ensemble des - projets + 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 + @@ -312,11 +468,11 @@ - Dans l'exemple ci-dessus, les demandes de type Bug 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 Bug ne pourra - pas être modifié par le Développeur. + 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.
@@ -328,6 +484,10 @@ suivantes: + + Activités (utilisées pour le suivi du temps passé) + + Priorités des demandes @@ -441,8 +601,8 @@ Les attributs "Prénom", - "Nom" et "Email" ne sont - utilisés que lorsque les comptes sont créés à la volée. + "Nom" et "Email" doivent + être renseigné si les comptes sont créés à la volée.
@@ -450,7 +610,9 @@ Configuration Cet écran vous permet de modifier les paramètres de configuration - de l'application. + 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. @@ -458,13 +620,15 @@ Titre de l'application - Titre qui apparaît en en-tête 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 de l'application. + Sous-titre qui apparaît en en-tête des pages de + l'application. @@ -485,12 +649,35 @@ 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 de manière anonyme. Les utilisateurs doivent - obligatoirement s'identifier pour y accéder. + 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 @@ -499,7 +686,9 @@ Enregistrement autorisé Si cette option est cochée, la procédure d'enregistrement en - ligne est disponible. + 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 @@ -508,7 +697,9 @@ Mot de passe perdu Si cette option est cochée, la procédure de changement de mot - de passe est disponible. + 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 @@ -552,7 +743,56 @@ "description" des demandes, annonces, documents... L'option "Textile" n'est disponible que si la libraire ruby - RedColth est installée. + 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 + + @@ -618,7 +858,10 @@ - + 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.
@@ -640,6 +883,13 @@ + + 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. + +
@@ -679,24 +929,78 @@ Rapports Cet écran présente la 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. + 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. Certains types de demande peuvent être exclus de - cet affichage. + des versions du projet. + + Remarque: certains trackers peuvent être exclus de la vue + "Historique". Les demandes correpondantes n'y seront alors pas + affichées. +
+ +
+ 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. + + Remarque: certains trackers peuvent être exclus de la vue + "Roadmap". Les demandes correpondantes n'y seront alors pas + affichées.
Annonces Les nouvelles vous permettent d'informer les utilisateurs sur - l'activité du projet. + l'activité du projet. Les membres autorisés peuvent soumettre des + commentaires sur les annonces publiées.
@@ -711,70 +1015,9 @@ Fichiers Ce module vous permet de publier les différents fichiers (sources, - binaires, ...) pour chaque version de l'application. -
- -
- Configuration du projet + binaires, ...) pour chaque version du projet. - -
- Propriétés du projet - - - - - - Public: 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. Si le projet n'est pas public, seuls les - membres du projet y ont accès, en fonction de leur rôle. - - - - Champs personnalisés: sélectionner les - champs personnalisésMo que vous souhaitez utiliser pour les - demandes du projet. Seul l'administrateur peut définir de nouveaux - champs personnalisés. - - - - -
- -
- 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. A la fermeture d'une demande, vous pouvez par - exemple indiquer quelle version la prend en compte. Vous pouvez par - ailleurs publier les 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. - - -
-- cgit v1.2.3