dinislage/redmine
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SCM branch

Browse Source 
git-svn-id: http://redmine.rubyforge.org/svn/branches/work@101 e93f8b46-1217-0410-a6f0-8f06a7374b81
This commit is contained in:
Jean-Philippe Lang committed 2006-12-18 17:24:21 +00:00
1 parent e0ee6a17fc
commit fa820c0224
494 files changed
+36449
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

scm/doc/CHANGELOG
+100
View File
@@ -0,0 +1,100 @@
== redMine changelog
redMine - project management software
Copyright (C) 2006 Jean-Philippe Lang
http://redmine.org/
== xx/xx/2006 v0.x.x
* comments can now be added on news
* "my page" is now customizable
* more powerfull and savable filters for issues lists
* improved issues change history
* new functionality: move an issue to another project or tracker
* new functionality: add a note to an issue
* new report: project activity
* "start date" and "% done" fields added on issues
* project calendar added
* gantt chart added (exportable to pdf)
* single/multiple issues pdf export added
* issues reports improvements
* multiple file upload for issues attachments
* textile formating of issue and news descritions (RedCloth required)
* integration of DotClear jstoolbar for textile formatting
* calendar date picker for date fields (LGPL DHTML Calendar http://sourceforge.net/projects/jscalendar)
* new filter in issues list: Author
* ajaxified paginators
* option to set number of results per page on issues list
* localized csv separator (comma/semicolon)
* csv output encoded to ISO-8859-1
* user custom field displayed on account/show
* default configuration improved (default roles, trackers, status, permissions and workflows)
* javascript added on custom field form to show/hide fields according to the format of custom field
* fixed: custom fields not in csv exports
* fixed: project settings now displayed according to user's permissions
* fixed: application error when no version is selected on projects/add_file
== 10/08/2006 v0.3.0
* user authentication against multiple LDAP (optional)
* token based "lost password" functionality
* user self-registration functionality (optional)
* custom fields now available for issues, users and projects
* new custom field format "text" (displayed as a textarea field)
* project & administration drop down menus in navigation bar for quicker access
* text formatting is preserved for long text fields (issues, projects and news descriptions)
* urls and emails are turned into clickable links in long text fields
* "due date" field added on issues
* tracker selection filter added on change log
* Localization plugin replaced with GLoc 1.1.0 (iconv required)
* error messages internationalization
* german translation added (thanks to Karim Trott)
* data locking for issues to prevent update conflicts (using ActiveRecord builtin optimistic locking)
* new filter in issues list: "Fixed version"
* active filters are displayed with colored background on issues list
* custom configuration is now defined in config/config_custom.rb
* user object no more stored in session (only user_id)
* news summary field is no longer required
* tables and forms redesign
* Fixed: boolean custom field not working
* Fixed: error messages for custom fields are not displayed
* Fixed: invalid custom fields should have a red border
* Fixed: custom fields values are not validated on issue update
* Fixed: unable to choose an empty value for 'List' custom fields
* Fixed: no issue categories sorting
* Fixed: incorrect versions sorting
== 07/12/2006 - v0.2.2
* Fixed: bug in "issues list"
== 07/09/2006 - v0.2.1
* new databases supported: Oracle, PostgreSQL, SQL Server
* projects/subprojects hierarchy (1 level of subprojects only)
* environment information display in admin/info
* more filter options in issues list (rev6)
* default language based on browser settings (Accept-Language HTTP header)
* issues list exportable to CSV (rev6)
* simple_format and auto_link on long text fields
* more data validations
* Fixed: error when all mail notifications are unchecked in admin/mail_options
* Fixed: all project news are displayed on project summary
* Fixed: Can't change user password in users/edit
* Fixed: Error on tables creation with PostgreSQL (rev5)
* Fixed: SQL error in "issue reports" view with PostgreSQL (rev5)
== 06/25/2006 - v0.1.0
* multiple users/multiple projects
* role based access control
* issue tracking system
* fully customizable workflow
* documents/files repository
* email notifications on issue creation and update
* multilanguage support (except for error messages):english, french, spanish
* online manual in french (unfinished)
scm/doc/COPYING
+339
View File
@@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
scm/doc/INSTALL
+74
View File
@@ -0,0 +1,74 @@
== redMine installation
redMine - project management software
Copyright (C) 2006 Jean-Philippe Lang
http://redmine.org/
== Requirements
* Ruby on Rails 1.1
* Iconv
* a database (see compatibility below)
* (recommended) Apache/Lighttpd with FCGI support
Optional:
* RedCloth (for textile formatting)
* Net::LDAP for Ruby (for LDAP authentication)
Supported databases:
* MySQL (tested with MySQL 5)
* PostgreSQL (tested with PostgreSQL 8.1)
* Oracle (tested with Oracle 10g)
* SQL Server (tested with SQL Server 2005)
* SQLite (tested with SQLite 3)
== Upgrade
Due to major database changes, there is no migration support from beta 0.2.0.
Next releases (0.3.0+) will be provided with upgrade support.
== Installation
1. Uncompress program archive:
tar zxvf <filename>
2. Create an empty database: "redmine" for example
3. Configure database parameters in config/database.yml
for "production" environment (default database is MySQL)
4. Create the database structure. Under application main directory:
rake migrate RAILS_ENV="production"
It will create tables and default configuration data
5. Insert default configuration data in database:
rake load_default_data RAILS_ENV="production"
This step is optional, as you can define your own configuration
(roles, trackers, statuses, workflows, enumerations) from sratch
6. Test the installation by running WEBrick web server:
ruby script/server -e production
Once WEBrick has started, point your browser to http://localhost:3000/
You should now see the application welcome page
7. Use default administrator account to log in:
login: admin
password: admin
8. Setup Apache or Lighttpd with fastcgi for best performance.
== Configuration
A sample configuration file is provided: "config/config_custom.example.rb"
Rename it to config_custom.rb and edit parameters.
Don't forget to restart the application after any change.
config.action_mailer.server_settings: SMTP server configuration
config.action_mailer.perform_deliveries: set to false to disable mail delivering
scm/doc/README
+58
View File
@@ -0,0 +1,58 @@
== redMine
redMine - project management software
Copyright (C) 2006 Jean-Philippe Lang
http://redmine.org/
== License
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
== Main features
redMine is a project management software written using Ruby on Rails.
* multiple users/projects
* fully customizable role based access control
* issue tracking system
* fully customizable workflow
* documents/files repository
* email notifications
* custom fields for projects, users and issues
* multilanguage support
* multiple LDAP authentication support
* user self-registration support
== User documentation
User documentation for redMine is written using DocBook XML format.
It's also avaible as HTML files in /public/manual (contextual help)
== Versioning
redMine versioning scheme is major.minor.revision
Versions before 1.0.0 must be considered as beta versions and upgrading support
may not be provided for these versions.
== Credits
* Jean-Francois Boutier (spanish translation)
* Andreas Viklund (open source XHTML layout, http://andreasviklund.com/)
* Karim Trott (german translation)
scm/doc/docbook/en/redmine-userdoc-en.xml
+429
View File
@@ -0,0 +1,429 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<book>
<title>RedMine Documentation</title>
<chapter>
<title>Administration</title>
<section>
<title>Users</title>
<para>These screens allow you to manage the application users.</para>
<section>
<title>Users’ List</title>
<para/>
<screenshot>
<screeninfo>Users’ List</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/users_list.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para>The Lock/Unlock buttons allow you to lock/unlock the user accounts.</para>
<para>A user having a locked account cannot log in and access the application.</para>
</section>
<section>
<title>User Creation or Modification</title>
<para>In modification mode, please leave the Password field blank in order to keep the user’s password unchanged.</para>
<para>A user designated as administrator has unrestricted access to the application and to all projects.</para>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Administrator</guilabel>
: designate the user as the administrator of the application.
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">E-mail notifications</guilabel>
: activate or de-activate automatic e-mail notifications for this user
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Locked</guilabel>
: de-activates the user’s account
</para>
</listitem>
</itemizedlist>
<para/>
</section>
</section>
<section>
<title>Roles and Permissions</title>
<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>
<para>On the new or edit Role screen, check off the actions authorized for the Role.</para>
</section>
<section>
<title>Trackers</title>
<para>Trackers allow the sorting of Issues and can define specific workflows.</para>
</section>
<section>
<title>Customized fields</title>
<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>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Integer</guilabel>
: positive or negative number
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">String</guilabel>
: a string of characters - one single line of input.
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Text</guilabel>
: a string of characters with multiple lines of input. Differs from String Format by providing multiple lines of input instead of a single line.
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Date</guilabel>
: date
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Boolean</guilabel>
: true or false (check if necessary)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">List</guilabel>
: value to select from a predefined list (aka: scroll list or select box)
</para>
</listitem>
</itemizedlist>
<para>Validation elements can be defined:</para>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Required</guilabel>
: A required field must have input in the forms
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">For all the projects</guilabel>
: field automatically associated to all of the projects
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Min - max length</guilabel>
: minimum and maximum length for the input fields (0 means that there is no restriction)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Regular Expression</guilabel>
: regular expressions may provide validation of the input value
</para>
<para>Examples:</para>
<para>
<code>^\[A-Z]{4}\d+$</code>
: 4 capital letters followed by one or several digits
</para>
<para>
<code>^[^0-9]*$</code>
: characters only - no digits
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Possible values</guilabel>
: possible values for the fields of "List" type. Values are separated by the character |
</para>
</listitem>
</itemizedlist>
<para/>
<section>
<title>Fields for Projects</title>
<para/>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Required</guilabel>
: required field
</para>
</listitem>
</itemizedlist>
<para/>
</section>
<section>
<title>Fields for Issues</title>
<para/>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">For all projects</guilabel>
: field automatically associated to all project Issues
</para>
<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>
</listitem>
</itemizedlist>
<para/>
</section>
<section>
<title>Field for Users</title>
<para/>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Required</guilabel>
: required field
</para>
</listitem>
</itemizedlist>
<para/>
</section>
</section>
<section>
<title>Issue status</title>
<para>These screens allow you to define the different possible Issue statuses.</para>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Closed</guilabel>
: indicates Issue is considered as closed
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Default</guilabel>
: status applied by default to new Issue requests (only one status can be Default status)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Color</guilabel>
: HTML color code (6 characters) representing the displayed status
</para>
</listitem>
</itemizedlist>
<para/>
</section>
<section>
<title>Workflow</title>
<para>The workflow allows to define changes the various project members are allowed to make on the Issues, according to their type.</para>
<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>
<para>
<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>
</para>
<para/>
<screenshot>
<screeninfo>Example of a workflow configuration</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/workflow.png"/>
</imageobject>
</mediaobject>
</screenshot>
<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>
</section>
<section>
<title>Enumerations</title>
<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>
<itemizedlist>
<listitem>
<para>Issue Priorities</para>
</listitem>
<listitem>
<para>Document Categories</para>
</listitem>
</itemizedlist>
<para/>
</section>
<section>
<title>E-mail notifications</title>
<para>This screen allows you to select the actions that will generate an e-mail notification for project members.</para>
<para>Note: E-mail sending must be activated in the application configuration if you want to make any notifications.</para>
</section>
<section>
<title>Authentication</title>
<para>By default, redMine refers to its own database to authenticate users, by a specific password.</para>
<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>
<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>
<para/>
<section>
<title>LDAP statement</title>
<para/>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Name</guilabel>
: reference display name
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Host</guilabel>
: LDAP server host name
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Port</guilabel>
: connection port to the LDAP server
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Account</guilabel>
: DN of the connection account to LDAP (please leave it blank if the directory authorizes anonymous read access)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Password</guilabel>
: password of the connection account
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Base DN</guilabel>
: Basic DN used for user search in the directory
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">LDAP screen</guilabel>
: User search screen in the directory (optional)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">LDAP features</guilabel>
:
</para>
<itemizedlist>
<listitem>
<para>
<guilabel moreinfo="none">Identifier</guilabel>
: LDAP feature name used as user identifier (e.g.: uid)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">First name</guilabel>
: LDAP feature name including the user’s first name (ex: givenName)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">Last name</guilabel>
: LDAP feature name including the user’s last name (ex: familyName)
</para>
</listitem>
<listitem>
<para>
<guilabel moreinfo="none">E-mail</guilabel>
: LDAP feature name including the user’s e-mail address (ex: mail)
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
The features"
<guilabel moreinfo="none">First name</guilabel>
", "
<guilabel moreinfo="none">Last name</guilabel>
" and "
<guilabel moreinfo="none">E-mail</guilabel>
" are not used except when the accounts are created on the fly.
</para>
</section>
</section>
<section>
<title>Information</title>
<para>Displays application and environment information.</para>
</section>
</chapter>
<chapter>
<title>Projects</title>
<section>
<title>Project preview</title>
<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>
<para/>
</section>
<section>
<title>Issue management</title>
<para/>
<section>
<title>Issue list</title>
<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>
<para>Once applied, a screen is valid during the entire session. You can re-define it or delete it by clicking Cancel.</para>
<para/>
<screenshot>
<screeninfo>Request list</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/issues_list.png"/>
</imageobject>
</mediaobject>
</screenshot>
<para/>
</section>
</section>
<section>
<title>Reports</title>
<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>
</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>
</section>
<section>
<title>News</title>
<para>Allows you to inform users on project activity.</para>
</section>
<section>
<title>Documents</title>
<para>Documents are grouped by categories (see Value Lists). A document can contain several files (for example: revisions or successive versions).</para>
</section>
<section>
<title>Files</title>
<para>This module allows you to display various folders (sources, binaires, ...) for each version of the application.</para>
</section>
<section>
<title>Settings</title>
<para/>
<section>
<title>Project features</title>
<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/>
</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>
</book>
scm/doc/docbook/fr/redmine-userdoc-fr.xml
+553
View File
@@ -0,0 +1,553 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<book>
<title>Documentation redMine</title>
<chapter>
<title>Administration</title>
<section>
<title>Utilisateurs</title>
<para>Ces écrans vous permettent de gérer les utilisateurs de
l'application.</para>
<section>
<title>Liste des utilisateurs</title>
<para></para>
<screenshot>
<screeninfo>Liste des utilisateurs</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/users_list.png" />
</imageobject>
</mediaobject>
</screenshot>
<para>Les boutons Lock/Unlock vous permettent de
vérouiller/dévérouiller les comptes utilisateurs.</para>
<para>Un utilisateur dont le compte est vérouillé ne peut plus
s'identifier pour accéder à l'application.</para>
</section>
<section>
<title>Création ou modification d'un utilisateur</title>
<para>En mode modification, laissez le champ Password vide pour
laisser le mot de passe de l'utilisateur inchangé.</para>
<para>Un utilisateur déclaré comme administrateur dispose de toutes
les permissions sur l'application et sur tous les projets.</para>
<itemizedlist>
<listitem>
<para><guilabel>Administrateur</guilabel>: déclare l'utilisateur
comme administrateur de l'application.</para>
</listitem>
<listitem>
<para><guilabel>Notifications par mail</guilabel>: permet
d'activer ou non l'envoi automatique de notifications par mail
pour cet utilisateur</para>
</listitem>
<listitem>
<para><guilabel>Vérouillé</guilabel>: désactive le compte de
l'utilisateur</para>
</listitem>
</itemizedlist>
<para></para>
</section>
</section>
<section>
<title>Rôles et permissions</title>
<para>Les rôles permettent de définir les permissions des différents
membres d'un projet. Chaque membre d'un projet dispose d'un rôle unique
au sein d'un projet. Un utilisateur peut avoir différents rôles au sein
de différents projets.</para>
<para>Sur l'écran d'édition du rôle, cochez les actions que vous
souhaitez autoriser pour le rôle.</para>
</section>
<section>
<title>Trackers</title>
<para>Les trackers permettent de typer les demandes et de définir des
workflows spécifiques pour chacun de ces types.</para>
</section>
<section>
<title>Champs personnalisés</title>
<para>Les champs personnalisés vous permettent d'ajouter des
informations supplémentaires sur les projets, les demandes ou les
utilisateurs. Un champ personnalisé peut être de l'un des types
suivants:</para>
<itemizedlist>
<listitem>
<para><guilabel>Entier</guilabel>: entier positif ou négatif</para>
</listitem>
<listitem>
<para><guilabel>Chaîne</guilabel>: chaîne de caractère</para>
</listitem>
<listitem>
<para><guilabel>Date</guilabel>: date</para>
</listitem>
<listitem>
<para><guilabel>Booléen</guilabel>: booléen (case à cocher)</para>
</listitem>
<listitem>
<para><guilabel>Liste</guilabel>: valeur à sélectionnée parmi une
liste prédéfinie (liste déroulante)</para>
</listitem>
</itemizedlist>
<para>Des éléments de validation peuvent être définis:</para>
<itemizedlist>
<listitem>
<para><guilabel>Obligatoire</guilabel>: champ dont la saisie est
obligatoire sur les demandes</para>
</listitem>
<listitem>
<para><guilabel>Pour tous les projects</guilabel>: champ
automatiquement associé à l'ensemble des projets</para>
</listitem>
<listitem>
<para><guilabel>Min - max length</guilabel>: longueurs minimales et
maximales pour les champs en saisie libre (0 signifie qu'il n'y a
pas de restriction)</para>
</listitem>
<listitem>
<para><guilabel>Expression régulière</guilabel>: expression
régulière permettant de valider la valeur saisie</para>
<para>Exemples:</para>
<para><code>^\[A-Z]{4}\d+$</code> : 4 lettres majuscules suivies
d'un ou plusieurs chiffres</para>
<para><code>^[^0-9]*$</code> : chaîne ne comportant pas de
chiffres</para>
</listitem>
<listitem>
<para><guilabel>Valeurs possibles</guilabel>: valeurs possibles pour
les champs de type "Liste". Les valeurs sont séparées par le
caractère |</para>
</listitem>
</itemizedlist>
<para></para>
<section>
<title>Champs pour les projets</title>
<para></para>
<itemizedlist>
<listitem>
<para><guilabel>Obligatoire</guilabel>: champ dont la saisie est
obligatoire</para>
</listitem>
</itemizedlist>
<para></para>
</section>
<section>
<title>Champs pour les demandes</title>
<para></para>
<itemizedlist>
<listitem>
<para><guilabel>Pour tous les projects</guilabel>: champ
automatiquement associé aux demandes de l'ensemble des
projets</para>
<para>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).</para>
</listitem>
</itemizedlist>
<para></para>
</section>
<section>
<title>Champs pour les utilisateurs</title>
<para></para>
<itemizedlist>
<listitem>
<para><guilabel>Obligatoire</guilabel>: champ dont la saisie est
obligatoire</para>
</listitem>
</itemizedlist>
<para></para>
</section>
</section>
<section>
<title>Statut des demandes</title>
<para>Ces écrans vous permettent de définir les différents statuts
possibles des demandes.</para>
<itemizedlist>
<listitem>
<para><guilabel>Demande fermée</guilabel>: indique que le statut
correspond à une demande considérée comme fermée</para>
</listitem>
<listitem>
<para><guilabel>Statut par défaut</guilabel>: statut appliqué par
défaut aux nouvelles demandes (seul un statut peut être déclaré
comme statut par défaut)</para>
</listitem>
<listitem>
<para><guilabel>Couleur</guilabel>: code couleur HTML (6 caractères)
représentant le statut à l'affichage</para>
</listitem>
</itemizedlist>
<para></para>
</section>
<section>
<title>Workflow</title>
<para>Le workflow permet de définir les changements que les différents
membres d'un projet sont autorisés à effectuer sur les demandes, en
fonction de leur type.</para>
<para>Sélectionnez le rôle et le tracker pour lesquels vous souhaitez
modifier le workflow, puis cliquez sur Edit. L'écran vous permet alors
de modifier, pour le rôle et le tracker choisi, les changements
autorisés. Les lignes représentent les statuts initiaux des demandes.
Les colonnes représentent les statuts autorisés à être appliqués.</para>
<para><remark>Remarque: pour qu'un rôle puisse changer le statut des
demandes, la permission doit lui être explicitement donnée
indépendemment de la configuration du workflow.</remark></para>
<para></para>
<screenshot>
<screeninfo>Exemple de configuration d'un workflow</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/workflow.png" />
</imageobject>
</mediaobject>
</screenshot>
<para>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.</para>
</section>
<section>
<title>Listes de valeurs</title>
<para>Les listes de valeurs utilisées par l'application (exemple: les
priorités des demandes) peuvent être personnalisées. Cet écran vous
permet de définir les valeurs possibles pour chacune des listes
suivantes:</para>
<itemizedlist>
<listitem>
<para>Priorités des demandes</para>
</listitem>
<listitem>
<para>Catégories de documents</para>
</listitem>
</itemizedlist>
<para></para>
</section>
<section>
<title>Notifications par mail</title>
<para>Cet écran vous permet de sélectionner les actions qui donneront
lieu à une notification par mail aux membres du projet.</para>
<para>Remarque: l'envoi de mails doit être activé dans la configuration
de l'application si souhaitez effectuer des notifications.</para>
</section>
<section>
<title>Authentification</title>
<para>Par défaut, redMine s'appuie sur sa propre base de données pour
authentifier les utilisateurs, à l'aide d'un mot de passe
spécifique.</para>
<para>Si vous disposez déjà d'un ou plusieurs référentiels externes
d'utilisateurs (annuaires LDAP), vous pouvez les déclarer afin qu'ils
soient utilisés pour l'authentification sur redMine. Cela permet aux
utilisateurs d'accéder à redMine avec leurs identifiants et mots de
passe habituels.</para>
<para>Pour chaque référentiel déclaré, vous pouvez spécifier si les
comptes peuvent être créés à la volée dans redMine. Si c'est le cas, les
comptes utilisateurs sont automatiquement créés à la première connexion
de l'utilisateur (sans droits spécifiques sur les projets), à partir des
informations disponibles dans le référentiel. Sinon, l'administrateur
doit au préalable créer le compte de l'utilisateur dans redMine.</para>
<para></para>
<section>
<title>Déclaration d'un annuaire LDAP</title>
<para></para>
<itemizedlist>
<listitem>
<para><guilabel>Nom</guilabel>: nom d'affichage du
référentiel</para>
</listitem>
<listitem>
<para><guilabel>Hôte</guilabel>: nom d'hôte du serveur LDAP</para>
</listitem>
<listitem>
<para><guilabel>Port</guilabel>: port de connexion au serveur
LDAP</para>
</listitem>
<listitem>
<para><guilabel>Compte</guilabel>: DN du compte de connexion au
LDAP (laisser vide si l'annuaire autorise l'accès anonyme en
lecture)</para>
</listitem>
<listitem>
<para><guilabel>Mot de passe</guilabel>: mot de passe du compte de
connexion</para>
</listitem>
<listitem>
<para><guilabel>Base DN</guilabel>: DN de base utilisé pour la
recherche des utilisateur dans l'annuaire</para>
</listitem>
<listitem>
<para><guilabel>Filtre LDAP</guilabel>: Filtre de recherche des
utilisateurs dans l'annuaire (optionnel)</para>
</listitem>
<listitem>
<para><guilabel>Attributs LDAP</guilabel>:</para>
<itemizedlist>
<listitem>
<para><guilabel>Identifiant</guilabel>: nom de l'attribut LDAP
utilisé comme identifiant de l'utilisateur (ex: uid)</para>
</listitem>
<listitem>
<para><guilabel>Prénom</guilabel>: nom de l'attribut LDAP
contenant le prénom de l'utilisateur (ex: givenName)</para>
</listitem>
<listitem>
<para><guilabel>Nom</guilabel>: nom de l'attribut LDAP
contenant le nom de l'utilisateur (ex: sn)</para>
</listitem>
<listitem>
<para><guilabel>Email</guilabel>: nom de l'attribut LDAP
contenant l'adresse mail de l'utilisateur (ex: mail)</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Les attributs "<guilabel>Prénom</guilabel>",
"<guilabel>Nom</guilabel>" et "<guilabel>Email</guilabel>" ne sont
utilisés que lorsque les comptes sont créés à la volée.</para>
</section>
</section>
<section>
<title>Informations</title>
<para>Affiche des informations relatives à l'application et à son
environnement.</para>
</section>
</chapter>
<chapter>
<title>Projets</title>
<section>
<title>Aperçu du projet</title>
<para>L'aperçu vous présente les informations générales relatives au
projet, les principaux membres, les dernières annonces, ainsi qu'une
synthèse du nombre de demandes ouvertes par tracker.</para>
<para></para>
</section>
<section>
<title>Gestion des demandes</title>
<para></para>
<section>
<title>Liste des demandes</title>
<para>Par défaut, l'ensemble des demandes ouvertes du projet sont
affichées. Différents filtres vous permettent de sélectionner les
demandes à afficher. Si le projet comporte des sous-projets, vous avez
la possibilité d'afficher également les demandes relatives aux
sous-projets (non affichées par défaut).</para>
<para>Une fois appliqué, un filtre reste valable durant toute votre
session. Vous pouvez le redéfinir, ou le supprimer en cliquant sur
Annuler.</para>
<para></para>
<screenshot>
<screeninfo>Liste des demandes</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/issues_list.png" />
</imageobject>
</mediaobject>
</screenshot>
<para></para>
</section>
</section>
<section>
<title>Rapports</title>
<para>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.</para>
</section>
<section>
<title>Historique</title>
<para>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.</para>
</section>
<section>
<title>Annonces</title>
<para>Les nouvelles vous permettent d'informer les utilisateurs sur
l'activité du projet.</para>
</section>
<section>
<title>Documents</title>
<para>Les documents sont groupés par catégories (voir Listes de
valeurs). Un document peut contenir plusieurs fichiers (exemple:
révisions ou versions successives).</para>
</section>
<section>
<title>Fichiers</title>
<para>Ce module vous permet de publier les différents fichiers (sources,
binaires, ...) pour chaque version de l'application.</para>
</section>
<section>
<title>Configuration du projet</title>
<para></para>
<section>
<title>Propriétés du projet</title>
<para></para>
<itemizedlist>
<listitem>
<para><guilabel>Public</guilabel>: 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.</para>
</listitem>
<listitem>
<para><guilabel>Champs personnalisés</guilabel>: 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.</para>
</listitem>
</itemizedlist>
<para></para>
</section>
<section>
<title>Membres</title>
<para>Cet écran 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.</para>
</section>
<section>
<title>Versions</title>
<para>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).</para>
</section>
<section>
<title>Catégories des demandes</title>
<para>Les catégories de demande vous permettent de typer les demandes.
Les catégories peuvent par exemple correspondre aux différents modules
du projet.</para>
</section>
</section>
</chapter>
</book>