Changes between Version 20 and Version 21 of TracBacksPlugin

Timestamp:

Jul 24, 2015, 10:51:21 AM (9 years ago)

Author:

figaro

Comment:

Cosmetic changes, tagged with license

TracBacksPlugin

@@ -3 +3 @@
 = Backlinks for tickets in comment history =
 
-== Description ==
+== Description
 
-=== Summary ===
-
-Enables intra-Trac references between tickets. When a comment on ticket A references ticket B, a comment is made on ticket B letting you know that ticket A has referenced it.
+This plugin enables intra-Trac references between tickets. When a comment on ticket A references ticket B, a comment is made on ticket B letting you know that ticket A has referenced it.
 
 See also: TicketBackLinksMacro
 
-=== More detail ===
+=== Usage scenario
 
-TracBacksPlugin provides internal trackback functionality between tickets in a Trac instance.
+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.
 
-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? This plugin creates 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.
 
-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.
+== Bugs/Feature Requests
 
-== Bugs/Feature Requests == 
+Existing bugs and feature requests for TracBacksPlugin are [query:status!=closed&component=TracBacksPlugin&order=priority here]. 
 
-Existing bugs and feature requests for TracBacksPlugin are [query:status!=closed&component=TracBacksPlugin&order=priority here]. If you have any issues, create a 
-[/newticket?component=TracBacksPlugin&owner=ejucovy new ticket].
+If you have any issues, create a 
+[/newticket?component=TracBacksPlugin new ticket].
 
-== Download and Source ==
+[[TicketQuery(component=TracBacksPlugin&group=type,format=progress)]]
+
+== Download and Source
 
 Download the [download:tracbacksplugin zipped source], check out [/svn/tracbacksplugin using Subversion], or [source:tracbacksplugin browse the source] with Trac.
 
-== Example ==
+== Installation
 
-Note: This plugin will not retroactively create trackbacks for existing comments.
+General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
 
-Adding the following comment in ticket A
+== Example
+
+'''Note''': This plugin will not retroactively create trackbacks for existing comments.
+
+Adding the following comment in ticket A:
 
 [[Image(TicketA.png)]]
 
-Results in the following tracback in ticket B
+Results in the following tracback in ticket B:
 
 [[Image(TicketB.bmp)]]
 
-== Recent Changes ==
+== Recent Changes
 
 [[ChangeLog(tracbacksplugin, 3)]]
 
-== Author/Contributors ==
+== Author/Contributors
 
 '''Author:''' [wiki:mchua] [[BR]]
-'''Maintainer:''' ejucovy [[BR]]
+'''Maintainer:''' [[Maintainer]] [[BR]]
 '''Contributors:''' [wiki:tcoulter] (original proposer), Doug Mayle, [wiki:magicbronson], [wiki:k0s], [wiki:rjollos] [[BR]]