08/01/2008

A blosxom plugin for gnats

During my work for pkgsrc I started to write articles for my blog and I referred to several PRs from the NetBSD gnats system. However I just wanted to type the PR in the form of e.g. NetBSD PR pkg/39230 and would like to have my blog software to link to the webpage automatically. I decided to write a small blosxom login for it and here it is.

gnats - blosxom plugin

A small plugin where you just type the PR number and blosxom will link against it. Guess what - all the three BSD project like FreeBSD, NetBSD and OpenBSD are supported right of the box. Ah, the default is NetBSD, of course.
Here is the current version of the plugin: download.

Please have a look at the perldoc configuration, too. Usually just drop the plugin into your plugins folder and it works right of the box.

NAME
SYNOPSIS

CONFIGURATION

VERSION
AUTHOR
LICENSE

NAME

gnats Plugin: gnats

SYNOPSIS

This plugin acts like a filter for your blosxom weblog. It replaces all occurrences of PR alike terms with the URL to the gnats system of the project. You don't have to care about writing in a special style, just write the text with the PR and it gets replaced. This includes the following forms:

 NetBSD PR pkg/1337
 NetBSD PR 1337
 PR 1337

This will be translated to the corresponding URL to the gnats system of the project.

CONFIGURATION

The %gnats_system variable can be configured with the gnats system you would like to be parsed by this filter. The different BSD projects are using gnats, they have been already preconfigured. Note the form of the entries which is:


 my %gnats_system = (
                    Project => '<url to gnats report view>,
                    );

The variable $default_gnats is used to determine the default project if the short form like 'PR 1232' is used. The value for this variable must match one of the Project values inside the %gnats_system.