NAME

HTML::PageIndex - Class to create HTML page index objects.

SYNOPSIS

use HTML::PageIndex;

$foo = new HTML::PageIndex;

$zog = $foo->makeindex([total pages],[current page],[base url],[url arguement],[show prev/next]);

print $zog;

DESCRIPTION

Will return an object which will display a dynamic index of html pages. It would look like:

[Prev] 1 2 3 4 5 6 [Next]

makeindex([total pages],[current page],[base url],[url arguement],[show prev/next]);

This is currently the only public method. The args are as follows:

[total pages] - How many total pages are there. 

[current page] - What the current page is. It is expected that the using script
		 would generate this.

[base url] - The base url to link to.

[url arguement] - May be "", but if it isn't it will build a 
		  URL with ?[URL arguement]=[page number]

[show prev/next] - Default is 0. If 0 it will not show [Prev] if you are on the
		first page, or [Next] if you are on the last page. If 1, it will 
		show [Prev] and [Next] as text.

INSTALLATION

You install HTML::PageIndex, as you would install any perl module library, by running these commands:

perl Makefile.PL
make
make install
make clean

BUGS

None knows at time of writing.

AVAILABILITY

The latest version of HTML::PageIndex should always be available from:

$CPAN/modules/by-authors/id/K/KM/KMELTZ/

Visit <URL:http://www.perl.com/CPAN/> to find a CPAN site near you.

Or, from <URL:http://www.perlguy.com/perl>.

VERSION

$Revision: 0.2 $ $Date: 1998/12/23 18:47:22 $

CHANGES

$Log: PageIndex.pm,v $ Revision 0.2 1998/12/23 18:47:22 meltzek Added POD.

AUTHOR INFORMATION

Copyright 1998-99, Kevin Meltzer. All rights reserved. It may be used and modified freely, but I do request that this copyright notice remain attached to the file. You may modify this module as you wish, but if you redistribute a modified version, please attach a note listing the modifications you have made.

Address bug reports and comments to: perlguy@perlguy.com

The author makes no warranties, promises, or gaurentees of this software. As with all software, use at your own risk.