NAME¶
Lire::Plugin - Base interface of all Lire plugins.
SYNOPSIS¶
use base qw/ Lire::Plugin /;
DESCRIPTION¶
This package defines the base interface implemented by all plugins.
DEFAULT CONSTRUCTOR¶
The plugin class has
new() constructor which blesses an hash reference.
name()¶
Returns the name of the plugin.
title()¶
Returns a more human friendly name for the plugin.
description()¶
Returns a DocBook XML based documentation of the plugin.
type¶
Returns the type of plugin. There are three plugin types in Lire:
- dlf_converter
- These plugins are used to converter log files to DLF.
Plugin will also need to implement the Lire::DlfConverter interface.
- output_format
- These plugins are used to format XML reports. Plugin of
this type should implement the Lire::OutputFormat interface.
- dlf_analyser
- These plugins are used to generate other DLF records from
existing Dlf records. They should implement the Lire::Analaser
interface.
- chart_type
- These plugins are used to generate charts.
SEE ALSO¶
Lire::PluginManager(3pm),
Lire::DlfConverter(3pm),
Lire::OutputFormat(3pm),
Lire::DlfAnalyser(3pm),
Lire::DlfChartType(3pm)
AUTHOR¶
Francis J. Lacoste <flacoste@logreport.org>
VERSION¶
$Id: Plugin.pm,v 1.5 2006/07/23 13:16:29 vanbaal Exp $
COPYRIGHT¶
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org
This file is part of Lire.
Lire is free software; you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.
POD ERRORS¶
Hey!
The above document had some coding errors, which are explained
below:
- Around line 108:
- You forgot a '=back' before '=head1'