NAME
Mail::LMLM::Render - rendering backend for LMLM
SYNOPSIS
use Mail::LMLM::Render::HTML;
open O, ">out.html";
my $r = Mail::LMLM::Render::HTML->new(\*O);
$r->start_document("My Document", "Head Title");
$r->start_section("Google", { 'title_url' => "http://www.google.com/", });
$r->para("Google is a very nice search engine.");
$r->end_section();
$r->end_document();
close(O);DESCRIPTION
The Mail::LMLM::Render is a base class for rendering hypertext. It is used by LMLM extensively as a thin layer around the actual format.
To use it open a filehandle, and call the package's new constructor with a refernce to the filehandle. Afterwards call the start_document method (documented below), and when you're done call the end_document method. For each section call start_section and end_section explicitly.
METHODS
start_document($head_title, $body_title)
Starts the document. $head_title will be displayed at the title of the Window. $body_title will be displayed as a headline in the main text.
end_document()
Terminates the document.
start_section($title [, { 'title_url' => $url } ])
Starts a section titled $title. The second optional paramter contains options. Currently one option is available: 'title_url' which is a URL for the section to point to.
end_section()
Terminates a section.
start_para()
Starts a paragraph.
end_para()
Ends the current paragraph.
text($text [, $style])
Outputs the text $text. $style is an optional reference to a hash that contains style parameters. A true 'bold' value makes the text bold. A true 'underline' value makes the text underline. A true 'italic' value makes the text italic.
newline()
Outputs a newline.
start_link($url)
Starts a link to the URL $url.
end_link()
Terminates the current link.
indent_inc()
Increases the current indentation.
indent_dec()
Decreases the current indentation.
horizontal_line()
Outputs a hard rule to the document.
email_address($account,$host)
Outputs an E-mail address with a URL. The address is $account@$host.
url($url [, $inside])
Outputs a hyperlink to the URL $url with a text of $inside (which defaults to $url if not specified).
para($text [, $style])
Outputs the text $text with style $style (refer to the text() method) in its own paragraph.
AUTHOR
Shlomi Fish <shlomif@vipe.technion.ac.il>