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

= Adds user picture icons (avatars) to Trac

{{{#!box info
'''Notice''': there are plans to integrate the functionality of this plugin into AccountManagerPlugin.
}}}

== Description

This plugin allows a user to add a user picture icons (avatars) to his/her profile on Trac. The user picture then shows up next to the user name in for example tickets, query results and the file browser. Screenshots of the plugin in action can be found at https://github.com/trac-hacks/trac-UserPicturesPlugin/wiki/Screenshots

The approach of the plugin is to filter specific Trac views, gather all the authors found in the “data” hash being passed to Genshi, then using Genshi filters to insert additional avatar nodes with the proper img tags.

Currently supported views are:
* Timeline
* Ticket details: reporter, owner, comments, comment diffs
* Attachment views (on tickets, wiki pages, etc)
* Source control views, such as directory listings, file contents, changesets
* Report and custom query views
* Wiki history, diffs and individual versions
* Search results

Credit goes to Michael Bayer for the idea and most of the code.

See also: UserManagerPlugin, TracvatarPlugin

== Bugs/Feature Requests

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

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

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

== Download

Download the zipped source from [pypi:trac-UserPicturesPlugin/ here].

== Source

Mirrors are available on Github and PyPi:
 * https://github.com/trac-hacks/trac-UserPicturesPlugin/
 * [pypi:trac-UserPicturesPlugin/ PyPi trac-UserPicturesPlugin]

== Installation

 1. General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
 1. Enable the component in your `trac.ini` file:
{{{#!ini
[components]
userpictures.* = enabled
}}}
 1. Choose your preferred avatar engine. For Gravatar:
{{{#!ini
[userpictures]
pictures_provider = UserPicturesGravatarProvider
}}}

For UserManagerPlugin integration, ensure that the UserManagerPlugin is installed and enabled, and then:
{{{#!ini
[userpictures]
pictures_provider = UserPicturesUserManagerProvider
}}}

If you do not explicitly select either engine, a default provider is used which displays a blank silhouette for every user.

== Author/Contributors

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