/ 
PerlPoint-Package-0.452
River stage one • 4 direct dependents • 5 total dependents
/ PerlPoint::Generator::Object::Page

NAME

PerlPoint::Generator::Object::Page - generators page object class

VERSION

This manual describes version 0.03.

SYNOPSIS

DESCRIPTION

This is an internal class. Objects represent chapters and provide access to various chapter data, see method descriptions below.

METHODS

new()

Parameters:

class

The class name.

Returns: the new object.

Example:

path()

Provides the path of a chapter, this means, the sequence of main and subchapters to enter the document part under a certain headline.

Parameters:

object

An object as produced by new().

parameters

This should be a reference to a hash containing the following keys:

type

A chapter path has various forms (or types). Choose here which is of interest.

fpath

the path of full (or long) chapter titles (headlines)

npath

the numerical path - levels are represented by their public numbers, as used in schemes like 1.2.3.4..

ppath

the page headline path: each level holds its chapter number.

spath

the path of short chapter titles (or headlines), these are the parts entered after an optional ~ in a headline:

=Long headline ~ Short
mode

Configures how the path should be suppplied:

array

All parts of the path are elements of an array that is supplied via reference.

full

The path is provided as a string. Parts are delimited by the value of option delimiter which is mandatory in this mode.

title

Supplies just the last part of the path (this is the chapters own title).

delimiter

In mode full this needs to be set to a string that is used as a delimiter between the path parts.

Returns: the requested path, as configured by option mode.

Example:

nr()

Provide chapter number.

Parameters:

object

An object as produced by new().

Returns: the page (or chapter) number.

Example:

vars()

Provide chapter variables.

Parameters:

object

An object as produced by new().

Returns: the chapters variables, as a hash.

Example:

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

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.