##// END OF EJS Templates
english help translation added...
Jean-Philippe Lang -
r41:67070347686f
parent child
Show More
@@ -0,0 +1,429
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
3 <book>
4 <title>RedMine Documentation</title>
5 <chapter>
6 <title>Administration</title>
7 <section>
8 <title>Users</title>
9 <para>These screens allow you to manage the application users.</para>
10 <section>
11 <title>Users’ List</title>
12 <para/>
13 <screenshot>
14 <screeninfo>Users’ List</screeninfo>
15 <mediaobject>
16 <imageobject>
17 <imagedata fileref="images/users_list.png"/>
18 </imageobject>
19 </mediaobject>
20 </screenshot>
21 <para>The Lock/Unlock buttons allow you to lock/unlock the user accounts.</para>
22 <para>A user having a locked account cannot log in and access the application.</para>
23 </section>
24 <section>
25 <title>User Creation or Modification</title>
26 <para>In modification mode, please leave the Password field blank in order to keep the user’s password unchanged.</para>
27 <para>A user designated as administrator has unrestricted access to the application and to all projects.</para>
28 <itemizedlist>
29 <listitem>
30 <para>
31 <guilabel moreinfo="none">Administrator</guilabel>
32 : designate the user as the administrator of the application.
33 </para>
34 </listitem>
35 <listitem>
36 <para>
37 <guilabel moreinfo="none">E-mail notifications</guilabel>
38 : activate or de-activate automatic e-mail notifications for this user
39 </para>
40 </listitem>
41 <listitem>
42 <para>
43 <guilabel moreinfo="none">Locked</guilabel>
44 : de-activates the user’s account
45 </para>
46 </listitem>
47 </itemizedlist>
48 <para/>
49 </section>
50 </section>
51 <section>
52 <title>Roles and Permissions</title>
53 <para>Roles organize the permissions of various members of a project. Each member of a project has a one Role in a project. A user can have different roles in different projects.</para>
54 <para>On the new or edit Role screen, check off the actions authorized for the Role.</para>
55 </section>
56 <section>
57 <title>Trackers</title>
58 <para>Trackers allow the sorting of Issues and can define specific workflows.</para>
59 </section>
60 <section>
61 <title>Customized fields</title>
62 <para>Customized fields allow you to add additional information in Projects, Issues or Users. A customized field can be of one the following types:</para>
63 <itemizedlist>
64 <listitem>
65 <para>
66 <guilabel moreinfo="none">Integer</guilabel>
67 : positive or negative number
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 <guilabel moreinfo="none">String</guilabel>
73 : a string of characters - one single line of input.
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 <guilabel moreinfo="none">Text</guilabel>
79 : a string of characters with multiple lines of input. Differs from String Format by providing multiple lines of input instead of a single line.
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 <guilabel moreinfo="none">Date</guilabel>
85 : date
86 </para>
87 </listitem>
88 <listitem>
89 <para>
90 <guilabel moreinfo="none">Boolean</guilabel>
91 : true or false (check if necessary)
92 </para>
93 </listitem>
94 <listitem>
95 <para>
96 <guilabel moreinfo="none">List</guilabel>
97 : value to select from a predefined list (aka: scroll list or select box)
98 </para>
99 </listitem>
100 </itemizedlist>
101 <para>Validation elements can be defined:</para>
102 <itemizedlist>
103 <listitem>
104 <para>
105 <guilabel moreinfo="none">Required</guilabel>
106 : A required field must have input in the forms
107 </para>
108 </listitem>
109 <listitem>
110 <para>
111 <guilabel moreinfo="none">For all the projects</guilabel>
112 : field automatically associated to all of the projects
113 </para>
114 </listitem>
115 <listitem>
116 <para>
117 <guilabel moreinfo="none">Min - max length</guilabel>
118 : minimum and maximum length for the input fields (0 means that there is no restriction)
119 </para>
120 </listitem>
121 <listitem>
122 <para>
123 <guilabel moreinfo="none">Regular Expression</guilabel>
124 : regular expressions may provide validation of the input value
125 </para>
126 <para>Examples:</para>
127 <para>
128 <code>^\[A-Z]{4}\d+$</code>
129 : 4 capital letters followed by one or several digits
130 </para>
131 <para>
132 <code>^[^0-9]*$</code>
133 : characters only - no digits
134 </para>
135 </listitem>
136 <listitem>
137 <para>
138 <guilabel moreinfo="none">Possible values</guilabel>
139 : possible values for the fields of "List" type. Values are separated by the character |
140 </para>
141 </listitem>
142 </itemizedlist>
143 <para/>
144 <section>
145 <title>Fields for Projects</title>
146 <para/>
147 <itemizedlist>
148 <listitem>
149 <para>
150 <guilabel moreinfo="none">Required</guilabel>
151 : required field
152 </para>
153 </listitem>
154 </itemizedlist>
155 <para/>
156 </section>
157 <section>
158 <title>Fields for Issues</title>
159 <para/>
160 <itemizedlist>
161 <listitem>
162 <para>
163 <guilabel moreinfo="none">For all projects</guilabel>
164 : field automatically associated to all project Issues
165 </para>
166 <para>If this option is not activated, each project could choose whether or not to use the field for its Issues (please see the project configuration).</para>
167 </listitem>
168 </itemizedlist>
169 <para/>
170 </section>
171 <section>
172 <title>Field for Users</title>
173 <para/>
174 <itemizedlist>
175 <listitem>
176 <para>
177 <guilabel moreinfo="none">Required</guilabel>
178 : required field
179 </para>
180 </listitem>
181 </itemizedlist>
182 <para/>
183 </section>
184 </section>
185 <section>
186 <title>Issue status</title>
187 <para>These screens allow you to define the different possible Issue statuses.</para>
188 <itemizedlist>
189 <listitem>
190 <para>
191 <guilabel moreinfo="none">Closed</guilabel>
192 : indicates Issue is considered as closed
193 </para>
194 </listitem>
195 <listitem>
196 <para>
197 <guilabel moreinfo="none">Default</guilabel>
198 : status applied by default to new Issue requests (only one status can be Default status)
199 </para>
200 </listitem>
201 <listitem>
202 <para>
203 <guilabel moreinfo="none">Color</guilabel>
204 : HTML color code (6 characters) representing the displayed status
205 </para>
206 </listitem>
207 </itemizedlist>
208 <para/>
209 </section>
210 <section>
211 <title>Workflow</title>
212 <para>The workflow allows to define changes the various project members are allowed to make on the Issues, according to their type.</para>
213 <para>Select the role and the tracker for which you want to modify the workflow, then click Edit. The screen allows you then to modify the authorized change, for the chosen role and tracker. The Current Status options indicate the initial request status. The "New Statuses allowed" columns stand for the authorized status to apply.</para>
214 <para>
215 <remark>Note: In order for a particular Role to change an Issue status, the authorization must be given to it explicitly, regardless of the workflow configuration.</remark>
216 </para>
217 <para/>
218 <screenshot>
219 <screeninfo>Example of a workflow configuration</screeninfo>
220 <mediaobject>
221 <imageobject>
222 <imagedata fileref="images/workflow.png"/>
223 </imageobject>
224 </mediaobject>
225 </screenshot>
226 <para>In the above example, Bug type Issue requests with a New status could be given an Assigned or Resolved status by the Developer role. Those with an Assigned status could get a Resolved status. The status of all the other Bug type requests cannot be modified by the Developer.</para>
227 </section>
228 <section>
229 <title>Enumerations</title>
230 <para>The value lists used by the application can be customized (for example, setting Issue priorities). This screen allows you to define the possible values for each of the following lists:</para>
231 <itemizedlist>
232 <listitem>
233 <para>Issue Priorities</para>
234 </listitem>
235 <listitem>
236 <para>Document Categories</para>
237 </listitem>
238 </itemizedlist>
239 <para/>
240 </section>
241 <section>
242 <title>E-mail notifications</title>
243 <para>This screen allows you to select the actions that will generate an e-mail notification for project members.</para>
244 <para>Note: E-mail sending must be activated in the application configuration if you want to make any notifications.</para>
245 </section>
246 <section>
247 <title>Authentication</title>
248 <para>By default, redMine refers to its own database to authenticate users, by a specific password.</para>
249 <para>If you already have one or several external user references (like LDAP), you can make them known in order to be used for authentication on redMine. This allows users to access redMine with their usual user names and passwords.</para>
250 <para>For each known reference, you can specify if the accounts can be created on the fly on redMine. If needed, the user accounts will be created automatically during the user’s signing in (without any specific rights on the projects), according to information available in the reference. Otherwise, the administrator must have previously created the user account on redMine.</para>
251 <para/>
252 <section>
253 <title>LDAP statement</title>
254 <para/>
255 <itemizedlist>
256 <listitem>
257 <para>
258 <guilabel moreinfo="none">Name</guilabel>
259 : reference display name
260 </para>
261 </listitem>
262 <listitem>
263 <para>
264 <guilabel moreinfo="none">Host</guilabel>
265 : LDAP server host name
266 </para>
267 </listitem>
268 <listitem>
269 <para>
270 <guilabel moreinfo="none">Port</guilabel>
271 : connection port to the LDAP server
272 </para>
273 </listitem>
274 <listitem>
275 <para>
276 <guilabel moreinfo="none">Account</guilabel>
277 : DN of the connection account to LDAP (please leave it blank if the directory authorizes anonymous read access)
278 </para>
279 </listitem>
280 <listitem>
281 <para>
282 <guilabel moreinfo="none">Password</guilabel>
283 : password of the connection account
284 </para>
285 </listitem>
286 <listitem>
287 <para>
288 <guilabel moreinfo="none">Base DN</guilabel>
289 : Basic DN used for user search in the directory
290 </para>
291 </listitem>
292 <listitem>
293 <para>
294 <guilabel moreinfo="none">LDAP screen</guilabel>
295 : User search screen in the directory (optional)
296 </para>
297 </listitem>
298 <listitem>
299 <para>
300 <guilabel moreinfo="none">LDAP features</guilabel>
301 :
302 </para>
303 <itemizedlist>
304 <listitem>
305 <para>
306 <guilabel moreinfo="none">Identifier</guilabel>
307 : LDAP feature name used as user identifier (e.g.: uid)
308 </para>
309 </listitem>
310 <listitem>
311 <para>
312 <guilabel moreinfo="none">First name</guilabel>
313 : LDAP feature name including the user’s first name (ex: givenName)
314 </para>
315 </listitem>
316 <listitem>
317 <para>
318 <guilabel moreinfo="none">Last name</guilabel>
319 : LDAP feature name including the user’s last name (ex: familyName)
320 </para>
321 </listitem>
322 <listitem>
323 <para>
324 <guilabel moreinfo="none">E-mail</guilabel>
325 : LDAP feature name including the user’s e-mail address (ex: mail)
326 </para>
327 </listitem>
328 </itemizedlist>
329 </listitem>
330 </itemizedlist>
331 <para>
332 The features"
333 <guilabel moreinfo="none">First name</guilabel>
334 ", "
335 <guilabel moreinfo="none">Last name</guilabel>
336 " and "
337 <guilabel moreinfo="none">E-mail</guilabel>
338 " are not used except when the accounts are created on the fly.
339 </para>
340 </section>
341 </section>
342 <section>
343 <title>Information</title>
344 <para>Displays application and environment information.</para>
345 </section>
346 </chapter>
347 <chapter>
348 <title>Projects</title>
349 <section>
350 <title>Project preview</title>
351 <para>The preview presents the general project information, its main members, the latest announcements, as well as an synthesis of Issue requests open by tracker.</para>
352 <para/>
353 </section>
354 <section>
355 <title>Issue management</title>
356 <para/>
357 <section>
358 <title>Issue list</title>
359 <para>By default, the entire list of the project open Issues are displayed. Various screens allow you to select the Issues to be displayed. If the project has sub-projects, you have the possibility to display the sub-project's Issues as well (not displayed by default).</para>
360 <para>Once applied, a screen is valid during the entire session. You can re-define it or delete it by clicking Cancel.</para>
361 <para/>
362 <screenshot>
363 <screeninfo>Request list</screeninfo>
364 <mediaobject>
365 <imageobject>
366 <imagedata fileref="images/issues_list.png"/>
367 </imageobject>
368 </mediaobject>
369 </screenshot>
370 <para/>
371 </section>
372 </section>
373 <section>
374 <title>Reports</title>
375 <para>This screen presents the number of Issues and Issue status synthesis according to various criteria (tracker, priority, category). Direct links allow for access to the detailed Issue list for each criterion.</para>
376 </section>
377 <section>
378 <title>Change log</title>
379 <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>
380 </section>
381 <section>
382 <title>News</title>
383 <para>Allows you to inform users on project activity.</para>
384 </section>
385 <section>
386 <title>Documents</title>
387 <para>Documents are grouped by categories (see Value Lists). A document can contain several files (for example: revisions or successive versions).</para>
388 </section>
389 <section>
390 <title>Files</title>
391 <para>This module allows you to display various folders (sources, binaires, ...) for each version of the application.</para>
392 </section>
393 <section>
394 <title>Settings</title>
395 <para/>
396 <section>
397 <title>Project features</title>
398 <para/>
399 <itemizedlist>
400 <listitem>
401 <para>
402 <guilabel moreinfo="none">Public</guilabel>
403 : 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.
404 </para>
405 </listitem>
406 <listitem>
407 <para>
408 <guilabel moreinfo="none">Customized fields</guilabel>
409 : Select the customized fields that you want to use. Only the administrator can define new customized fields.
410 </para>
411 </listitem>
412 </itemizedlist>
413 <para/>
414 </section>
415 <section>
416 <title>Members</title>
417 <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>
418 </section>
419 <section>
420 <title>Versions</title>
421 <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>
422 </section>
423 <section>
424 <title>Request categories</title>
425 <para>Issue categories allow you to organize Issues. Categories can correspond to different project modules.</para>
426 </section>
427 </section>
428 </chapter>
429 </book> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>Chapter&nbsp;1.&nbsp;Administration</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="index.html" title="RedMine Documentation"><link rel="prev" href="index.html" title="RedMine Documentation"><link rel="next" href="ch01s01.html" title="1.&nbsp;Users"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;1.&nbsp;Administration</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s01.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e4"></a>Chapter&nbsp;1.&nbsp;Administration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch01s01.html">1. Users</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s01.html#d0e12">1.1. Users&#8217; List</a></span></dt><dt><span class="section"><a href="ch01s01.html#d0e26">1.2. User Creation or Modification</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s02.html">2. Roles and Permissions</a></span></dt><dt><span class="section"><a href="ch01s03.html">3. Trackers</a></span></dt><dt><span class="section"><a href="ch01s04.html">4. Customized fields</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s04.html#d0e137">4.1. Fields for Projects</a></span></dt><dt><span class="section"><a href="ch01s04.html#d0e148">4.2. Fields for Issues</a></span></dt><dt><span class="section"><a href="ch01s04.html#d0e161">4.3. Field for Users</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s05.html">5. Issue status</a></span></dt><dt><span class="section"><a href="ch01s06.html">6. Workflow</a></span></dt><dt><span class="section"><a href="ch01s07.html">7. Enumerations</a></span></dt><dt><span class="section"><a href="ch01s08.html">8. E-mail notifications</a></span></dt><dt><span class="section"><a href="ch01s09.html">9. Authentication</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s09.html#d0e243">9.1. LDAP statement</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s10.html">10. Information</a></span></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">RedMine Documentation&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;1.&nbsp;Users</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>1.&nbsp;Users</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="next" href="ch01s02.html" title="2.&nbsp;Roles and Permissions"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.&nbsp;Users</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s02.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e7"></a>1.&nbsp;Users</h2></div></div></div><p>These screens allow you to manage the application users.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e12"></a>1.1.&nbsp;Users&#8217; List</h3></div></div></div><p></p><div class="screenshot"><div class="mediaobject"><img src="resources/users_list.png"></div></div><p>The Lock/Unlock buttons allow you to lock/unlock the user accounts.</p><p>A user having a locked account cannot log in and access the application.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e26"></a>1.2.&nbsp;User Creation or Modification</h3></div></div></div><p>In modification mode, please leave the Password field blank in order to keep the user&#8217;s password unchanged.</p><p>A user designated as administrator has unrestricted access to the application and to all projects.</p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Administrator</span> : designate the user as the administrator of the application.</p></li><li><p><span class="guilabel">E-mail notifications</span> : activate or de-activate automatic e-mail notifications for this user</p></li><li><p><span class="guilabel">Locked</span> : de-activates the user&#8217;s account</p></li></ul></div><p></p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;1.&nbsp;Administration&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;2.&nbsp;Roles and Permissions</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>2.&nbsp;Roles and Permissions</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s01.html" title="1.&nbsp;Users"><link rel="next" href="ch01s03.html" title="3.&nbsp;Trackers"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.&nbsp;Roles and Permissions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s01.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s03.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e50"></a>2.&nbsp;Roles and Permissions</h2></div></div></div><p>Roles organize the permissions of various members of a project. Each member of a project has a one Role in a project. A user can have different roles in different projects.</p><p>On the new or edit Role screen, check off the actions authorized for the Role.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s01.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">1.&nbsp;Users&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;3.&nbsp;Trackers</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>3.&nbsp;Trackers</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s02.html" title="2.&nbsp;Roles and Permissions"><link rel="next" href="ch01s04.html" title="4.&nbsp;Customized fields"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.&nbsp;Trackers</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s02.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s04.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e57"></a>3.&nbsp;Trackers</h2></div></div></div><p>Trackers allow the sorting of Issues and can define specific workflows.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s02.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.&nbsp;Roles and Permissions&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;4.&nbsp;Customized fields</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>4.&nbsp;Customized fields</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s03.html" title="3.&nbsp;Trackers"><link rel="next" href="ch01s05.html" title="5.&nbsp;Issue status"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.&nbsp;Customized fields</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s03.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s05.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e62"></a>4.&nbsp;Customized fields</h2></div></div></div><p>Customized fields allow you to add additional information in Projects, Issues or Users. A customized field can be of one the following types:</p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Integer</span> : positive or negative number</p></li><li><p><span class="guilabel">String</span> : a string of characters - one single line of input.</p></li><li><p><span class="guilabel">Text</span> : a string of characters with multiple lines of input. Differs from String Format by providing multiple lines of input instead of a single line.</p></li><li><p><span class="guilabel">Date</span> : date</p></li><li><p><span class="guilabel">Boolean</span> : true or false (check if necessary)</p></li><li><p><span class="guilabel">List</span> : value to select from a predefined list (aka: scroll list or select box)</p></li></ul></div><p>Validation elements can be defined:</p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Required</span> : A required field must have input in the forms</p></li><li><p><span class="guilabel">For all the projects</span> : field automatically associated to all of the projects</p></li><li><p><span class="guilabel">Min - max length</span> : minimum and maximum length for the input fields (0 means that there is no restriction)</p></li><li><p><span class="guilabel">Regular Expression</span> : regular expressions may provide validation of the input value</p><p>Examples:</p><p><code class="code">^\[A-Z]{4}\d+$</code> : 4 capital letters followed by one or several digits</p><p><code class="code">^[^0-9]*$</code> : characters only - no digits</p></li><li><p><span class="guilabel">Possible values</span> : possible values for the fields of "List" type. Values are separated by the character |</p></li></ul></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e137"></a>4.1.&nbsp;Fields for Projects</h3></div></div></div><p></p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Required</span> : required field</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e148"></a>4.2.&nbsp;Fields for Issues</h3></div></div></div><p></p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">For all projects</span> : field automatically associated to all project Issues</p><p>If this option is not activated, each project could choose whether or not to use the field for its Issues (please see the project configuration).</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e161"></a>4.3.&nbsp;Field for Users</h3></div></div></div><p></p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Required</span> : required field</p></li></ul></div><p></p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s03.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.&nbsp;Trackers&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;5.&nbsp;Issue status</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>5.&nbsp;Issue status</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s04.html" title="4.&nbsp;Customized fields"><link rel="next" href="ch01s06.html" title="6.&nbsp;Workflow"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.&nbsp;Issue status</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s04.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s06.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e172"></a>5.&nbsp;Issue status</h2></div></div></div><p>These screens allow you to define the different possible Issue statuses.</p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Closed</span> : indicates Issue is considered as closed</p></li><li><p><span class="guilabel">Default</span> : status applied by default to new Issue requests (only one status can be Default status)</p></li><li><p><span class="guilabel">Color</span> : HTML color code (6 characters) representing the displayed status</p></li></ul></div><p></p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s04.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.&nbsp;Customized fields&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;6.&nbsp;Workflow</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>6.&nbsp;Workflow</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s05.html" title="5.&nbsp;Issue status"><link rel="next" href="ch01s07.html" title="7.&nbsp;Enumerations"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.&nbsp;Workflow</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s05.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s07.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e194"></a>6.&nbsp;Workflow</h2></div></div></div><p>The workflow allows to define changes the various project members are allowed to make on the Issues, according to their type.</p><p>Select the role and the tracker for which you want to modify the workflow, then click Edit. The screen allows you then to modify the authorized change, for the chosen role and tracker. The Current Status options indicate the initial request status. The "New Statuses allowed" columns stand for the authorized status to apply.</p><p><em><span class="remark">Note: In order for a particular Role to change an Issue status, the authorization must be given to it explicitly, regardless of the workflow configuration.</span></em></p><p></p><div class="screenshot"><div class="mediaobject"><img src="resources/workflow.png"></div></div><p>In the above example, Bug type Issue requests with a New status could be given an Assigned or Resolved status by the Developer role. Those with an Assigned status could get a Resolved status. The status of all the other Bug type requests cannot be modified by the Developer.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s05.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.&nbsp;Issue status&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;7.&nbsp;Enumerations</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>7.&nbsp;Enumerations</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s06.html" title="6.&nbsp;Workflow"><link rel="next" href="ch01s08.html" title="8.&nbsp;E-mail notifications"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.&nbsp;Enumerations</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s06.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s08.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e213"></a>7.&nbsp;Enumerations</h2></div></div></div><p>The value lists used by the application can be customized (for example, setting Issue priorities). This screen allows you to define the possible values for each of the following lists:</p><div class="itemizedlist"><ul type="disc"><li><p>Issue Priorities</p></li><li><p>Document Categories</p></li></ul></div><p></p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s06.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s08.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.&nbsp;Workflow&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;8.&nbsp;E-mail notifications</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>8.&nbsp;E-mail notifications</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s07.html" title="7.&nbsp;Enumerations"><link rel="next" href="ch01s09.html" title="9.&nbsp;Authentication"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.&nbsp;E-mail notifications</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s07.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s09.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e226"></a>8.&nbsp;E-mail notifications</h2></div></div></div><p>This screen allows you to select the actions that will generate an e-mail notification for project members.</p><p>Note: E-mail sending must be activated in the application configuration if you want to make any notifications.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s07.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s09.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">7.&nbsp;Enumerations&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;9.&nbsp;Authentication</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>9.&nbsp;Authentication</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s08.html" title="8.&nbsp;E-mail notifications"><link rel="next" href="ch01s10.html" title="10.&nbsp;Information"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">9.&nbsp;Authentication</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s08.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01s10.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e233"></a>9.&nbsp;Authentication</h2></div></div></div><p>By default, redMine refers to its own database to authenticate users, by a specific password.</p><p>If you already have one or several external user references (like LDAP), you can make them known in order to be used for authentication on redMine. This allows users to access redMine with their usual user names and passwords.</p><p>For each known reference, you can specify if the accounts can be created on the fly on redMine. If needed, the user accounts will be created automatically during the user&#8217;s signing in (without any specific rights on the projects), according to information available in the reference. Otherwise, the administrator must have previously created the user account on redMine.</p><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e243"></a>9.1.&nbsp;LDAP statement</h3></div></div></div><p></p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Name</span> : reference display name</p></li><li><p><span class="guilabel">Host</span> : LDAP server host name</p></li><li><p><span class="guilabel">Port</span> : connection port to the LDAP server</p></li><li><p><span class="guilabel">Account</span> : DN of the connection account to LDAP (please leave it blank if the directory authorizes anonymous read access)</p></li><li><p><span class="guilabel">Password</span> : password of the connection account</p></li><li><p><span class="guilabel">Base DN</span> : Basic DN used for user search in the directory</p></li><li><p><span class="guilabel">LDAP screen</span> : User search screen in the directory (optional)</p></li><li><p><span class="guilabel">LDAP features</span> :</p><div class="itemizedlist"><ul type="circle"><li><p><span class="guilabel">Identifier</span> : LDAP feature name used as user identifier (e.g.: uid)</p></li><li><p><span class="guilabel">First name</span> : LDAP feature name including the user&#8217;s first name (ex: givenName)</p></li><li><p><span class="guilabel">Last name</span> : LDAP feature name including the user&#8217;s last name (ex: familyName)</p></li><li><p><span class="guilabel">E-mail</span> : LDAP feature name including the user&#8217;s e-mail address (ex: mail)</p></li></ul></div></li></ul></div><p>The features" <span class="guilabel">First name</span> ", " <span class="guilabel">Last name</span> " and " <span class="guilabel">E-mail</span> " are not used except when the accounts are created on the fly.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s08.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01s10.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">8.&nbsp;E-mail notifications&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;10.&nbsp;Information</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>10.&nbsp;Information</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"><link rel="prev" href="ch01s09.html" title="9.&nbsp;Authentication"><link rel="next" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">10.&nbsp;Information</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s09.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;1.&nbsp;Administration</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e320"></a>10.&nbsp;Information</h2></div></div></div><p>Displays application and environment information.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s09.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch01.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">9.&nbsp;Authentication&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;2.&nbsp;Projects</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>Chapter&nbsp;2.&nbsp;Projects</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="index.html" title="RedMine Documentation"><link rel="prev" href="ch01s10.html" title="10.&nbsp;Information"><link rel="next" href="ch02s01.html" title="1.&nbsp;Project preview"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;2.&nbsp;Projects</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01s10.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s01.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e325"></a>Chapter&nbsp;2.&nbsp;Projects</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch02s01.html">1. Project preview</a></span></dt><dt><span class="section"><a href="ch02s02.html">2. Issue management</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s02.html#d0e338">2.1. Issue list</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s03.html">3. Reports</a></span></dt><dt><span class="section"><a href="ch02s04.html">4. Change log</a></span></dt><dt><span class="section"><a href="ch02s05.html">5. News</a></span></dt><dt><span class="section"><a href="ch02s06.html">6. Documents</a></span></dt><dt><span class="section"><a href="ch02s07.html">7. Files</a></span></dt><dt><span class="section"><a href="ch02s08.html">8. Settings</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s08.html#d0e382">8.1. Project features</a></span></dt><dt><span class="section"><a href="ch02s08.html#d0e398">8.2. Members</a></span></dt><dt><span class="section"><a href="ch02s08.html#d0e403">8.3. Versions</a></span></dt><dt><span class="section"><a href="ch02s08.html#d0e408">8.4. Request categories</a></span></dt></dl></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01s10.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">10.&nbsp;Information&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;1.&nbsp;Project preview</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>1.&nbsp;Project preview</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="next" href="ch02s02.html" title="2.&nbsp;Issue management"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.&nbsp;Project preview</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s02.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e328"></a>1.&nbsp;Project preview</h2></div></div></div><p>The preview presents the general project information, its main members, the latest announcements, as well as an synthesis of Issue requests open by tracker.</p><p></p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;2.&nbsp;Projects&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;2.&nbsp;Issue management</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>2.&nbsp;Issue management</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s01.html" title="1.&nbsp;Project preview"><link rel="next" href="ch02s03.html" title="3.&nbsp;Reports"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.&nbsp;Issue management</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s01.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s03.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e334"></a>2.&nbsp;Issue management</h2></div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e338"></a>2.1.&nbsp;Issue list</h3></div></div></div><p>By default, the entire list of the project open Issues are displayed. Various screens allow you to select the Issues to be displayed. If the project has sub-projects, you have the possibility to display the sub-project's Issues as well (not displayed by default).</p><p>Once applied, a screen is valid during the entire session. You can re-define it or delete it by clicking Cancel.</p><p></p><div class="screenshot"><div class="mediaobject"><img src="resources/issues_list.png"></div></div><p></p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s01.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">1.&nbsp;Project preview&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;3.&nbsp;Reports</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>3.&nbsp;Reports</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s02.html" title="2.&nbsp;Issue management"><link rel="next" href="ch02s04.html" title="4.&nbsp;Change log"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">3.&nbsp;Reports</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s04.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e353"></a>3.&nbsp;Reports</h2></div></div></div><p>This screen presents the number of Issues and Issue status synthesis according to various criteria (tracker, priority, category). Direct links allow for access to the detailed Issue list for each criterion.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s02.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">2.&nbsp;Issue management&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;4.&nbsp;Change log</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>4.&nbsp;Change log</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s03.html" title="3.&nbsp;Reports"><link rel="next" href="ch02s05.html" title="5.&nbsp;News"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">4.&nbsp;Change log</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s03.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s05.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e358"></a>4.&nbsp;Change log</h2></div></div></div><p>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.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s03.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">3.&nbsp;Reports&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;5.&nbsp;News</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>5.&nbsp;News</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s04.html" title="4.&nbsp;Change log"><link rel="next" href="ch02s06.html" title="6.&nbsp;Documents"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5.&nbsp;News</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s04.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s06.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e363"></a>5.&nbsp;News</h2></div></div></div><p>Allows you to inform users on project activity.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s04.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4.&nbsp;Change log&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;6.&nbsp;Documents</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>6.&nbsp;Documents</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s05.html" title="5.&nbsp;News"><link rel="next" href="ch02s07.html" title="7.&nbsp;Files"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">6.&nbsp;Documents</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s05.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s07.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e368"></a>6.&nbsp;Documents</h2></div></div></div><p>Documents are grouped by categories (see Value Lists). A document can contain several files (for example: revisions or successive versions).</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s05.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">5.&nbsp;News&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;7.&nbsp;Files</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>7.&nbsp;Files</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s06.html" title="6.&nbsp;Documents"><link rel="next" href="ch02s08.html" title="8.&nbsp;Settings"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.&nbsp;Files</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s06.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02s08.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e373"></a>7.&nbsp;Files</h2></div></div></div><p>This module allows you to display various folders (sources, binaires, ...) for each version of the application.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s06.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02s08.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">6.&nbsp;Documents&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;8.&nbsp;Settings</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>8.&nbsp;Settings</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="up" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Projects"><link rel="prev" href="ch02s07.html" title="7.&nbsp;Files"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8.&nbsp;Settings</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02s07.html">Prev</a>&nbsp;</td><th width="60%" align="center">Chapter&nbsp;2.&nbsp;Projects</th><td width="20%" align="right">&nbsp;</td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e378"></a>8.&nbsp;Settings</h2></div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e382"></a>8.1.&nbsp;Project features</h3></div></div></div><p></p><div class="itemizedlist"><ul type="disc"><li><p><span class="guilabel">Public</span> : if it&#8217;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&#8217;s not a public project, only the project members have access to it, according to their role.</p></li><li><p><span class="guilabel">Customized fields</span> : Select the customized fields that you want to use. Only the administrator can define new customized fields.</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e398"></a>8.2.&nbsp;Members</h3></div></div></div><p>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.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e403"></a>8.3.&nbsp;Versions</h3></div></div></div><p>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).</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e408"></a>8.4.&nbsp;Request categories</h3></div></div></div><p>Issue categories allow you to organize Issues. Categories can correspond to different project modules.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02s07.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch02.html">Up</a></td><td width="40%" align="right">&nbsp;</td></tr><tr><td width="40%" align="left" valign="top">7.&nbsp;Files&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html> No newline at end of file
@@ -0,0 +1,55
1 body {
2 background: #FFFFFF;
3 font: 0.8em Verdana,Tahoma,Arial,sans-serif;
4 }
5
6 h1, h2, h3, h4, h5 {
7 color: #800000;
8 font-family: sans-serif;
9 }
10
11 table {
12 font-size: 1em;
13 }
14
15 a{
16 color:#467aa7;
17 font-weight:bold;
18 text-decoration:none;
19 background-color:inherit;
20 }
21
22 a:hover{
23 color: #800000;
24 text-decoration:underline;
25 background-color:inherit;
26 }
27
28 a img{border:none;}
29
30 .screenshot {
31 text-align: center;
32 }
33
34 .guilabel {
35 font-weight: bold;
36 }
37
38 span.term {
39 font-weight: bold;
40 }
41
42 div.sidebar {
43 background: #F0F0F0;
44 border: 1px solid gray;
45 padding: 5px;
46 margin: 20px;
47 }
48
49 pre.programlisting {
50 background: #F0F0F0;
51 border: 1px solid gray;
52 padding: 2px;
53 font-size: 10pt;
54 white-space: pre;
55 }
@@ -0,0 +1,3
1 <html><head>
2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3 <title>RedMine Documentation</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"><link rel="start" href="index.html" title="RedMine Documentation"><link rel="next" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Administration"></head><body><a href="http://redmine.rubyforge.org/">redMine home</a><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">RedMine Documentation</th></tr><tr><td width="20%" align="left">&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>RedMine Documentation</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Administration</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s01.html">1. Users</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s01.html#d0e12">1.1. Users&#8217; List</a></span></dt><dt><span class="section"><a href="ch01s01.html#d0e26">1.2. User Creation or Modification</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s02.html">2. Roles and Permissions</a></span></dt><dt><span class="section"><a href="ch01s03.html">3. Trackers</a></span></dt><dt><span class="section"><a href="ch01s04.html">4. Customized fields</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s04.html#d0e137">4.1. Fields for Projects</a></span></dt><dt><span class="section"><a href="ch01s04.html#d0e148">4.2. Fields for Issues</a></span></dt><dt><span class="section"><a href="ch01s04.html#d0e161">4.3. Field for Users</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s05.html">5. Issue status</a></span></dt><dt><span class="section"><a href="ch01s06.html">6. Workflow</a></span></dt><dt><span class="section"><a href="ch01s07.html">7. Enumerations</a></span></dt><dt><span class="section"><a href="ch01s08.html">8. E-mail notifications</a></span></dt><dt><span class="section"><a href="ch01s09.html">9. Authentication</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s09.html#d0e243">9.1. LDAP statement</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s10.html">10. Information</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch02.html">2. Projects</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s01.html">1. Project preview</a></span></dt><dt><span class="section"><a href="ch02s02.html">2. Issue management</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s02.html#d0e338">2.1. Issue list</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s03.html">3. Reports</a></span></dt><dt><span class="section"><a href="ch02s04.html">4. Change log</a></span></dt><dt><span class="section"><a href="ch02s05.html">5. News</a></span></dt><dt><span class="section"><a href="ch02s06.html">6. Documents</a></span></dt><dt><span class="section"><a href="ch02s07.html">7. Files</a></span></dt><dt><span class="section"><a href="ch02s08.html">8. Settings</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s08.html#d0e382">8.1. Project features</a></span></dt><dt><span class="section"><a href="ch02s08.html#d0e398">8.2. Members</a></span></dt><dt><span class="section"><a href="ch02s08.html#d0e403">8.3. Versions</a></span></dt><dt><span class="section"><a href="ch02s08.html#d0e408">8.4. Request categories</a></span></dt></dl></dd></dl></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left">&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;1.&nbsp;Administration</td></tr></table></div></body></html> No newline at end of file
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
@@ -1,47 +1,47
1 # redMine - project management software
1 # redMine - project management software
2 # Copyright (C) 2006 Jean-Philippe Lang
2 # Copyright (C) 2006 Jean-Philippe Lang
3 #
3 #
4 # This program is free software; you can redistribute it and/or
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
7 # of the License, or (at your option) any later version.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU General Public License
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17
17
18 class HelpController < ApplicationController
18 class HelpController < ApplicationController
19
19
20 skip_before_filter :check_if_login_required
20 skip_before_filter :check_if_login_required
21 before_filter :load_help_config
21 before_filter :load_help_config
22
22
23 # displays help page for the requested controller/action
23 # displays help page for the requested controller/action
24 def index
24 def index
25 # select help page to display
25 # select help page to display
26 if @params[:ctrl] and @help_config['pages'][@params[:ctrl]]
26 if @params[:ctrl] and @help_config['pages'][@params[:ctrl]]
27 if @params[:page] and @help_config['pages'][@params[:ctrl]][@params[:page]]
27 if @params[:page] and @help_config['pages'][@params[:ctrl]][@params[:page]]
28 template = @help_config['pages'][@params[:ctrl]][@params[:page]]
28 template = @help_config['pages'][@params[:ctrl]][@params[:page]]
29 else
29 else
30 template = @help_config['pages'][@params[:ctrl]]['index']
30 template = @help_config['pages'][@params[:ctrl]]['index']
31 end
31 end
32 end
32 end
33 # choose language according to available help translations
33 # choose language according to available help translations
34 lang = (@help_config['langs'].include? current_language) ? current_language : @help_config['langs'].first
34 lang = (@help_config['langs'].include? current_language.to_s) ? current_language.to_s : @help_config['langs'].first
35
35
36 if template
36 if template
37 redirect_to "/manual/#{lang}/#{template}"
37 redirect_to "/manual/#{lang}/#{template}"
38 else
38 else
39 redirect_to "/manual/#{lang}/"
39 redirect_to "/manual/#{lang}/"
40 end
40 end
41 end
41 end
42
42
43 private
43 private
44 def load_help_config
44 def load_help_config
45 @help_config = YAML::load(File.open("#{RAILS_ROOT}/config/help.yml"))
45 @help_config = YAML::load(File.open("#{RAILS_ROOT}/config/help.yml"))
46 end
46 end
47 end
47 end
@@ -1,62 +1,63
1 # redMine - project management software
1 # redMine - project management software
2 # Copyright (C) 2006 Jean-Philippe Lang
2 # Copyright (C) 2006 Jean-Philippe Lang
3 #
3 #
4 # This program is free software; you can redistribute it and/or
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
7 # of the License, or (at your option) any later version.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU General Public License
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17
17
18 # available languages for help pages
18 # available languages for help pages
19 langs:
19 langs:
20 - en
20 - fr
21 - fr
21
22
22 # mapping between controller/action and help pages
23 # mapping between controller/action and help pages
23 # if action is not defined here, 'index' page will be displayed
24 # if action is not defined here, 'index' page will be displayed
24 pages:
25 pages:
25 # administration
26 # administration
26 admin:
27 admin:
27 index: ch01.html
28 index: ch01.html
28 mail_options: ch01s08.html
29 mail_options: ch01s08.html
29 info: ch01s09.html
30 info: ch01s09.html
30 users:
31 users:
31 index: ch01s01.html
32 index: ch01s01.html
32 roles:
33 roles:
33 index: ch01s02.html
34 index: ch01s02.html
34 workflow: ch01s06.html
35 workflow: ch01s06.html
35 trackers:
36 trackers:
36 index: ch01s03.html
37 index: ch01s03.html
37 issue_statuses:
38 issue_statuses:
38 index: ch01s05.html
39 index: ch01s05.html
39 # projects
40 # projects
40 projects:
41 projects:
41 index: ch02.html
42 index: ch02.html
42 add: ch02s08.html
43 add: ch02s08.html
43 show: ch02s01.html
44 show: ch02s01.html
44 add_document: ch02s06.html
45 add_document: ch02s06.html
45 list_documents: ch02s06.html
46 list_documents: ch02s06.html
46 add_issue: ch02s02.html
47 add_issue: ch02s02.html
47 list_issues: ch02s02.html
48 list_issues: ch02s02.html
48 add_news: ch02s05.html
49 add_news: ch02s05.html
49 list_news: ch02s05.html
50 list_news: ch02s05.html
50 add_file: ch02s07.html
51 add_file: ch02s07.html
51 list_files: ch02s07.html
52 list_files: ch02s07.html
52 changelog: ch02s04.html
53 changelog: ch02s04.html
53 issues:
54 issues:
54 index: ch02s02.html
55 index: ch02s02.html
55 documents:
56 documents:
56 index: ch02s06.html
57 index: ch02s06.html
57 news:
58 news:
58 index: ch02s05.html
59 index: ch02s05.html
59 versions:
60 versions:
60 index: ch02s08.html
61 index: ch02s08.html
61 reports:
62 reports:
62 index: ch02s03.html No newline at end of file
63 index: ch02s03.html
General Comments 0
You need to be logged in to leave comments. Login now