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

= Autocomplete user fields (assigned to and CC) on tickets

== Description

This plugin allows autocompletion of users for the owner, reporter and CC fields on new and existing tickets. Currently, all the known users are autocompleted, though this could be restricted to those that have the ticket owner permission. 

In addition to fields on new and existing tickets, the following fields are also autocompleted:
 * User and group fields on the admin Permissions page.
 * Ticket custom fields.
 * User field on the admin Components page (forthcoming).

[[Image(screenshot.png, border=2)]]

'''Note:''' Email addresses shown by this plugin are handled according to the setting `trac.show_email_addresses` and the permission `EMAIL_VIEW`. That is, if `trac.show_email_addresses` is set to `false` and the current user doesn't have the permission `EMAIL_VIEW`, then all mail addresses will be obfuscated as usual in Trac. That is, email addresses will be displayed as `donjaun@...` rather than `donjaun@example.com`. In all other cases the full email address is visible.

This autocomplete feature is implemented using AJAX. A `/subjects` URL is served which presents the users and/or groups in a format suitable for the jQuery Autocompleter. The plugin should gracefully degrade when !JavaScript is disabled. 

See also: TracAutoCompletePlugin (deprecated)

== Bugs/Feature Requests

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

If you have any issues, create a 
[/newticket?component=AutocompleteUsersPlugin&cc=jun66j5 new ticket].

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

== Download

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

There is also a version on [pypi:TracAutocompleteUsersPlugin PyPi].

== Source

Check out AutocompleteUsersPlugin from [/svn/autocompleteusersplugin here] using Subversion, or [source:autocompleteusersplugin browse the source] with Trac.

== Installation

You can install this plugin with the `easy_install` or `pip` command.

Install directly from repository:
{{{#!sh
$ easy_install https://trac-hacks.org/svn/autocompleteusersplugin/trunk
}}}

Install from PyPI:

{{{#!sh
$ pip install svn+https://trac-hacks.org/svn/autocompleteusersplugin/trunk
}}}

Note that only the released version appears on PyPI. If you need a development version you'll need to install from the repository.

After installing the plugin, add the following to your `trac.ini` file:

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

== Configuration

Activate user completion for custom fields using the following sample configuration:
{{{#!ini
[autocomplete]
fields = tester, reviewer
multi_fields = users
}}}

The `multi_fields` option allows autocompletion of multiple (comma-separated) values, and behaves like the CC field.

== Recent Changes

[[ChangeLog(autocompleteusersplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:k0s] [[BR]]
'''Maintainer:''' jun66j5, [[Maintainer]] [[BR]]
'''Contributors:''' [wiki:tenzochris], [wiki:manski Sebastian Krysmanski], mitar, manski, chrisheller, rjollos [[BR]]