BugzillaLinkPlugin

Introduction

This plugin provides shorthand for linking to Bugzilla bugs without specifying a URL in longhand. It is most useful if you are using a local copy of Bugzilla for issue/ticket/bug tracking, and want to reference it from your topic.

Features

• Short hand references for:
• Individual bugs
• Lists of bugs assigned to a given milestone (or its beta)
• Lists of bugs matching one or more keywords
• Lists of the specified user's assigned bugs
• URLs and text prompts are fully configurable

Syntax Rules

The following %BUG*{...}% short hand references are supported:

Examples

You type:	You get: (simulated)	You get: (if installed)
%BUG{242971}%	Bug #242971	Bug #242971
%BUGLISTMS{Firefox1.0}%	Buglist for milestone Firefox1.0	Buglist for milestone Firefox1.0
%BUGLISTKEY{highrisk,64bit}%	Buglist for keyword(s) "highrisk,64bit"	Buglist for keyword(s) "highrisk,64bit"
%BUGLISTKEY{crash+fonts}%	Buglist for keyword(s) "crash+fonts"	Buglist for keyword(s) "crash+fonts"
%MYBUGS{shaver@mozilla.org}%	Buglist for shaver@mozilla.org	Buglist for user shaver@mozilla.org

BugzillaLinkPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %RENDERPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Link to Bugzilla bugs using shorthand references

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • Set DEBUG = 0

• URL references to your Bugzilla installation and to the bug image
  • Set BUGURL = https://bugs.lcfg.org/show_bug.cgi?id=
  • Set BUGLISTURL = https://bugs.lcfg.org/buglist.cgi?
  • Set BUGIMGURL =

• Text references for automatic substitution
  • Set BUGTEXT = Bug #
  • Set MILESTONEBUGLISTTEXT = Buglist for milestone
  • Set KEYWORDSBUGLISTTEXT = Buglist for keyword(s)
  • Set MYBUGLISTTEXT = Buglist for user

Limitations and Known Issues

• Many other sorts of linking is possible, but not yet implemented.
• This plugin could be refactored to work with many other sorts of bug tracking software, not limited to but including:
  • RT
  • Mantis
  • DDTS (see TWiki:Plugins.AutolinkDDTSPlugin)

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip BugzillaLinkPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/BugzillaLinkPlugin.txt	Plugin topic
  lib/TWiki/Plugins/BugzillaLinkPlugin.pm	Plugin Perl module
  pub/TWiki/BugzillaLinkPlugin/*.gif	Image files for themes
  pub/TWiki/BugzillaLinkPlugin/*.png	Image files for themes

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:
  • See if the above example works

Plugin Info

Plugin Author:	TWiki:Main.FlorianGnaegi
Copyright:	© 2002 TWiki:Main.FlorianGnaegi; © 2008-2010, TWiki:TWiki.TWikiContributor
License:	GPL (Gnu General Public License)
Plugin Version:	2010-08-30 (V1.301)
Change History:
2010-08-30:	TWikibug:Item6530: Doc improvements; changed TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
03 Oct 2005	Fixes for Dakar, added BUGLISTKEY function, refactored Settings (TWiki:Main.JoanTouzet)
08 Jul 2003	Added MYBUGS function (TWiki:Main.SteveKostecke), dealing with whitespace (TWiki:Main.AlanShields)
19 Aug 2002	Added BUGLIST function, renamed to BugzillaLinkPlugin (TWiki:Main.AnthonPang ?)
15 Aug 2002	Initial version
CPAN Dependencies:	none
Other Dependencies:	A working Bugzilla installation
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/BugzillaLinkPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/BugzillaLinkPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/BugzillaLinkPluginAppraisal

Related Topics: TWikiPreferences, TWikiPlugins