NAME

Chronicle::Plugin::Snippets::AllTags - Generate a list of tags.

DESCRIPTION

This module will be invoked automatically when your site is built via the on_generate hook which Chronicle provides.

It is responsible for creating the a data-structure to show all previously-used tags.

To use this in your templates add the following:

<!-- tmpl_if name='all_tags' -->
  <li>
  <!-- tmpl_loop name='all_tags' -->
    <li><a href="/tags/<!-- tmpl_var name='tag' -->"><!-- tmpl_var name='tag' --></a></li>
  <!-- /tmpl_loop name='all_tags' -->
  </ul>
<!-- /tmpl_if name='all_tags' -->

METHODS

Now follows documentation on the available methods.

on_initiate

The on_initiate method is automatically invoked just before any on_generate methods which might be present.

This method updates the global variables, which are made available to all loaded templates, to define a all_tags variable containing the all the tags which have ever been used within a blog, along with their use-counts.

_order

This plugin must be called "early".

This means we're called prior to any of the page-generation plugins, such that any page-templates which make use of the data-structure we've created are called after that structure is setup.

This method is present such that Module::Pluggable::Ordered can order our plugins.

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>