GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::LMLM::RENDER (3)

.ds Aq ’

NAME

Mail::LMLM::Render - rendering backend for LMLM

CONTENTS

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 <B>newB> constructor with a refernce to the filehandle. Afterwards call the <B>start_documentB> method (documented below), and when you’re done call the <B>end_documentB> method. For each section call <B>start_sectionB> and <B>end_sectionB> explicitly.

METHODS

start_document($head_title, CW$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’ => CW$url } ])

Starts a section titled $title. The second optional paramter contains options. Currently the following options are available:
title_url A URL for the section to point to.
id An ID for the section heading. (similar to the id="" attribute in XHTML).

end_section()

Terminates a section.

start_para()

Starts a paragraph.

end_para()

Ends the current paragraph.

text($text [, CW$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 [, CW$inside])

Outputs a hyperlink to the URL $url with a text of $inside (which defaults to $url if not specified).

para($text [, CW$style])

Outputs the text $text with style $style (refer to the text() method) in its own paragraph.

AUTHOR

Shlomi Fish, <http://www.shlomifish.org> .
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::LMLM::RENDER (3) 2015-04-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.