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

= Back link feature in Trac (trac:#611)

== Description

This plugin provides a [trac:wiki:BackLinks back link] feature.

 - Add '''Back Links''' section to ticket, wiki and milestone views.
 - Update the `backlink` table automatically with gathered back links from tickets, wiki pages, milestones and changesets via `*ChangeListener` interfaces.
 - Add `backlink sync` command, which updates the `backlink` table 
 - Require Trac 1.0.5+ or 1.2+

'''Example for wiki''':

[[Image(example-wiki.png, border=2)]]

'''Example for ticket''':

[[Image(example-ticket.png, border=2)]]

See also trac:#611, TracBacksPlugin and BackLinksMacro.

== !Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

 1. Install the plugin:
 {{{#!sh
$ easy_install https://trac-hacks.org/svn/tracbacklinkplugin/1.0/
}}}
 1. Enable the plugin in your `trac.ini` file:
 {{{#!ini
[components]
tracbacklink.* = enabled
}}}
 1. Execute `upgrade` command to create `backlink` table:
 {{{#!sh
$ trac-admin $ENV upgrade
}}}
 1. Execute `backlink sync` command to synchronize `backlink` table with several tables in Trac:
{{{#!sh
$ trac-admin $ENV backlink sync
}}}

See also [TracPlugins#InstallingaTracplugin TracPlugins] page for generic installation instructions.

== Recent Changes

[[ChangeLog(tracbacklinkplugin, 3)]]

== !Author/Contributors

**Author:** [https://www.opengroove.com/ OpenGroove,Inc.] and [https://tracpath.com/ tracpath] \\
**Maintainer:** [[Maintainer]] \\
**Contributors:**