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

= Autocomplete feature for the ''Keywords'' field

{{{#!box warn
**Notice:** The functionality of this plugin has been added to TagsPlugin (Component `tractags.web_ui.TagInputAutoComplete`). KeywordSuggestPlugin is unnecessary and should not be installed if you have TagsPlugin installed.
}}}

== Description

This plugin provides an autocomplete function for the '''Keywords''' ticket field or any other text-based ticket field. Optionally, it is possible to restrict the list of allowed keywords.

The '''Keywords''' field expands upon receiving focus:

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

The '''Keywords''' label can be the link to a wiki page.

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

The plugin requires a !JavaScript enabled browser. The !JavaScript portion was derived from the jQuery UI [http://jqueryui.com/demos/autocomplete#multiple autocomplete example].

See also LoomingCloudsPlugin, TracKeywordsPlugin, TagsPlugin

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

The following section must be added to your `trac.ini` configuration file:
{{{#!ini
[keywordsuggest]
field = keywords
keywords = tag1,tag2,tag3
mustmatch = False
helppage = wiki/TicketKeywords
helppage.newwindow = False
matchcontains = True
multipleseparator = ,
}}}

There are the following parameters to configure:
 * '''field''' - field to which the suggestion will be attached (default: keywords).
 * '''keywords''' - specifies list of comma separated values available for input.
 * '''mustmatch''' - 'keywords' field accepts values from the '''keywords''' list only, optional.
 * '''helppage''' - 'keywords' label will be turned into the link to a resource; this could be a wiki page, or any resource in any realm, such as the tags page (`helppage = tags`), optional.
 * '''helppage.newwindow''' - whether wiki page is opened in a new window or not, optional.
 * '''matchcontains''' - whether keywords which matched not from the beginning must be included into list, optional.
 * '''multipleseparator''' - the character(s) to use as separator between keywords. Must be enclosed with quotas or other characters. If not specified, then ', ' is used.

== Recent Changes

[[ChangeLog(keywordsuggestplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:scratcher] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' itamarost, falkb, hasienda [[BR]]