BugzillaLinkPlugin
Link to Bugzilla bugs using shorthand references
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:
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{user@some.domain}% |
Creates a link to a list of bugs assigned to user@some.domain . |
Examples
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
- URL references to your Bugzilla installation and to the bug image
- 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:
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
Related Topics: TWikiPreferences,
TWikiPlugins