NAME

Chronicle::Plugin::Generate::Tags - Generate tags pages.

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 top-level /tags/ hierarchy.

METHODS

Now follows documentation on the available methods.

on_generate

The on_generate method is automatically invoked to generate output pages. This particular plugin method is invoked after any on_initiate methods which might be present.

This method is responsible for generating the tag-output, which includes two sets of pages:

/tags/index.html

This is created using the tag_index.tmpl theme-template, and contains a list of all the tags which have ever been used.

/tags/$tag/index.html

This is created for each distinct tag, from the theme-template tag.tmpl

If either template is missing then this plugin will skip that part of the generation.

_outputTags

Output a page (`output/tags/$tag/index.html`) for each distinct tag we've ever used.

_getRelated

Return any tags related to that specified.

_outputTagCloud

Output `output/tags/index.html` containing a complete tag-cloud of the tags we've ever used.

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>