BugzillaLinkPlugin

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

The URLs and text prompts are fully configurable

Syntax Rules

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

Short hand reference	What it does
%BUG{#####}%	Creates a link to a specific bug.
%BUGLISTMS{target_milestone}%	Creates a link to a list of bugs with the specified target_milestone.
%BUGLISTKEY{keyword1+...+keywordn}% %BUGLISTKEY{keyword1,...,keywordn}	Creates a link to a list of bugs with one or more of the specified keywords. Using comma separators will generate an OR-type search.
%MYBUGS{[email protected]}%	Creates a link to a list of bugs assigned to [email protected].

Examples

You type:	You get: (simulated)	You get: (if installed)
%BUG{242971}%	Bug #242971	%BUG{242971}%
%BUGLISTMS{Firefox1.0}%	Buglist for milestone Firefox1.0	%BUGLISTMS{Firefox1.0}%
%BUGLISTKEY{highrisk,64bit}%	Buglist for keyword(s) "highrisk,64bit"	%BUGLISTKEY{highrisk,64bit}%
%BUGLISTKEY{crash+fonts}%	Buglist for keyword(s) "crash+fonts"	%BUGLISTKEY{crash+fonts}%
%MYBUGS{[email protected]}%	Buglist for [email protected]	%MYBUGS{[email protected]}%

BugzillaLinkPlugin Settings

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

Setting are not read from this topic. To customize your settings, copy them to your Main.SitePreferences topic, or in individual WebPreferences or in-topic settings.

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

• Set BUGZILLALINKPLUGIN_DEBUG = 0

URL references to your Bugzilla installation and to the bug image

• Set BUGZILLALINKPLUGIN_BUGURL = http://bugzilla.mozilla.org/show_bug.cgi?id=
• Set BUGZILLALINKPLUGIN_BUGLISTURL = http://bugzilla.mozilla.org/buglist.cgi?
• Set BUGZILLALINKPLUGIN_BUGIMGURL = /pub/System/BugzillaLinkPlugin/bug_small.png

Text references for automatic substitution

• Set BUGZILLALINKPLUGIN_BUGTEXT = Bug #
• Set BUGZILLALINKPLUGIN_MILESTONEBUGLISTTEXT = Buglist for milestone
• Set BUGZILLALINKPLUGIN_KEYWORDSBUGLISTTEXT = Buglist for keyword(s)
• Set BUGZILLALINKPLUGIN_MYBUGLISTTEXT = Buglist for user

Installation

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Plugin Info

Change History:
10 Apr 2017 (1.400)	Ported to Foswiki, Modernize, change to use Registered macros, eliminate plugin topic settings.
03 Oct 2005 (1.300)	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

Related Topics: DefaultPreferences, SitePreferences, InstalledPlugins