NAME
CGI::WPM::SegTextDoc - Demo of HTML::Application that displays a static text page, which can be in multiple segments.
DEPENDENCIES
Perl Version
5.004Standard Modules
I<none>Nonstandard Modules
HTML::Application 0.4
CGI::WPM::Base 0.4
CGI::WPM::Static 0.4SYNOPSIS
Display A Text File In Multiple Segments
my %CONFIG = (
title => 'Index of the World',
author => 'Jules Verne',
created => 'Version 1.0, first created 1993 June 24',
updated => 'Version 3.1, last modified 2000 November 18',
filename => 'jv_world.txt',
segments => 24,
);You need to have a subdirectory named "jv_world" that contains the 24 files that correspond to the segments, named "jv_world_001.txt" through "...024.txt".
Display A Text File All On One Page
my %CONFIG = (
title => 'Pizza Joints In New York',
author => 'Oscar Wilder',
created => 'Version 0.5, first created 1997 February 17',
updated => 'Version 1.2, last modified 1998 March 8',
filename => 'ow_pizza.txt',
segments => 1, # also the default
);You need to have a single file named "ow_pizza.txt", not in a subdirectory.
DESCRIPTION
This Perl 5 object class is part of a demonstration of HTML::Application in use. It is one of a set of "application components" that takes its settings and user input through HTML::Application and uses that class to send its user output. This demo module set can be used together to implement a web site complete with static html pages, e-mail forms, guest books, segmented text document display, usage tracking, and url-forwarding. Of course, true to the intent of HTML::Application, each of the modules in this demo set can be used independantly of the others.
SYNTAX
This class does not export any functions or methods, so you need to call them using object notation. This means using Class->function() for functions and $object->method() for methods. If you are inheriting this class for your own modules, then that often means something like $self->method().
PUBLIC FUNCTIONS AND METHODS
main( GLOBALS )
You invoke this method to run the application component that is encapsulated by this class. The required argument GLOBALS is an HTML::Application object that you have previously configured to hold the instance settings and user input for this class. When this method returns then the encapsulated application will have finished and you can get its user output from the HTML::Application object.
PREFERENCES HANDLED BY THIS MODULE
This POD is coming when I get the time to write it.
title # title of the document
author # who made the document
created # date and number of first version
updated # date and number of newest version
filename # common part of filename for pieces
segments # number of pieces doc is inAUTHOR
Copyright (c) 1999-2001, Darren R. Duncan. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. However, I do request that this copyright information remain attached to the file. If you modify this module and redistribute a changed version then please attach a note listing the modifications.
I am always interested in knowing how my work helps others, so if you put this module to use in any of your own code then please send me the URL. Also, if you make modifications to the module because it doesn't work the way you need, please send me a copy so that I can roll desirable changes into the main release.
Address comments, suggestions, and bug reports to perl@DarrenDuncan.net.
SEE ALSO
perl(1), HTML::Application, CGI::WPM::Base, CGI::WPM::Static.