NAME

App::Followme::CreateIndex - Create index file for a directory

SYNOPSIS

    use App::Followme::CreateIndex;
    my $indexer = App::Followme::CreateIndex->new($configuration);
    $indexer->run($directory);

DESCRIPTION

This package builds an index for a directory containing links to all the files contained in it with the specified extensions. The variables described below are substituted into a template to produce the index. Loop comments that look like

    <!-- for @files -->
    <!-- endfor -->

indicate the section of the template that is repeated for each file contained in the index.

CONFIGURATION

The following fields in the configuration file are used:

template_file

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

data_pkg

The name of the class used to find and parse files included in the index. The default value is 'App::Followme::WebData', which handles html 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>