Bernard Simon > App-Followme > App::Followme::ConvertPage

Download:
App-Followme-1.92.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.92   Source  

NAME ^

App::Followme::ConvertPage - Convert Markdown files to html

SYNOPSIS ^

    use App::Followme::ConvertPage;
    my $converter = App::Followme::ConvertPage->new($configuration);
    $converter->run($folder);

DESCRIPTION ^

This module converts text files into web files by substtuting the content into a template. The type of file converted is determined by the value of the parameter data_pkg. By default, it converts Markdown files. After the conversion the original file is deleted.

Along with the content, other variables are calculated from the file name and modification date. Variables in the template are preceded by a sigil, most usually a dollar sign. Thus a link would look like:

    <li><a href="$url">$title</a></li>

CONFIGURATION ^

The following parameters are used from the configuration:

template_file

The name of the template file. The template file is either in the current directory, in the same directory as the configuration file used to invoke this method, or if not there, in the _templates subdirectory of the top directory. The default value is 'convert_page.htm'.

data_pkg

The name of the module that parses and retrieves data from the text file. The default value is 'App::Followme::MarkdownData', which parses Markdown files.

LICENSE ^

Copyright (C) Bernie Simon.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR ^

Bernie Simon <bernie.simon@gmail.com>

syntax highlighting: