• NAME
• SYNOPSIS
• DESCRIPTION
• LICENSE
• AUTHOR
• COPYRIGHT AND LICENSE
• METHODS
  • new
  • init
  • cleanup

NAME

Templer::Plugin::SiteMap - Generate a SiteMap automatically.

SYNOPSIS

This plugin must be enabled by adding two settings in the global configuration file; the name of the file to generate and the prefix of the output URLs.

The following is a good example:

  sitemap_file = /sitemap.xml
  sitemap_base = http://example.com/

DESCRIPTION

This plugin will generate a simple sitemap.xml file including references to all pages which templer knows about.

LICENSE

This module is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version, or

b) the Perl "Artistic License".

AUTHOR

Steve Kemp <steve@steve.org.uk>

COPYRIGHT AND LICENSE

Copyright (C) 2016 Steve Kemp <steve@steve.org.uk>.

This library is free software. You can modify and or distribute it under the same terms as Perl itself.

METHODS

new

Constructor. No arguments are required/supported.

init

Initialisation function, which merely saves a reference to the Templer::Site object.

cleanup

This method is invoked when site-generation is complete, and this is where we generate the sitemap, if our two required configuration values are present in the configuration file.

If configuration-variables are not setup then we do nothing.