.\" -*- 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 "AsciiDocBookFormatter 3pm"
.TH AsciiDocBookFormatter 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::AsciiDocBookFormatter \- Lire::ReportParser subclass
which formats description.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
To format DocBook:
.PP
.Vb 1
\&    use Lire::ReportParser::AsciiDocBookFormatter qw/dbk2txt/;
\&
\&    my $txt = dbk2txt( "<para>Test</para>" );
.Ve
.PP
In XML Report processors :
.PP
.Vb 1
\&    package MyParser;
\&
\&    use base qw/ Lire::ReportParser::AsciiDocBookFormatter 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"
This package implements methods that can handle the content of
\&\f(CW\*(C`description\*(C'\fR elements and it can be used by a subclass of
Lire::ReportParser. Client only have to inherit from this module so
that a \fBhandle_description()\fR method is available to process the text
formatted DocBook description.
.PP
This module also provide a convenient \fBdbk2txt()\fR function which can be
used to format a string containing DocBook elements into an ASCII
equivalent.
.SH "USING Lire::ReportParser::AsciiDocBookFormatter"
.IX Header "USING Lire::ReportParser::AsciiDocBookFormatter"
Lire::ReportParser processors that would like to work with text
version of the description should inherit from
Lire::ReportParser::AsciiDocBookFormatter in addition to
Lire::ReportParser. If they override the \fBdescription_start()\fR,
\&\fBdescription_end()\fRmethods, they \fBmust\fR link to their parents\*(Aq version
using \f(CW\*(C`SUPER::\*(C'\fR.
.PP
Additionnally, they should merge the value \fBelements_spec()\fR in their
\&\fBelements_spec()\fR implementation.
.PP
The Lire::ReportParser::AsciiDocBookFormatter should be listed before
Lire::ReportParser in the \f(CW@ISA\fR. The AsciiDocBookFormatter doesn\*(Aqt inherit
directly from Lire::ReportParser so that it can be used in multiple
inheritance scenario.
.PP
The subclass should call the \fBinit_docbook_formatter()\fR method from
their constructor method to initialize the DocBookFormatter module.
.ie n .SS "init_docbook_formatter( %params )"
.el .SS "init_docbook_formatter( \f(CW%params\fP )"
.IX Subsection "init_docbook_formatter( %params )"
The initializer recognizes some parameters that can be used to control
the behavior of the DocBook handling:
.IP columns 4
.IX Item "columns"
The number of columns in which the DocBook text should be formatted.
Defaults to 72.
.SS \fBdbk_start_processing()\fP
.IX Subsection "dbk_start_processing()"
Initializes the parser\*(Aqs structure for formatting DocBook XML as ASCII.
This is used from the description_start implementation.
.SS \fBdbk_end_processing()\fP
.IX Subsection "dbk_end_processing()"
Cleans the parser structure. This is used from the \fBdescription_end()\fR 
implementation.
.ie n .SS "handle_description( $description )"
.el .SS "handle_description( \f(CW$description\fP )"
.IX Subsection "handle_description( $description )"
This method is invoked after the closing tag of the \f(CW\*(C`description\*(C'\fR
element is encountered. The \f(CW$description\fR contains the description
formatted in plain text.
.SH "FORMATTING DocBook STRINGS"
.IX Header "FORMATTING DocBook STRINGS"
If you have DocBook content in a string, like you can obtain from some
of the Report Specifications object, you can format it in plain text
using the \fBdbx2txt()\fR function.
.ie n .SS "dbk2txt( $docbook_str, [$columns] )"
.el .SS "dbk2txt( \f(CW$docbook_str\fP, [$columns] )"
.IX Subsection "dbk2txt( $docbook_str, [$columns] )"
Returns a plain text 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 text
should be formatted.
.PP
This method will \fBdie()\fR in case of error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportParser\fR\|(3pm)
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR AsciiDocBookFormatter.pm,v 1.13 2006/07/23 13:16:31 vanbaal Exp $
.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.
.SH AUTHOR
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>