Autocomplete feature for the Keywords field

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:

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

The plugin requires a JavaScript enabled browser. The JavaScript portion was derived from the jQuery UI ​autocomplete example.

See also LoomingCloudsPlugin, TracKeywordsPlugin, TagsPlugin

Bugs/Feature Requests

Existing bugs and feature requests for KeywordSuggestPlugin are here.

If you have any issues, create a new ticket.

defect	13 / 14
enhancement	6 / 7
task	3 / 3

Download

Download the zipped source from here.

Source

You can check out KeywordSuggestPlugin from here using Subversion, or browse the source​ with Trac.

Installation

General instructions on installing Trac plugins can be found on the TracPlugins page.

Configuration

The following section must be added to your trac.ini configuration file:

[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

17470 by rjollos on 2019-08-26 21:18:24

TracKeywordSuggest 0.5.0dev: Drop support for Trac < 1.0

17469 by rjollos on 2019-08-26 20:37:51

TracKeywordSuggest 0.5.0dev: Fix failing test cases

17189 by rjollos on 2018-06-03 23:14:12

TracKeywordSuggest 0.5.0dev: Fix rename error in r12103

Fixes #13433.

(more)

Author/Contributors

Author: scratcher
Maintainer: none (deprecated)
Contributors: itamarost, falkb, hasienda