NAME

Posy::Plugin::NotFound - Posy plugin to provide a custom Not Found page.

VERSION

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

SYNOPSIS

    @plugins = qw(Posy::Core
	...
	Posy::Plugin::NotFound));
    @actions = qw(init_params
	parse_path
	set_config
	process_path_error
	...
	);

DESCRIPTION

The purpose of this plugin is to provide the user with the ability to present a custom "Page Not Found" page, rather than the boring plain-text message which Posy::Core provides in the 'process_path_error' method.

Activation

Add the plugin to the plugin list.

This plugin replaces the 'process_path_error' method, replacing its actions with an alteration of the 'path' information so that the $self->{config}->{not_found_entry} will be displayed instead, as if it were a normal entry. Therefore the actions list may have to be rearranged so that 'set_config' is called before 'process_path_error'.

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 config directory.

not_found_entry

The relative path of the entry file to use for a Not Found page. This is expected to be somewhere under the data directory, and will be treated like a normal entry, except that it is only shown when there is a path-parsing error (that is, when a page is not found).

For example:

not_found_entry: errorpages/404.html

Those using the Posy::Plugin::Categories plugin may wish also to set the 'categories_hide' value, so that one can place the custom Not Found page into a directory which won't be displayed in the category_tree or breadcrumbs provided by the Posy::Plugin::Categories plugin.

OBJECT METHODS

Documentation for developers and those wishing to write plugins.

init

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

Flow Action Methods

Methods implementing actions.

process_path_error

If there was an error parsing the path ($self->{path}->{error} is true) then set up for displaying a custom 404 page defined by the 'not_found_entry' config value.

INSTALLATION

Installation needs will vary depending on the particular setup a person has.

Administrator, Automatic

If you are the administrator of the system, then the dead simple method of installing the modules is to use the CPAN or CPANPLUS system.

cpanp -i Posy::Plugin::NotFound

This will install this plugin in the usual places where modules get installed when one is using CPAN(PLUS).

Administrator, By Hand

If you are the administrator of the system, but don't wish to use the CPAN(PLUS) method, then this is for you. Take the *.tar.gz file and untar it in a suitable directory.

To install this module, run the following commands:

perl Build.PL
./Build
./Build test
./Build install

Or, if you're on a platform (like DOS or Windows) that doesn't like the "./" notation, you can do this:

perl Build.PL
perl Build
perl Build test
perl Build install

User With Shell Access

If you are a user on a system, and don't have root/administrator access, you need to install Posy somewhere other than the default place (since you don't have access to it). However, if you have shell access to the system, then you can install it in your home directory.

Say your home directory is "/home/fred", and you want to install the modules into a subdirectory called "perl".

Download the *.tar.gz file and untar it in a suitable directory.

perl Build.PL --install_base /home/fred/perl
./Build
./Build test
./Build install

This will install the files underneath /home/fred/perl.

You will then need to make sure that you alter the PERL5LIB variable to find the modules, and the PATH variable to find the scripts (posy_one, posy_static).

Therefore you will need to change: your path, to include /home/fred/perl/script (where the script will be)

PATH=/home/fred/perl/script:${PATH}

the PERL5LIB variable to add /home/fred/perl/lib

PERL5LIB=/home/fred/perl/lib:${PERL5LIB}

REQUIRES

Posy
Posy::Core

Test::More

SEE ALSO

perl(1). Posy

Posy::Plugin::Categories

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) 2005 by Kathryn Andersen http://www.katspace.com

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