PerlPoint::Generator::Object::Page - generators page object class
This manual describes version 0.03.
This is an internal class. Objects represent chapters and provide access to various chapter data, see method descriptions below.
Parameters:
The class name.
Returns: the new object.
Example:
Provides the path of a chapter, this means, the sequence of main and subchapters to enter the document part under a certain headline.
An object as produced by new().
new()
This should be a reference to a hash containing the following keys:
A chapter path has various forms (or types). Choose here which is of interest.
the path of full (or long) chapter titles (headlines)
the numerical path - levels are represented by their public numbers, as used in schemes like 1.2.3.4..
1.2.3.4.
the page headline path: each level holds its chapter number.
the path of short chapter titles (or headlines), these are the parts entered after an optional ~ in a headline:
~
=Long headline ~ Short
Configures how the path should be suppplied:
All parts of the path are elements of an array that is supplied via reference.
The path is provided as a string. Parts are delimited by the value of option delimiter which is mandatory in this mode.
delimiter
Supplies just the last part of the path (this is the chapters own title).
In mode full this needs to be set to a string that is used as a delimiter between the path parts.
full
Returns: the requested path, as configured by option mode.
mode
Provide chapter number.
Returns: the page (or chapter) number.
Provide chapter variables.
Returns: the chapters variables, as a hash.
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.
Copyright (c) Jochen Stenzel (perl@jochen-stenzel.de), 2004-2005. 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
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.
To install PerlPoint::Generator::LANGUAGE::Formatter, copy and paste the appropriate command in to your terminal.
cpanm
cpanm PerlPoint::Generator::LANGUAGE::Formatter
CPAN shell
perl -MCPAN -e shell install PerlPoint::Generator::LANGUAGE::Formatter
For more information on module installation, please visit the detailed CPAN module installation guide.