lire::reportparser::htmldocbookformatter(3pm) [debian man page]
HTMLDocBookFormatter(3pm) LogReport's Lire Documentation HTMLDocBookFormatter(3pm) 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
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. Lire 2.1.1 2006-07-23 HTMLDocBookFormatter(3pm)
Check Out this Related Man Page
LaTeXDocBookFormatter(3pm) LogReport's Lire Documentation LaTeXDocBookFormatter(3pm) NAME
Lire::ReportParser::LaTeXDocBookFormatter - Lire::DocBookParser subclass which formats description to LaTeX. SYNOPSIS
To convert a DocBook decription to LaTeX: use Lire::ReportParser::LaTeXDocBookFormatter qw/dbk2latex/; my $LaTeX = dbk2latex( "<para>Test</para>" ); DESCRIPTION
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::LaTeXDocBookFormatter Lire::ReportParser processors that would like to work with text version of the description should inherit from Lire::ReportParser::LaTeXDocBookFormatter 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::LaTeXDocBookFormatter should be listed before Lire::ReportParser in the @ISA. The LaTeXDocBookFormatter doesn't inherit directly from Lire::ReportParser so that it can be used in multiple inheritance scenario. dbk_start_processing() Initializes the parser's structure for formatting DocBook XML as ASCII. This is used from the description_start implementation. dbk_end_processing() Cleans the parser structure. This is used from the description_end() implementation. handle_description( $description ) This method is invoked after the closing tag of the "description" element is encountered. The $description contains the description converter to LaTeX. PROCESSING LaTeX DESCRIPTION The generate LaTeX is encoded in UTF-8, so Omega must be used to process it. Additionnally, the result of calling dbk_latex_environment() should be added to the document preambule. It adds some environment and command definitions used by the formatter. FORMATTING DocBook STRINGS If you have DocBook content in a string, like you can obtain from some of the Report Specifications object, you can convert it to LaTeX by using the dbx2latex() function. dbk2txt( $docbook_str, [$columns] ) Returns a plain text version of the DocBook XML fragment $docbook_str. The "columns" parameter sets the number of columns in which the DocBook text should be formatted. This method will die() in case of error. SEE ALSO
Lire::ReportParser(3pm) VERSION
$Id: LaTeXDocBookFormatter.pm,v 1.4 2006/07/23 13:16:31 vanbaal Exp $ COPYRIGHT
Copyright (C) 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. AUTHOR
Francis J. Lacoste <flacoste@logreport.org> Lire 2.1.1 2006-07-23 LaTeXDocBookFormatter(3pm)