Difference: BugzillaLinkPlugin (1 vs. 2)

Revision 22016-11-08 - squinney

Line: 1 to 1
 

BugzillaLinkPlugin

Revision 12010-08-30 - TWikiContributor

Line: 1 to 1
Added:
>
>

BugzillaLinkPlugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/BugzillaLinkPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/BugzillaLinkPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
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

You type: You get: (simulated) You get: (if installed)
%BUG{242971}% bug_small.png Bug #242971 bug_small.png Bug #242971
%BUGLISTMS{Firefox1.0}% bug_small.png Buglist for milestone Firefox1.0 bug_small.png Buglist for milestone Firefox1.0
%BUGLISTKEY{highrisk,64bit}% bug_small.png Buglist for keyword(s) "highrisk,64bit" bug_small.png Buglist for keyword(s) "highrisk,64bit"
%BUGLISTKEY{crash+fonts}% bug_small.png Buglist for keyword(s) "crash+fonts" bug_small.png Buglist for keyword(s) "crash+fonts"
%MYBUGS{shaver@mozilla.org}% bug_small.png Buglist for shaver@mozilla.org bug_small.png 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

  • 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

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:
<-- versions below in reverse order -->
 
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

META FILEATTACHMENT attr="h" comment="GIF Bug large" date="1029409171" name="bug.gif" path="/home/gnaegi/bug.gif" size="166" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="GIF Bug small" date="1029416770" name="bug_small.gif" path="/home/gnaegi/bug_small.gif" size="885" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="PNG Bug transparent" date="1029409171" name="bug_small.png" path="/home/gnaegi/bug.gif" size="166" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="PNG Bug, white background" date="1029409171" name="bug_small_white.png" path="/home/gnaegi/bug.gif" size="166" user="TWikiContributor" version="1"
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.BugzillaLinkPlugin.