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

= Add ticket keywords from a configured list

== Description

This plugin allows you to add entries to the Keywords entry field from a configured list of keywords by clicking on them. 
Allows you to set a description for every keyword, which is shown as a tip when you hover the mouse over the keyword from "Add keywords" section.

From the "Add keywords" section:
 1. click once on any of the keywords you want to be filled-in into "Keywords" field;
 1. to remove a keyword click again on it.

You can also continue to manually add other keywords which weren't listed before.

To maintain keywords, edit the `[keywords]` section in your TracIni file `trac.ini`.

With default Trac only tickets can have keywords. However, if the TagsPlugin is loaded, then TracKeywordsPlugin will also supports its tags for wiki pages.

[[Image(TracKeywordsPlugin-atTicket.png,width=800, border=2)]]

See also: KeywordSuggestPlugin, LoomingCloudsPlugin, TagsPlugin

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

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

 1. The easiest way to '''install''' is probably with PIP:
{{{#!sh
$ pip install svn+https://trac-hacks.org/svn/trackeywordsplugin/trunk/
}}}
 1. Do not forget to '''enable''' the plugin by updating your TracIni file with:
 {{{#!ini
[components]
trackeywords.* = enabled
}}}
 1. See below how to '''configure''' your keywords .

== Configuration

Add keywords to the `[keywords]` section of TracIni. 
The format is `<name> = <description>`, where description is shown as a tooltip.

Example:
{{{#!ini
[keywords]
dupsearch = find duplicates for this ticket
deploy = waiting to be deployed
backport = ask for a decision on whether to backport
}}}

== Recent Changes

[[ChangeLog(trackeywordsplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:thomasvs] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' hasienda, ipm, nelsojost, [wiki:rea], rjollos