NAME

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

VERSION

version 0.6807

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 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 [, $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, <http://www.shlomifish.org> .

SUPPORT

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.

<https://metacpan.org/release/Mail-LMLM>
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

<https://rt.cpan.org/Public/Dist/Display.html?Name=Mail-LMLM>
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/Mail-LMLM>
CPAN Testers
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/M/Mail-LMLM>
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Mail-LMLM>
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Mail::LMLM>

Bugs / Feature Requests

Please report any bugs or feature requests by email to "bug-mail-lmlm at rt.cpan.org", or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=Mail-LMLM>. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<https://github.com/shlomif/perl-mail-lmlm>

  git clone git://github.com/shlomif/perl-mail-lmlm.git

AUTHOR

Shlomi Fish

BUGS

Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/perl-mail-lmlm/issues>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This is free software, licensed under:

  The MIT (X11) License