.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AsciiDocBookFormatter 3pm"
.TH AsciiDocBookFormatter 3pm "2006-07-23" "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 \s-1XML\s0 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 \fIhandle_description()\fR method is available to process the text
formatted DocBook description.
.PP
This module also provide a convenient \fIdbk2txt()\fR function which can be
used to format a string containing DocBook elements into an \s-1ASCII\s0
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 \fIdescription_start()\fR,
\&\fIdescription_end()\fRmethods, they \fBmust\fR link to their parents' version
using \f(CW\*(C`SUPER::\*(C'\fR.
.PP
Additionnally, they should merge the value \fIelements_spec()\fR in their
\&\fIelements_spec()\fR implementation.
.PP
The Lire::ReportParser::AsciiDocBookFormatter should be listed before
Lire::ReportParser in the \f(CW@ISA\fR. The AsciiDocBookFormatter doesn't inherit
directly from Lire::ReportParser so that it can be used in multiple
inheritance scenario.
.PP
The subclass should call the \fIinit_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 "\fIdbk_start_processing()\fP"
.IX Subsection "dbk_start_processing()"
Initializes the parser's structure for formatting DocBook \s-1XML\s0 as \s-1ASCII\s0.
This is used from the description_start implementation.
.SS "\fIdbk_end_processing()\fP"
.IX Subsection "dbk_end_processing()"
Cleans the parser structure. This is used from the \fIdescription_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 \fIdbx2txt()\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 \s-1XML\s0 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 \fIdie()\fR in case of error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILire::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 \s-1GNU\s0 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 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.
.SH "AUTHOR"
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>