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


HTML-PageIndex documentation  | view source Contained in the HTML-PageIndex distribution.

Index


NAME

Top

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

SYNOPSIS

Top

 use HTML::PageIndex;

 $foo = new HTML::PageIndex;

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

 print $zog;

DESCRIPTION

Top

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]

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

Top

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

Top

None knows at time of writing.

AVAILABILITY

Top

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

AUTHOR INFORMATION

Top

Copyright 2002, Kevin Meltzer. This software is releases with no warranty, and under the terms of Perl itself.

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.


HTML-PageIndex documentation  | view source Contained in the HTML-PageIndex distribution.