/ 
Posy-0.10
/ Posy::Plugin::LocalDepth

NAME

Posy::Plugin::LocalDepth - Posy plugin to filter by local depth

VERSION

This describes version 0.10 of Posy::Plugin::LocalDepth.

SYNOPSIS

    @plugins = qw(Posy::Core Posy::Plugin::LocalDepth));
    @actions = qw(header
	    ...
	    select_by_path
	    filter_by_date
	    filter_by_localdepth
	    ...
	);

DESCRIPTION

This plugin restricts entries to those within the $localdepth config setting -- the "depth" of the entry is compared to the "depth" of the current category and if the difference is more than "localdepth minus 1" then that entry is not included in the list.

That is, with a localdepth of 1, then only entries with the same depth as the current category are included.

If localdepth is zero, then all entries are included.

One needs to add the 'filter_by_localdepth' action to the actions list.

Configuration

This expects configuration settings in the $self->{config} hash, which, in the default Posy setup, can be defined in the main "config" file in the data directory.

localdepth

The "local" depth to check. If zero, then no localdepth checking is done.

OBJECT METHODS

Documentation for developers and those wishing to write plugins.

init

Do some initialization; make sure that default config values are set.

filter_by_localdepth

$self->filter_by_localdepth(\%flow_state);

Select entries by looking at the local-depth information in $self->{path}. Assumes that $flow_state->{entries} has already been populated; updates it.

REQUIRES

Posy
Posy::Core

Test::More

SEE ALSO

perl(1). Posy

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 by Kathryn Andersen

Based on the blosxom 'toc' plugin by Gregor Rayman (copyright 2003) <rayman <at> grayman <dot> de>

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