.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Plugin 3pm"
.TH Plugin 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::Plugin \- Base interface of all Lire plugins.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use base qw/ Lire::Plugin /;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This package defines the base interface implemented by all plugins.
.SH "DEFAULT CONSTRUCTOR"
.IX Header "DEFAULT CONSTRUCTOR"
The plugin class has \fBnew()\fR constructor which blesses an hash
reference.
.SS \fBname()\fP
.IX Subsection "name()"
Returns the name of the plugin.
.SS \fBtitle()\fP
.IX Subsection "title()"
Returns a more human friendly name for the plugin.
.SS \fBdescription()\fP
.IX Subsection "description()"
Returns a DocBook XML based documentation of the plugin.
.SS type
.IX Subsection "type"
Returns the type of plugin. There are three plugin types in Lire:
.IP dlf_converter 4
.IX Item "dlf_converter"
These plugins are used to converter log files to DLF. Plugin will
also need to implement the Lire::DlfConverter interface.
.IP output_format 4
.IX Item "output_format"
These plugins are used to format XML reports. Plugin of this type
should implement the Lire::OutputFormat interface.
.IP dlf_analyser 4
.IX Item "dlf_analyser"
These plugins are used to generate other DLF records from existing
Dlf records. They should implement the Lire::Analaser interface.
.IP chart_type 4
.IX Item "chart_type"
These plugins are used to generate charts.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::PluginManager\fR\|(3pm), \fBLire::DlfConverter\fR\|(3pm),
\&\fBLire::OutputFormat\fR\|(3pm), \fBLire::DlfAnalyser\fR\|(3pm), \fBLire::DlfChartType\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Plugin.pm,v 1.5 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
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.
.PP
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.
.PP
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.