Changes between Version 2 and Version 3 of TracTickets


Ignore:
Timestamp:
2017-08-28T06:33:43Z (4 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v2 v3  
    1 = The Trac Ticket System =
     1= The Trac Ticket System
    22[[TracGuideToc]]
    33
    4 The Trac ticket database provides simple but effective tracking of issues and bugs within a project.
     4The Trac ticket system provides a simple but effective way to track issues and software bugs within a project.
    55
    6 As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.
     6As the central project management element of Trac, tickets can be used for '''project tasks''', '''feature requests''', '''bug reports''', '''software support issues''' among others.
    77
    8 As 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.
     8As with the TracWiki, this subsystem has been designed to make user contribution and participation as simple as possible.
    99
    10 An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
    11 All tickets can be edited, annotated, assigned, prioritized and discussed at any time.
     10An issue is assigned to a person who must resolve it or reassign the ticket to someone else. All tickets can be edited, annotated, assigned, prioritized and discussed at any time.
    1211
    13 == Ticket Fields ==
     12[=#edit-permissions]
     13However, a Trac installation may place restrictions on who can change what. For example, the default installation doesn't permit to non-authenticated users ("anonymous" users) to change anything, even to comment on an issue, for obvious spam prevention reasons. Check the local contributing policy, which you can usually find on the front page of WikiStart, or contact your local Trac administrator.
    1414
    15 A  ticket contains the following information attributes:
     15== Ticket Fields
     16
     17A ticket contains the following information:
    1618 
    17  * '''Reporter''' - The author of the ticket.
    18  * '''Type''' - The nature of the ticket (for example, defect or enhancement request)
     19 * '''Reporter''' — The author of the ticket.
     20 * '''Type''' — The category of the ticket. The default types are `defect`, `enhancement` and `task`.
     21 * '''Component''' — The project module or subsystem that this ticket concerns.
     22 * '''Version''' — Version of the project that this ticket pertains to.
     23 * '''Keywords''' — Keywords that a ticket is tagged with. Useful for searching and report generation.
     24 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. A dropdown list when multiple priorities are defined.
     25 * '''Milestone''' — Due date of when this issue should be resolved. A dropdown list containing the milestones.
     26 * '''Assigned to/Owner''' — Principal person responsible for handling the issue.
     27 * '''Cc''' — A comma-separated list of other users or email addresses to notify. Note that this does not imply responsibility or any other policy.
     28 * '''Resolution''' — Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
     29 * '''Status''' — What is the current status? The statuses are defined in the [TracWorkflow#BasicTicketWorkflowCustomization ticket workflow]. For the default workflow the statuses are `new`, `assigned`, `accepted`, `closed` and `reopened`.
     30 * '''Summary''' — A description summarizing the issue. Simple text without WikiFormatting.
     31 * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point. Accepts WikiFormatting.
    1932
    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.
     33'''Notes:'''
     34 - 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].
    2335
    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.
     36 - The [trac:TicketTypes type], [trac:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or through the !WebAdmin.
    3337
    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].
     38 - Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]
    3539
    36 '''Note:''' the [wiki:TicketTypes type], [wiki:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the WebAdmin plugin.
     40== Changing and Commenting Tickets
    3741
    38 '''Note:''' Description of the builtin ''priority'' values is available at [wiki:TicketTypes#Whyistheseverityfieldgone]
     42With appropriate permissions, as already mentioned [#edit-permissions above], a ticket entered into Trac can at any time be modified by '''annotating'''.
    3943
    40 == Changing and Commenting Tickets ==
     44Then, annotations like changes and comments to the ticket are logged as a part of the ticket itself. When viewing a ticket, the history of changes will appear below the main ticket area.
    4145
    42 Once a ticket has been entered into Trac, you can at any time change the
    43 information by '''annotating''' the bug. This means changes and comments to
    44 the ticket are logged as a part of the ticket itself.
     46Comment editing (available since 0.12) is meant to be used to make small corrections to comments, like fixing formatting, forgotten WikiFormatting or spelling errors, not major edits. For longer edits, you should be adding a new comment instead. Editing a comment will not produce a new entry on [/timeline], while entering a new comment or other changes will do.
    4547
    46 When viewing a ticket, the history of changes will appear below the main ticket area.
     48All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket.
    4749
    48 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
    49 understanding the motivation behind a design- or implementation choice easier,
    50 when returning to it later.''
     50'''Notes:'''
     51 - An important feature is being able to use TracLinks and WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to other issues, changesets or files to make your ticket more specific and easier to understand.
    5152
    52 '''Note:''' An important feature is being able to use TracLinks and
    53 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
    54 other issues, changesets or files to make your ticket more specific and easier
    55 to understand.
     53 - See TracNotification for how to configure email notifications of ticket changes.
    5654
    57 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
     55 - See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.
    5856
    59 '''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.
    60 
    61 == Default Values for Drop-Down Fields ==
     57== Default Values for Drop-Down Fields
    6258
    6359The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:
    6460
    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
     61 * `default_component`: Name of the component selected by default.
     62 * `default_milestone`: Name of the default milestone.
     63 * `default_priority`: Default priority value.
     64 * `default_severity`: Default severity value.
     65 * `default_type`: Default ticket type.
     66 * `default_version`: Name of the default version.
     67 * `default_owner`: Name of the default owner. If set to the text `< default >` (the default value), the component owner is used.
    7168
    72 If 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.
     69If 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 !WebAdmin in the "Ticket System" section, others can be set in the [[wiki:TracIni#ticket-section|"[ticket]"]] section in `trac.ini`.
    7370
    74 
    75 == Hiding Fields and Adding Custom Fields ==
     71== Hiding Fields and Adding Custom Fields
    7672
    7773Many 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''.
     
    7975Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information.
    8076
     77== Assign-to as Drop-Down List
    8178
    82 == Assign-to as Drop-Down List ==
     79If 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 populate the list with all users who **have an authenticated session** and possess the `TICKET_MODIFY` [TracPermissions permissions].
    8380
    84 If 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.
     81An authenticated session will be created the first time a user authenticates with the project. You can manually add an authenticated session using the ["TracAdmin#?session add" trac-admin] `session add` command. The `:1` suffix on the session id (i.e. username) is the key to creating an authenticated session:
     82{{{#!sh
     83trac-admin /path/to/projenv session add <sid>:1 [name] [email]
     84}}}
    8585
    86 To 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].
     86You may find the dropdown list is //overpopulated// with users that are no longer active in the project. Revoking authentication privileges will not remove the session data that is used to populate the dropdown list. The [wiki:TracAdmin trac-admin] command can be used to list and remove sessions:
    8787
    88 == Preset Values for New Tickets ==
     88 - List all sessions:
     89{{{#!sh
     90trac-admin /path/to/projenv session list
     91}}}
     92 - Remove a session:
     93{{{#!sh
     94trac-admin /path/to/projenv session delete SID
     95}}}
    8996
    90 To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &.
     97Alternatively, you can just revoke `TICKET_MODIFY` from users that you don't want to be included in the list. However, that will not be possible if you've granted `TICKET_MODIFY` to all //anonymous// or //authenticated// users.
    9198
    92 Possible variables are :
     99'''Notes:'''
     100 - If you need more flexibility and aren't afraid of a little plugin coding of your own, see the [https://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignTo plugin].
     101 
     102 - Activating this option may cause some performance degradation. Read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
    93103
    94  * '''type''' - The type droplist
    95  * '''reporter''' - Name or email of the reporter
    96  * '''summary''' - Summary line for the ticket
    97  * '''description''' - Long description of the ticket
    98  * '''component''' - The component droplist
    99  * '''version''' - The version droplist
    100  * '''severity''' - The severity droplist
    101  * '''keywords''' - The keywords
    102  * '''priority''' - The priority droplist
    103  * '''milestone''' - The milestone droplist
    104  * '''owner''' - The person responsible for the ticket
    105  * '''cc''' - The list of emails for notifying about the ticket change
     104== Preset Values for New Tickets
    106105
    107 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]]
     106To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with `variable=value` separated by `&`. Possible variables are:
     107
     108 * '''type''' — The type droplist.
     109 * '''reporter''' — Name or email of the reporter.
     110 * '''summary''' — Summary line for the ticket.
     111 * '''description''' — Long description of the ticket.
     112 * '''component''' — The component dropdown list.
     113 * '''version''' — The version dropdown list.
     114 * '''severity''' — The severity dropdown list.
     115 * '''keywords''' — The keywords or tags.
     116 * '''priority''' — The priority dropdown list.
     117 * '''milestone''' — The milestone dropdown list.
     118 * '''owner''' — The person responsible for the ticket.
     119 * '''cc''' — The list of emails for notifying about the ticket change.
     120
     121Example: `[/newticket?summary=Compile%20Error&version=1.0&component=gui]`
     122
     123== Deleting Tickets
     124
     125Ticket delete and ticket change delete functions are enabled through an optional component. To enable the functionality edit the [TracIni#components-section "[components]"] section of TracIni:
     126{{{#!ini
     127[components]
     128tracopt.ticket.deleter.* = enabled
     129}}}
     130
     131The //Delete// buttons appears next to the //Reply// buttons in the ticket description and ticket change areas. `TICKET_ADMIN` permission is required for deleting tickets and ticket changes.
    108132
    109133----
    110 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery
     134See also: TracTicketsCustomFields, TracNotification, TracReports, TracQuery