diff options
Diffstat (limited to 'doc/docbook/en/redmine-userdoc-en.xml')
| -rw-r--r-- | doc/docbook/en/redmine-userdoc-en.xml | 278 |
1 files changed, 221 insertions, 57 deletions
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 @@ <title>Projects</title> <para>These screens allow you to manage projects.</para> + + <section> + <title>Project list</title> + + <para>On this screen, you can archive or delete projects.</para> + + <para>An archived project is no longer visible by users. It can be + un-archived by the administrator.</para> + </section> + + <section> + <title>Settings</title> + + <para></para> + + <section> + <title>Project properties</title> + + <para></para> + + <itemizedlist> + <listitem> + <para><guilabel moreinfo="none">Public</guilabel> : 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.</para> + </listitem> + + <listitem> + <para><guilabel>Subproject of</guilabel>: 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.</para> + </listitem> + + <listitem> + <para><guilabel>Name</guilabel>: project display name (must be + unique).</para> + </listitem> + + <listitem> + <para><guilabel>Description</guilabel>: description that appears + on the project overview.</para> + </listitem> + + <listitem> + <para><guilabel>Identifier</guilabel>: name of the project used + in an internal way by the application (must be unique). Once the + project created, this identifier cannot be modified.</para> + </listitem> + + <listitem> + <para><guilabel moreinfo="none">Customized fields</guilabel> : + Select the customized fields that you want to use. Only the + administrator can define new customized fields.</para> + </listitem> + </itemizedlist> + + <para></para> + </section> + + <section> + <title>Repository</title> + + <para>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.</para> + </section> + + <section> + <title>Wiki</title> + + <para>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.</para> + </section> + + <section> + <title>Members</title> + + <para>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.</para> + </section> + + <section> + <title>Versions</title> + + <para>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).</para> + </section> + + <section> + <title>Request categories</title> + + <para>Issue categories allow you to organize Issues. Categories can + correspond to different project modules.</para> + </section> + + <section> + <title>Forums</title> + + <para>Each project can contain one or more discussion forums.</para> + </section> + </section> </section> <section> @@ -471,6 +580,27 @@ </listitem> <listitem> + <para><guilabel>Date format</guilabel></para> + + <para>Lets you choose how dates are displayed:</para> + + <itemizedlist> + <listitem> + <para>Language based: the dates will be displayed according to + the format defined for each language (MM/JJ/AAAA for + English)</para> + </listitem> + + <listitem> + <para>ISO 8601: the dates will be always displayed with the ISO + format (YYYY-MM-DD)</para> + </listitem> + </itemizedlist> + + <para><emphasis>Default: Language based</emphasis></para> + </listitem> + + <listitem> <para><guilabel>Authent. required</guilabel></para> <para>If this option is checked, no page of the application is @@ -538,6 +668,52 @@ <para>"Textile" option is only available if RedColth ruby library is present.</para> </listitem> + + <listitem> + <para><guilabel>Wiki history compression</guilabel></para> + + <para>Lets you activate compression for wiki history storage + (reduces database size).</para> + + <para><emphasis>Default: disabled</emphasis></para> + </listitem> + + <listitem> + <para><guilabel>Feed content limit</guilabel></para> + + <para>Maximum number of records contained in RSS feeds.</para> + + <para><emphasis>Default: 15</emphasis></para> + </listitem> + + <listitem> + <para><guilabel>Autofetch commits</guilabel></para> + + <para>If this option is activated, the application automatically + retrieves the new revisions when a user consults the + repository.</para> + + <para><emphasis>Default: Yes</emphasis></para> + + <para>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.</para> + + <para>Example : <code>ruby script/runner + "Repository.fetch_changesets"</code></para> + </listitem> + + <listitem> + <para><guilabel>Enable WS for repository + management</guilabel></para> + + <para>This option should be activated only if you installed the + script for automatic SVN repository creation.</para> + + <para><emphasis>Default: No</emphasis></para> + + <para></para> + </listitem> </itemizedlist> </section> @@ -667,11 +843,54 @@ </section> <section> + <title>Activity</title> + + <para>This page displays for each month (current month by default) and + per day, the events occurred on the project.</para> + + <itemizedlist> + <listitem> + <para>New issues</para> + </listitem> + + <listitem> + <para>Repository changesets</para> + </listitem> + + <listitem> + <para>News</para> + </listitem> + + <listitem> + <para>Added files</para> + </listitem> + + <listitem> + <para>Added documents</para> + </listitem> + + <listitem> + <para>Wiki edits</para> + </listitem> + </itemizedlist> + + <para></para> + </section> + + <section> <title>Change log</title> <para>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.</para> + version of the project. Certain trackers can be excluded from this + display.</para> + </section> + + <section> + <title>Roadmap</title> + + <para>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.</para> </section> <section> @@ -694,61 +913,6 @@ <para>This module allows you to display various folders (sources, binaires, ...) for each version of the application.</para> </section> - - <section> - <title>Settings</title> - - <para></para> - - <section> - <title>Project features</title> - - <para></para> - - <itemizedlist> - <listitem> - <para><guilabel moreinfo="none">Public</guilabel> : 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.</para> - </listitem> - - <listitem> - <para><guilabel moreinfo="none">Customized fields</guilabel> : - Select the customized fields that you want to use. Only the - administrator can define new customized fields.</para> - </listitem> - </itemizedlist> - - <para></para> - </section> - - <section> - <title>Members</title> - - <para>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.</para> - </section> - - <section> - <title>Versions</title> - - <para>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).</para> - </section> - - <section> - <title>Request categories</title> - - <para>Issue categories allow you to organize Issues. Categories can - correspond to different project modules.</para> - </section> - </section> </chapter> <chapter> |