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

= Filter Timeline Tickets by Component

== Description

This plugin filters the ticket events (new tickets, edited tickets, closed tickets, and files attached to tickets) by the ticket Component attribute.

This plugin is based on the TimelineUserFilterPlugin.

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

Simply copy the {{{TimelineComponentFilter.py}}} to {{{[trac-env-path]/plugins}}} directory.

This plugin has only been tested with Trac 0.11.4 and 0.11.7. More testing and feedback is welcome.

== Configuration

To enable this component, put the following in the {{{[Components]}}} section of your `trac.ini` file:

{{{#!ini
[components]
timelinecomponentfilter.* = enabled
}}}

== Example

Select the component(s) in the filter box on the timeline to filter out all tickets that do not apply to the selected component(s).

In the following example, ticket !#1 is tied to component ''component1'' and ticket !#2 is tied to component ''component2''. The following screen capture shows no components selected, ie display all tickets:

Putting #prefs select { width: 170px; } inside trac.css is also a good idea.

[[Image(timeline-none-selected.PNG)]]

The following shows the timeline filtered to show on tickets tied to ''component1'':

[[Image(timeline-com1-selected.PNG)]]

== Recent Changes

[[ChangeLog(timelinecomponentfilterplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:pdoup] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' rjollos