Lire::ReportParser::AsciiDocBookFormatter3pm

Usage

    use Lire::ReportParser::AsciiDocBookFormatter qw/dbk2txt/;
    my $txt = dbk2txt( "<para>Test</para>" );

    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;
    }

Overview

This package implements methods that can handle the content of "description" elements and it can be used by a subclass of Lire::ReportParser. Client only have to inherit from this module so that a handle_description() method is available to process the text formatted DocBook description.

This module also provide a convenient dbk2txt() function which can be used to format a string containing DocBook elements into an ASCII equivalent.

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 description_start(), description_end()methods, they must link to their parents' version using "SUPER::".

Additionnally, they should merge the value elements_spec() in their elements_spec() implementation.

The Lire::ReportParser::AsciiDocBookFormatter should be listed before Lire::ReportParser in the @ISA. The AsciiDocBookFormatter doesn't inherit directly from Lire::ReportParser so that it can be used in multiple inheritance scenario.

The subclass should call the init_docbook_formatter() method from their constructor method to initialize the DocBookFormatter module.

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 dbx2txt() function.

Version

$Id: AsciiDocBookFormatter.pm,v 1.13 2006/07/23 13:16:31 vanbaal Exp $