wiki:TracBacksPlugin

Version 12 (modified by rjollos, 5 years ago) (diff)

--

TracBacks Plugin

Description

Summary

Enables within-Trac trackbacks - when a comment on ticket A references ticket B, a comment is made on ticket B letting you know that ticket A has talked about it.

See also: TicketBackLinksMacro

More detail

TracBacks provides internal trackback functionality between tickets in a Trac instance.

Scenario: If developer A is working on ticket 1 and developer B is working on ticket 2 and writes some notes (on ticket 2) how it’s related to ticket 1, it automatically makes a (ticket-2)-to-(ticket 1) link that’s easy to follow to get more details. So far so good. However, developer A has no idea her ticket has just been discussed on ticket 2, and tinkers on blithely unaware of what is going on around her, because there is no reciprocal (ticket 1)-to-(ticket 2) link.

How can we automatically indicate that tickets are being discussed at other tickets? TracBacks. What this plugin does is simply to create that reciprocal (ticket 1)-to-(ticket 2) link so that anyone looking at ticket 1 can see it has been talked about on ticket 2 as well. You can see it here at http://trac-hacks.org/wiki/TracBacksPlugin, and it’s rapidly being improved upon by others.

Bugs/Feature Requests

Existing bugs and feature requests for TracBacksPlugin are here. If you have any issues, create a new ticket.

Download and Source

Download the zipped source, check out using Subversion, or browse the source with Trac.

Example

Place the .egg in your env/plugins directory, as usual. All comments made thereafter will cause trackbacks to be placed on all the tickets that they reference, if any. This plugin will not retroactively create trackbacks for existing comments.

Adding the following comment in ticket A

Results in the following tracback in ticket B

Recent Changes

[12197] by ejucovy on 2012-10-18 17:04:35
close #9008 -- In the event that the changelog is empty, cnum_thischange needs to be set to the string "1", not the integer 1
[12080] by ejucovy on 2012-10-01 01:52:35
ticket.get_changelog() returns entries that aren't comments (as well as entries that are comments) -- so, if the latest modification on the ticket does not have a comment, tracbacks will cause an internal error by assuming an incorrect data structure. this commit fixes the problem by filtering out all changelog entries that are not comments. (fixes #9743)
[11980] by rjollos on 2012-09-12 07:37:50
Fixes #9809: (0.2dev) Changed license from GPLv3+ to 3-Clause BSD.

Author/Contributors

Author: mchua
Contributors: tcoulter (original proposer), Doug Mayle, magicbronson, k0s

Originally written at The Open Planning Project.

Attachments (2)

Download all attachments as: .zip