Code

Changes between Version 3 and Version 4 of TracTickets


Ignore:
Timestamp:
01/28/11 12:52:13 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v3 v4  
    22[[TracGuideToc]] 
    33 
    4 The Trac issue database provides simple but effective tracking of issues and bugs within a project. 
     4The Trac ticket database provides simple but effective tracking of issues and bugs within a project. 
    55 
    6 As the central project management element of Trac, tickets are used for '''bug reports''',  '''feature requests''', '''software support issues''' and '''project tasks'''.  
     6As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.  
    77 
    88As with the TracWiki, this subsystem has been designed with the goal of making user contribution and participation as simple as possible. It should be as easy as possible to report bugs, ask questions and suggest improvements. 
     
    1111All tickets can be edited, annotated, assigned, prioritized and discussed at any time. 
    1212 
    13 '''Note:''' To make full use of the ticket system, use it as an ''in bucket'' for ideas and tasks for your project, rather than just bug/fault reporting.  
    14  
    1513== Ticket Fields == 
    1614 
    1715A  ticket contains the following information attributes: 
    1816  
    19  * '''Reporter''' - The author of the ticket. 
    20  * '''Component''' - The project module or subsystem this ticket concerns. 
    21  * '''Version''' - Version of the project that this ticket pertains to. 
    22  * '''Severity''' - What are the effects the issue described? Ranges from an ''enhancement'' request to ''blocker'' (must be fixed before next milestone). 
    23  * '''Priority''' - The importance of is the issue relative to other tasks. 
    24  * '''Milestone''' - When this issue should be resolved at the latest. 
    25  * '''Resolution''' - Reason for why a ticket was closed, such as fixed, invalid, duplicate, etc. 
    26  * '''Keywords''' - Keywords that a ticket is marked with.  Useful for searching and report generation. 
    27  * '''Assigned to''' - Principal person responsible for handling the issue. 
    28  * '''Cc''' - A list of other associated people. ''Note: this does '''not''' imply responsibility or any other policy.  
    29  * '''Status''' - What is the current status? 
    30  * '''Summary''' - A brief description summarizing the problem or issue. 
    31  * '''Description''' - The body of the ticket. A good description should be '''specific, descriptive and to the point'''. 
     17 * '''Reporter''' — The author of the ticket. 
     18 * '''Type''' — The nature of the ticket (for example, defect or enhancement request) 
     19 
     20 * '''Component''' — The project module or subsystem this ticket concerns. 
     21 * '''Version''' — Version of the project that this ticket pertains to. 
     22 * '''Keywords''' — Keywords that a ticket is marked with.  Useful for searching and report generation. 
     23 
     24 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. 
     25 * '''Milestone''' — When this issue should be resolved at the latest. 
     26 * '''Assigned to/Owner''' — Principal person responsible for handling the issue. 
     27 * '''Cc''' — A comma-separated list of other users or E-Mail addresses to notify. ''Note that this does not imply responsiblity or any other policy.'' 
     28  
     29 * '''Resolution''' — Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}. 
     30 * '''Status''' — What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}. 
     31 * '''Summary''' — A brief description summarizing the problem or issue. 
     32 * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point. 
     33 
     34'''Note:''' Versions of Trac prior to 0.9 did not have the ''type'' field, but instead provided a ''severity'' field and different default values for the ''priority'' field. This change was done to simplify the ticket model by removing the somewhat blurry distinction between ''priority'' and ''severity''. However, the old model is still available if you prefer it: just add/modify the default values of the ''priority'' and ''severity'', and optionally hide the ''type'' field by removing all the possible values through [wiki:TracAdmin trac-admin]. 
     35 
     36'''Note:''' the [trac:TicketTypes type], [trac:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the [trac:WebAdmin WebAdmin] plugin. 
     37 
     38'''Note:''' Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes] 
    3239 
    3340== Changing and Commenting Tickets == 
     
    3744the ticket are logged as a part of the ticket itself. 
    3845 
    39 When viewing a ticket, this log of changes will appear below the main ticket area. 
     46When viewing a ticket, the history of changes will appear below the main ticket area. 
    4047 
    41 ''In the Trac project, we use ticket comments to discuss issues and 
    42 tasks. This makes understanding the motivation behind a design- or implementation choice easier, when returning to it later.'' 
     48''In the Trac project, we use ticket comments to discuss issues and tasks. This makes 
     49understanding the motivation behind a design- or implementation choice easier, 
     50when returning to it later.'' 
    4351 
    4452'''Note:''' An important feature is being able to use TracLinks and 
     
    4957'''Note:''' See TracNotification for how to configure email notifications of ticket changes. 
    5058 
    51 === State Diagram === 
    52 http://projects.edgewall.com/trac/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020040607DF.png?format=raw 
     59'''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized. 
    5360 
    54 == Advanced: Preset values for New Tickets from URL == 
     61== Default Values for Drop-Down Fields == 
    5562 
    56 To create a link to the new-icket form filled with preset values, you need to call the /newticket? URL with variable=value separated by &.  
     63The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section: 
     64 
     65 * `default_component`: Name of the component selected by default 
     66 * `default_milestone`: Name of the default milestone 
     67 * `default_priority`: Default priority value 
     68 * `default_severity`: Default severity value 
     69 * `default_type`: Default ticket type 
     70 * `default_version`: Name of the default version 
     71 * `default_owner`: Name of the default owner, ''if no owner for the component has been set'' 
     72 
     73If any of these options are omitted, the default value will either be the first in the list, or an empty value, depending on whether the field in question is required to be set.  Some of these can be chosen through the [trac:WebAdmin WebAdmin] plugin in the "Ticket System" section (others in the "trac.ini" section).  The default owner for a ticket will be the component owner, if that is set, or `default_owner`, if not. 
     74 
     75 
     76== Hiding Fields and Adding Custom Fields == 
     77 
     78Many of the default ticket fields can be hidden from the ticket web interface simply by removing all the possible values through [wiki:TracAdmin trac-admin]. This of course only applies to drop-down fields, such as ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''. 
     79 
     80Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information. 
     81 
     82 
     83== Assign-to as Drop-Down List == 
     84 
     85If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [wiki:TracIni trac.ini] to “true”. In that case, Trac will use the list of all users who have accessed the project to populate the drop-down field. 
     86 
     87To appear in the dropdown list, a user needs be registered with the project, ''i.e.'' a user session should exist in the database. Such an entry is automatically created in the database the first time the user submits a change in the project, for example when editing the user's details in the ''Settings'' page, or simply by authenticating if the user has a login. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions]. 
     88 
     89'''Note:''' See [http://pacopablo.com/wiki/pacopablo/blog/set-assign-to-drop-down Populating Assign To Drop Down] on how to add user entries at database level 
     90 
     91'''Note 2:''' If you need serious flexibility and aren't afraid of a little plugin coding of your own, see [http://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignTo] (disclosure: I'm the author) 
     92 
     93'''Note 3:''' Activating this option may cause some performance degradation, read more about this in the [trac:TracPerformance#Configuration Trac performance] page. 
     94 
     95== Preset Values for New Tickets == 
     96 
     97To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &.  
    5798 
    5899Possible variables are : 
    59100 
    60  * '''reporter''' - Name or email of the reporter 
    61  * '''summary''' - Summary line for the ticket 
    62  * '''description''' - Long description of the ticket 
    63  * '''component''' - The component droplist 
    64  * '''version''' - The version droplist 
    65  * '''severity''' - The severity droplist 
    66  * '''keywords''' - The keywords  
    67  * '''priority''' - The priority droplist 
    68  * '''milestone''' - The milestone droplist 
    69  * '''owner''' - The responsable of the ticket 
    70  * '''cc''' - The list of email for notify the ticket change 
     101 * '''type''' — The type droplist 
     102 * '''reporter''' — Name or email of the reporter 
     103 * '''summary''' — Summary line for the ticket 
     104 * '''description''' — Long description of the ticket 
     105 * '''component''' — The component droplist 
     106 * '''version''' — The version droplist 
     107 * '''severity''' — The severity droplist 
     108 * '''keywords''' — The keywords  
     109 * '''priority''' — The priority droplist 
     110 * '''milestone''' — The milestone droplist 
     111 * '''owner''' — The person responsible for the ticket 
     112 * '''cc''' — The list of emails for notifying about the ticket change 
    71113 
    72 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui'' 
     114'''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]] 
    73115 
    74  
    75 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification 
     116---- 
     117See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery