[[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-references 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, called `ticketref`.
 - Create new ticket with related ticket's field value.
 - Picking up the referred ticket in comment.

'''New Ticket with Relationships:'''

[[Image(ticketref_new.png, border=2)]]

'''Query Result with Relationships:'''

[[Image(ticketref_query.png, border=2)]]

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

[[Image(ticketref_pickup_id.png, border=2)]]

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

[[Image(ticketref_verbose_info.png, border=2)]]

This plugin was inspired by MasterTicketsPlugin.

== Bugs/Feature Requests

Existing bugs and feature requests for TracTicketReferencePlugin are 
[report:9?COMPONENT=TracTicketReferencePlugin here].

If you have any issues, create a 
[/newticket?component=TracTicketReferencePlugin new ticket].

[[TicketQuery(component=TracTicketReferencePlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:tracticketreferenceplugin here].

The plugin is also available on [pypi:TracTicketReferencePlugin PyPI].

== Source

You can check out TracTicketReferencePlugin from [/svn/tracticketreferenceplugin here] using Subversion, or [source:tracticketreferenceplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== 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 [t:TracL10N Localization (L10N) of Trac].

== Recent Changes

[[ChangeLog(tracticketreferenceplugin, 3)]]

== Author/Contributors

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