NAME

ROADS::Override - A class to override unusual/odd URL protocol schemes

SYNOPSIS

use ROADS::Override;
Override;
if ($override{"wais"}) {
  $page_to_return = $override{"wais"};
} else {
  $page_to_return = $regular_page;
}

DESCRIPTION

This class defines a method which constructs a hash array keyed on the protocol scheme element of a URL. Looking up a protocol scheme which have been overridden returns a filename which should be used instead of the filename which would normally be used. This provides a simple mechanism for insinuating intermediate pages of HTML when (for example) rendering search results into HTML, which can be used to add instructions or additional information as necessary.

METHODS

Override;

This method loads the list of protocols to override and HTML pages to return into the hash array override.

FILES

config/protocols unless overridden by the protocols variable.

FILE FORMAT

The protocols file is formatted with one entry per line. Each entry contains the following fields :-

scheme

The protocol scheme to override.

page

The intermediary HTML page to return when this protocol scheme is requested.

SEE ALSO

"lookupcluster.pl" in admin-cgi, "search.pl" in cgi-bin, "tempbyhand.pl" in cgi-bin, "waylay.pl" in cgi-bin

COPYRIGHT

Copyright (c) 1988, Martin Hamilton <martinh@gnu.org> and Jon Knight <jon@net.lut.ac.uk>. All rights reserved.

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

It was developed by the Department of Computer Studies at Loughborough University of Technology, as part of the ROADS project. ROADS is funded under the UK Electronic Libraries Programme (eLib), the European Commission Telematics for Research Programme, and the TERENA development programme.

AUTHOR

Martin Hamilton <martinh@gnu.org>