This extension contains functions for embeding bug information from the Bugzilla bug tracker  Related Links: Extension Overview, DekiScript Overview, Extension Demos.

Assembly: mindtouch.deki.services
SID: http://services.mindtouch.com/deki/draft/2007/12/dekiscript 

This service requires Deki Wiki 1.9.0 or later.

To enable this extension, follow these steps:

  1. Go to Service managmenent in the Control Panel of your wiki.
  2. Under Add Service, click on Local, and select type Extension.
  3. Enter a description and the extension SID: http://services.mindtouch.com/deki/d.../12/dekiscript
  4. Set the manifest to point to the Bugzilla.xml:
    1. Under config, make a key called "manifest" with value "http://whacked.net/bugzilla.xml"
  5. Add any additional configuration settings that are required by the extension (see below).
  6. Click on add service.
  7. By default, no namespace is specified - so the functions are accessed as simply link().  The reference below assumes you have created a namespace of "bugzilla"
    1. To create a namespace, under the service's preference, create a key called "namespace" with a value "bugzilla"
    2. Functions will then be accessible as "bugzilla.link()" instead of simply "link()"

Example:

Picture 1.png


Configuration:

Before the Bugzilla service can be used, it must be configured.

Config Key Description
bugzilla-uri URI to your Bugzilla installation. This URI + /show_bug.cgi needs to exist

Functions:

  1. bugzilla.link(id : num, state : bool, prefix : str) : xml

     

bugzilla.link(id : num, state : bool, prefix : str) : xml
Edit section

Embed a link to a Bugzilla bug report. A summary of the bug is shown when hovering over the link. If state is true (or omitted) then the link is crossed out when the bug is closed or resolved.  The word "bug" is prefixed to the link, but can be overridden by passing the "prefix" parameter.

Parameters:

Name Type Description
id int The bug number to link to
state bool Strikeout the link if the bug is closed or not
prefix string The string prefix to prepend to the bug ID/link

Samples:

      Output

A link to bug# 7801

{{ bugzilla.link(7801) }} 
Picture 4.png  

A link to bug# 7801 without striking the bug out

{{ bugzilla.link(7801, false) }} 
Picture 2.png  

A link to bug# 7801 using the prefix "buggy" instead

{{ bugzilla.link{id:7801, prefix:"buggy") }} 
Picture 3.png  

    

Tag page
Viewing 1 of 1 comments: view all
Since the function name is generic (i.e. link), I'd recommend you either keep the 'bugzilla' namespace or rename the function to something more specific like 'bug'.
Posted 18:42, 31 May 2008
Viewing 1 of 1 comments: view all
You must login to post a comment.
Powered by MindTouch Deki v.8.08.1