/ 
Posy-0.21
/ Posy::Plugin::LinkList

NAME

Posy::Plugin::LinkList - Posy plugin to give a dynamic list of links

VERSION

This describes version 0.21 of Posy::Plugin::LinkList.

SYNOPSIS

    @plugins = qw(Posy::Core
	...
	Posy::Plugin::TextTemplate
	...
	Posy::Plugin::LinkList
	...
	));

DESCRIPTION

This provides a method which can be called from the "head" flavour template (if one is using the TextTemplate plugin). When given an array of labels and a hash of labels-to-relative-links, will produce a list of links which take account of (a) what the current path is and (b) what the current flavour is. If the link matches the current path, then only the label is used for that link. If the extension part of the link matches the default flavour, then the current flavour replaces it.

With extra arguments, will change the style of the list; one can define pre_list, post_list, pre_item, post_item, and item separators -- this enables one to create an unordered list or a pipe-separated paragraph just by changing these values. Or one can give one's own CSS classes to the parts. The default is a plain <ul> list.

Helper Methods

Methods which can be called from elsewhere.

    $links = $self->link_list(labels => \@labels,
	links=>\%links,
	pre_list=>'<ul>',
	post_list=>'</ul>',
	pre_item=>'<li>',
	post_item=>'</li>'
	pre_active_item=>'<li><em>',
	post_active_item=>'</em></li>',
	item_sep=>"\n");

Generates a list of links.

Options:

labels

The labels for the links, in the order you want them displayed.

A hash of labels (as above) and the links they should point to.

pre_list

String to begin the list with.

post_list

String to end the list with.

pre_item

String to prepend to a non-active item.

post_item

String to append to a non-active item.

pre_active_item

String to prepend to an active item.

post_active_item

String to prepend to an active item.

item_sep

String to put between items.

REQUIRES

Posy
Posy::Core
Posy::Plugin::TextTemplate

Test::More

SEE ALSO

perl(1). Posy Posy::Plugin::TextTemplate Text::Template

BUGS

Please report any bugs or feature requests to the author.

AUTHOR

Kathryn Andersen (RUBYKAT)
perlkat AT katspace dot com
http://www.katspace.com

COPYRIGHT AND LICENCE

Copyright (c) 2004-2005 by Kathryn Andersen

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