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

= Timeline Checkin Filter Plugin

== Description

This plugin changes the behaviour of the timeline and enables you to view changes to particular paths, or by particular users.

This plugin is based on BranchTimelinePlugin. This plugin is arguably better for a single Trac instance with multiple projects, as long as there aren't many projects/branches. The difference is that, instead of specific branches, you specify generic repository paths, thereby allowing multiple trunks, branches, vendor branches, etc.

This plugin has only actually been tested on 0.11.1. Log a bug if it doesn't work in any other 0.11.x version.

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

This plugin has the following prerequisites:
 * Trac 0.11
 * Subversion repository.

Installation steps:
 * Put the Python file in the plugins directory of the Trac environment or in the global plugins directory.
 * Components changes:
  * Disable the basic Trac component !ChangesetModule.
  * Enable the component !TimelineCheckinFilter.
  * These changes can be done via the !WebAdmin interface or by adding the following lines to your `trac.ini` file:

{{{#!ini
[components]
trac.versioncontrol.web_ui.changeset.changesetmodule = disabled
TimelineCheckinFilter.* = enabled
}}}

== Configuration

The following configuration can be added to your `trac.ini` file:

{{{#!ini
[timeline-checkin-filter]
filter_paths = trunk:trunk, branch1:branches/branch1, proj2-trunk:project2/trunk, arbitrary-label:arbitrary/path
filter_users = username1, username2
}}}

== Recent Changes

[[ChangeLog(timelinecheckinfilterplugin, 3)]]

== Author/Contributors

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