Vetle Roeim > Formatter-HTML-MPS > Formatter::HTML::MPS

Download:
Formatter-HTML-MPS-0.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 0.4   Source  

NAME ^

    Formatter::HTML::MPS

DESCRIPTION ^

    This module converts MPS input to HTML. MPS is a simple format
    describing a presentation or a set of slides; it is a combination
    of the lightweight markup language Markdown and a separate markup
    language to configure this formatter.

    The slides are contained in a single HTML file, and should be
    shown as individual slides using CSS.

    It conforms with the Formatter API specification, version 0.95.

MPS FORMAT ^

    Each slide is formatted using the Markdown format. In addition to
    that, a simple format is used to set variables and to denote new
    slides.

    All MPS directives start with ';', and comments start with
    ';;'. Neither the MPS directives or comments will appear in the
    output.

    To indicate a new slide, use the 'newslide' directive. I.e., start
    the line with:

      ; newslide

    To set a configuration variable, use the 'set' directive. I.e.:

      ; set VAR = VALUE

    Currently, supported variables are:

      * output_format: only 'xhtml1.0_strict' is supported. Example:

        ; set output_format = xhtml1.0_strict

      * title: the title of the presentation.

SYNOPSIS ^

    use Formatter::HTML::MPS;
    my $formatter = Formatter::HTML::MPS->format( $mpsdata );

METHODS ^

format ( mpsdata )

    Initialize the formatter. Returns an instance of this formatter
    for the specified input.

document

    Returns the HTML formatting of the previously specified input.

title

    Returns the title of the document.

links

    Return the links in the document... At least that's what it should
    do when it's implemented.

fragment

BUGS ^

    Please let me know. :)

COPYRIGHT ^

Copyright 2006 Vetle Roeim <vetler@gmail.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.