wiki:TracKeywordsPlugin

Version 11 (modified by AdrianFritz, 3 years ago) (diff)

Added contibutor, redirect new tickets to current maintainer (rjollos)

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;
  2. 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.

Add keywords section in a Ticket

Bugs/Feature Requests

Existing bugs and feature requests for TracKeywordsPlugin are here.

If you have any issues, create a new ticket.

Install/Configuration

  1. Proceed with normal installation of plugins.
  2. Update the ticket template page to include this plugin page section ("Add keywords").
    • 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 ?>
        ...
        
  3. 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
      
  4. Restart web server:
    $ sudo /etc/init.d/apache2 restart
    

Source & Download

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

Download the zipped source from here.

Recent Changes

[13475] by rjollos on 2013-12-15 09:01:53
0.3dev: Show keywords on the NewTicket page. Fixes #11374.

Slightly modified version of patch by ipm. Tested with Trac 1.1.2dev-r12327. Lightly tested; please report any related issues to ticket #11374.

[11804] by rjollos on 2012-07-27 10:51:34
Refs #8799: Only add the keywords to the wiki_edit page if the TagsPlugin is enabled.

Tested with Trac 0.11 and Trac 1.0dev-r11158. Thanks to hasienda for contributing this code.

[11788] by rjollos on 2012-07-25 23:46:43
Refs #9872, #8799: Fixed defect introduced in [11771]: keywords would not be parsed from the keywords section in trac.ini. Thanks to asix for testing and reporting this.

Author/Contributors

Author: thomasvs
Maintainer: rjollos
Contributors: rea, nelsojost

See also

KeywordSuggestPlugin.

Attachments (1)

Download all attachments as: .zip