/ 
RTx-Tags-0.25
River stage zero No dependents
/ RTx::Tags

NAME

RTx::Tags - Tag Cloud support for RT via simple-searchable custom fields & more

SYNOPSIS

This module provides customizable tag clouds and extended search functions. The cloud--which displays whitespace, comma, semi-colon or delimited values stored in custom fields named Tags--is shown on Search/Simple.html, as is a brief summary of the new search features.

DESCRIPTION

Tag clouds are shown on the Simple Search page, and optionally on the front page as well. Clicking a tag cloud title takes you to an alternate display at Search/TagCloud.html, which includes an uncustomized cloud (Global), and individual clouds for every class of object with a tags custom field.

In order to make the tag cloud interactive, this module provides a syntax for accessing custom fields via Simple Search where .CFname:value searches for tickets where the custom field CFname matches value

Lastly, this module also make your Simple Search terms persist in the input field across queries. A generally useful feature, this facilitates drilling down through search results or cloud clicks.

INSTALL

Basic Functionality

#

Install this module in the usual way, and amend RT_SiteConfig.pm to include RTx::Tags in @Plugins.

No patching necessary! If you've previously applied SearchCustomField from the wiki or email list, or installed version 0.021 of this module, it is recomended that you revert the patch. No harm will come from not doing so, but it's best to keep RT core files vanilla where possible.

#

Create a custom field named Tags. Although Tags may be any type of custom field to whichever objects you want, the recommended Type is Enter one value with Applies to Tickets. The recommended Description is Freeform annotation for ready searching.

#

Apply Tags to the desired objects e.g; queue(s), or make it a global custom field.

Optional Features

  • Add TagCloud to $HomepageComponents in RT_SiteConfig.pm if you would like users to have the ability to display a Tag Cloud on the front page, and not just the Simple Search page.

  • Create (or change an existing) Tags as Enter one value with autocompletion.

    Note: Enter multiple values should also work, though it is untested.

  • Read the module configuration options, and customize to suit your taste.

    perldoc local/plugins/RTx-Tags/etc/Tags_Config.pm

CAVEATS

  • Due to limitations in the available callbacks, the CF search blurb and tags cloud are output before the core search mechanism blurbs on Simple Search; postform is ugly.

  • Due to limitations in the available callbacks, every page links to cloud.css, which has also been hard-coded to 26 levels.

  • Due to the mechanism used to implement the CF search, the presence of another Search/Googleish_Local.pm will likely not result in behavior you desire. Should you wish to make further local customizations, either modify this module's code, or use Googleish_Vendor.pm

  • If using Postgres, you may want to make custom field searches case-insensitive http://lists.bestpractical.com/pipermail/rt-users/2009-January/056645.html

SEE ALSO

RT::Search::Googleish_Local, "plugins/RTx-Tags/etc/Tags_Config.pm" in local

AUTHOR

Jerrad Pierce <jpierce@cpan.org>

A heavily customized version of Leon Brocard's HTML::TagCloud v0.34 has been inlined since v0.10.

Modified portions of RT 3.8.x are also included.

LICENSE

The same terms as perl itself.