Changes between Version 44 and Version 45 of AutocompleteUsersPlugin

Timestamp:

Sep 1, 2016, 7:33:01 AM (8 years ago)

Author:

figaro

Comment:

Split functional description and technical description

AutocompleteUsersPlugin

@@ -5 +5 @@
 == Description
 
-This plugin allows AJAX completion 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. 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. 
+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:
@@ -12 +12 @@
  * Ticket custom fields (forthcoming).
 
-'''Note:''' Email addresses shown by this plugin are handled accordingly 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.
+[[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
@@ -46 +50 @@
 }}}
 
-== Configuration
-
 After installing the plugin, add the following to your `trac.ini` file:
 
@@ -54 +56 @@
 autocompleteusers.* = enabled
 }}}
-
-== Example
-
-Screenshot of the plugin in action:
-
-[[Image(screenshot.png)]]
 
 == Recent Changes