[[PageOutline(2-5,Contents,pullout)]]

= Add support for Trac ticket cross-reference

== Description

This plugin adds "Relationships" fields to each ticket, enabling you to express cross-reference between tickets. 
This plugin requires Trac 0.12 or higher. Also tested on Trac 1.0.

Key features:

 - Provide simple cross-reference as Trac custom field (`ticketref`).
 - Create new ticket with related ticket's field value.
 - Picking up the referred ticket in comment.

This plugin was inspired by [http://trac-hacks.org/wiki/MasterTicketsPlugin MasterTicketsPlugin].

== Bugs/Feature Requests

Existing bugs and feature requests for TracTicketReferencePlugin are 
[https://bitbucket.org/t2y/trac.plugins.ticketref/issues here].

If you have any issues, create a 
[https://bitbucket.org/t2y/trac.plugins.ticketref/issues/new new ticket].

== Download

Download the archived source from [http://pypi.python.org/pypi/TracTicketReferencePlugin here].

== Source

You can clone TracTicketReferencePlugin from [https://bitbucket.org/t2y/trac.plugins.ticketref/ here] using Mercurial, or browse the source.

== Configuration

To enable and configure the plugin, add the following to your `trac.ini` file:

{{{#!ini
[components]
ticketref.* = enabled

[ticket-custom]
ticketref = textarea
ticketref.label = Relationships
ticketref.cols = 68
ticketref.rows = 1
}}}

If you want to show more small field, change as follows:
{{{#!ini
[ticket-custom]
ticketref = text
ticketref.label = Relationships
}}}

Since 0.4.0, configure reference keywords for CommitTicketUpdater to get ticket reference like this. Note both `close` and `refs` keywords are used:
{{{#!ini
[ticket]
commit_ticket_update_commands.close = fix fixed fixes
commit_ticket_update_commands.refs = ref refs refer
}}}

=== i18n/l10n Support

This plugin is able to localize field label or message.
You can translate into your language using "ticketref/locale/messages.pot".

And then, I'm willing to merge your contribution into the distribution.
So, let me know if you localized "ticketref/locale/messages.pot".

See also [http://trac.edgewall.org/wiki/TracL10N Localization (L10N) of Trac]

== Example

'''New Ticket with Relationships'''

[[Image(ticketref_new.png)]]

'''Query Result with Relationships'''

[[Image(ticketref_query.png)]]

'''Pick up "ref* #id" in comment as cross-reference'''

[[Image(ticketref_pickup_id.png)]]

'''Clicking "Relationships" label displays the id with summary'''

[[Image(ticketref_verbose_info.png)]]

== Recent Changes

See https://bitbucket.org/t2y/trac.plugins.ticketref/commits.

== Author/Contributors

'''Author:''' [wiki:t2y] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''