[[PageOutline(2-5,Contents,pullout)]]
= Add ticket keywords from a configured list =

== Description ==

This plug-in allows you to add entries to the Keywords entry field from a configured list of keywords by clicking on them.

Allows to set a description for every keyword, which is shown as a tip when you cross over the mouse on the keyword from "Add keywords" section.

== Usage ==

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 add manually other keywords weren't listed.

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

[[Image(TracKeywordsPlugin-atTicket.png)]]

== Bugs/Feature Requests == 

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

If you have any issues, create a [http://trac-hacks.org/newticket?component=TracKeywordsPlugin&owner=rjollos new ticket].

== Install/Configuration ==
 
  1. Proceed with normal installation of plugins.
  1. Update the ticket template page to include this plugin page section ("Add keywords").[[BR]]
      * You can do this by including the following line somewhere in the `keywords.html` file:
{{{
<xi:include href="keywords.html" />
}}} 
          * Suggested place: right before `</body>` tag. 
          * Where to locate files @ Trac 0.12:
            * `<trac_egg>/trac/ticket/templates/ticket.html`
            * `<trac_egg>/trac/wiki/templates/wiki_edit.html` (For a slight integration with TagsPlugin, see #8799)
          * Trac 0.10 `ticket.cs` file:
{{{
...
</fieldset><?cs /if ?>;

<?cs include "keywords.cs" ?>

<?cs if:ticket.actions.accept || ticket.actions.reopen ||
        ticket.actions.resolve || ticket.actions.reassign ?>
...
}}}
  1. '''Configure''' `trac.ini` file, with you required keywords:
     * Format `<name> = <description>`, where description will shown as a tip.
     * Example:
{{{
[keywords]
dupsearch = find duplicates for this ticket
deploy = waiting to be deployed
backport = ask for a decision on whether to backport
}}}
  1. '''Restart''' web server:
{{{
#!sh
$ sudo /etc/init.d/apache2 restart
}}}

== Source & Download ==

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

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

=== Recent Changes ===

[[ChangeLog(trackeywordsplugin, 3)]]

== Author/Contributors ==

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

== See also ==

 KeywordSuggestPlugin.