NAME
PerlPoint::Template - PerlPoint template handler
VERSION
This manual describes version 0.01.
SYNOPSIS
DESCRIPTION
METHODS
new()
Parameters:
- class
-
The class name.
Returns: the new object.
Example:
Templates
Templates allow to specify common page (part) patterns, specialized for certain pages via keywords or functions. Various templating systems are around, and it is basically possible to use each of them in conjunction with PerlPoint. Nevertheless, there need to be "engine" modules available, which help to pass data back and forth between the PerlPoint system and your templates.
EOS } }
# common preprocessing: provide usually used data in a template independent data structure sub preprocessData { # get and check parameters ((my __PACKAGE__ $me), my ($page))=@_; confess "[BUG] Missing object parameter.\n" unless $me; confess "[BUG] Object parameter is no ", __PACKAGE__, " object.\n" unless ref $me and $me->isa(__PACKAGE__); confess "[BUG] Missing page data parameter.\n" unless $page;
# declare variables
my ($rc);
# get options
my $options=$me->options;
# get page number
$rc->{pageNr}=$me->numberOfChapters();
# get data of the first page
$rc->{fNumber}=$me->pageBySpec('first', $page);
$rc->{fPage}=$me->page($rc->{fNumber});
$rc->{fFile}=$me->buildFilename($rc->{fNumber});
$rc->{fText}=$rc->{fPage}->path(type=>'spath', mode=>'title');
# get data of the current page
$rc->{cPage}=$me->page($page);
$rc->{cFile}=$me->buildFilename($page);
$rc->{cText}=$rc->{cPage}->path(type=>'spath', mode=>'title');
$rc->{cVars}=$rc->{cPage}->vars();
# get data of the parent page (one level above)
$rc->{uNumber}=$me->pageBySpec('up', $page);
$rc->{uPage}=$me->page($rc->{uNumber});
$rc->{uFile}=$me->buildFilename($rc->{uNumber}) || '';
$rc->{uText}=defined $rc->{uPage} ? $rc->{uPage}->path(type=>'spath', mode=>'title') : '';
# get data of the previous page
$rc->{pNumber}=$me->pageBySpec('previous', $page);
$rc->{pPage}=$me->page($rc->{pNumber});
$rc->{pFile}=$me->buildFilename($rc->{pNumber}) || '';
$rc->{pText}=defined $rc->{pPage} ? $rc->{pPage}->path(type=>'spath', mode=>'title') : '';
$rc->{pVars}=defined $rc->{pPage} ? $rc->{pPage}->vars() : {};
# get data of the next page
$rc->{nNumber}=$me->pageBySpec('next', $page);
$rc->{nPage}=$me->page($rc->{nNumber});
$rc->{nFile}=$me->buildFilename($rc->{nNumber}) || '';
$rc->{nText}=defined $rc->{nPage} ? $rc->{nPage}->path(type=>'spath', mode=>'title') : '';
# get data of the last page
$rc->{lNumber}=$me->pageBySpec('last', $page);
$rc->{lPage}=$me->page($rc->{lNumber});
$rc->{lFile}=$me->buildFilename($rc->{lNumber});
$rc->{lText}=$rc->{lPage}->path(type=>'spath', mode=>'title');
# prebuild more replacement strings
$rc->{doctitle}=$me->{generator}{options}{doctitle};
$rc->{title}=$rc->{cPage}->path(type=>'fpath', mode=>'title');
$rc->{tocFile}=$me->buildFilename('toc');
$rc->{indexFile}=$me->buildFilename('index');
# the page path has to be produced with links
my $cc=0;
my $pnArray=$rc->{cPage}->path(type=>'ppath', mode=>'array');
my $csArray=$rc->{cPage}->path(type=>'spath', mode=>'array');
$rc->{cPath}=[(exists $me->{options}{bootstrapaddress} ? [$me->{options}{bootstrapaddress}, 'Start'] : ()), map {[basename($me->buildFilename($pnArray->[$cc++])), $_];} @$csArray[0 .. $#{$csArray}-1]];
# supply data (does this need to become an object?)
$rc;
}# GENERATOR METHOD WRAPPERS ###########################################################
# To simplify the usage of the template module, we provide wrappers for various # generator methods. Yes, this slows things down, but improves usability.
sub numberOfChapters { # get and check parameters (my __PACKAGE__ $me)=@_; confess "[BUG] Missing object parameter.\n" unless $me; confess "[BUG] Object parameter is no ", __PACKAGE__, " object.\n" unless ref $me and $me->isa(__PACKAGE__);
# pass call through
shift;
$me->{generator}->numberOfChapters(@_);
}sub pageBySpec { # get and check parameters (my __PACKAGE__ $me)=@_; confess "[BUG] Missing object parameter.\n" unless $me; confess "[BUG] Object parameter is no ", __PACKAGE__, " object.\n" unless ref $me and $me->isa(__PACKAGE__);
# pass call through
shift;
$me->{generator}->pageBySpec(@_);
}sub page { # get and check parameters (my __PACKAGE__ $me)=@_; confess "[BUG] Missing object parameter.\n" unless $me; confess "[BUG] Object parameter is no ", __PACKAGE__, " object.\n" unless ref $me and $me->isa(__PACKAGE__);
# pass call through
shift;
$me->{generator}->page(@_);
}sub buildFilename { # get and check parameters (my __PACKAGE__ $me)=@_; confess "[BUG] Missing object parameter.\n" unless $me; confess "[BUG] Object parameter is no ", __PACKAGE__, " object.\n" unless ref $me and $me->isa(__PACKAGE__); confess "[BUG] Missing path arguments.\n" unless @_>1;
# pass call through
shift;
$me->{generator}->buildFilename(@_);
}# display a class specific copyright message sub _classCopyright { my ($class)=@_;
my $rootClass=__PACKAGE__;
$class=ref($class) if ref($class);
return '' unless $class and $class=~/^$rootClass/;
no strict 'refs';
(_classCopyright(@{join('::', $class, 'ISA')}), join('', $class, ' ', $class->VERSION, ' (c) ', ${join('::', $class, 'AUTHOR')}, ".\n"));
}# flag successful loading 1;
# = POD TRAILER SECTION =================================================================
NOTES
SEE ALSO
SUPPORT
A PerlPoint mailing list is set up to discuss usage, ideas, bugs, suggestions and translator development. To subscribe, please send an empty message to perlpoint-subscribe@perl.org.
If you prefer, you can contact me via perl@jochen-stenzel.de as well.
AUTHOR
Copyright (c) Jochen Stenzel (perl@jochen-stenzel.de), 2004. All rights reserved.
This module is free software, you can redistribute it and/or modify it under the terms of the Artistic License distributed with Perl version 5.003 or (at your option) any later version. Please refer to the Artistic License that came with your Perl distribution for more details.
The Artistic License should have been included in your distribution of Perl. It resides in the file named "Artistic" at the top-level of the Perl source tree (where Perl was downloaded/unpacked - ask your system administrator if you dont know where this is). Alternatively, the current version of the Artistic License distributed with Perl can be viewed on-line on the World-Wide Web (WWW) from the following URL: http://www.perl.com/perl/misc/Artistic.html
DISCLAIMER
This software is distributed in the hope that it will be useful, but is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, either expressed or implied, INCLUDING, without limitation, the implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR PURPOSE.
The ENTIRE RISK as to the quality and performance of the software IS WITH YOU (the holder of the software). Should the software prove defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE, MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even if they arise from known or unknown flaws in the software).
Please refer to the Artistic License that came with your Perl distribution for more details.