Lire::ReportParser::HTMLDocBookFormatter.3pm

Langue: en

Autres versions - même langue

Version: 2006-07-23 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Lire::ReportParser::HTMLDocBookFormatter - Lire::ReportParser subclass which formats description.

SYNOPSIS

To format DocBook: 
     use Lire::ReportParser::HTMLDocBookFormatter qw/dbk2html/;
 
     my $txt = dbk2html( "<para>Test</para>" );

In XML Report processors :

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

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.

dbk2html( $docbook_str, [$columns], [$xhtml] )

Returns an HTML version of the DocBook XML fragment $docbook_str. The "columns" parameter sets the number of columns in which the DocBook HTML text should be formatted. The "xhtml" parameter defines whether the generated code will be XHTML-compliant; the default is yes.

This method will die() in case of error.

SEE ALSO

Lire::ReportParser(3pm) Lire::ReportParser::AsciiDocBookFormatter(3pm)

VERSION

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

AUTHORS

   Francis J. Lacoste <flacoste@logreport.org>
   Wolfgang Sourdeau <wolfgang@logreport.org>
Copyright (C) 2001-2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

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.

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.

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.