.\" -*- 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 "HTMLDocBookFormatter 3pm"
.TH HTMLDocBookFormatter 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::ReportParser::HTMLDocBookFormatter \- Lire::ReportParser subclass
which formats description.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
To format DocBook:
.PP
.Vb 1
\&    use Lire::ReportParser::HTMLDocBookFormatter qw/dbk2html/;
\&
\&    my $txt = dbk2html( "<para>Test</para>" );
.Ve
.PP
In XML Report processors :
.PP
.Vb 1
\&    package MyParser;
\&
\&    use base qw/ Lire::ReportParser::HTMLDocBookFormatter Lire::ReportParser /;
\&
\&    sub new {
\&        my $self = shift\->SUPER::new( @_ );
\&
\&        $self\->init_docbook_formatter( @_ );
\&
\&        return $self;
\&    }
\&
\&    sub handle_description {
\&        my ( $self, $desc ) = @_;
\&
\&        print $desc;
\&
\&        return;
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lire::ReportParser::HTMLDocBookFormatter is the counterpart to
Lire::ReportParser::AsciiDocBookFormatter for the HTML output format. Please
read its documentation to learn how to use this class. Their use is exactly
the same.
.ie n .SH "dbk2html( $docbook_str, [$columns], [$xhtml] )"
.el .SH "dbk2html( \f(CW$docbook_str\fP, [$columns], [$xhtml] )"
.IX Header "dbk2html( $docbook_str, [$columns], [$xhtml] )"
Returns an HTML version of the DocBook XML fragment \f(CW$docbook_str\fR. The
\&\f(CW\*(C`columns\*(C'\fR parameter sets the number of columns in which the DocBook HTML text
should be formatted. The \f(CW\*(C`xhtml\*(C'\fR parameter defines whether the generated code
will be XHTML\-compliant; the default is yes.
.PP
This method will \fBdie()\fR in case of error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportParser\fR\|(3pm) \fBLire::ReportParser::AsciiDocBookFormatter\fR\|(3pm)
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR HTMLDocBookFormatter.pm,v 1.10 2006/07/23 13:16:31 vanbaal Exp $
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001\-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.