Maxscape::Manual Package

Synopsis

use Maxscape::Manual;

Description

The Maxscape::Manual package creates the HTML manual pages from the Maxscape library sources. It is used in the makeManual.sh and makeManual.pl scripts, which imports the HTML pages into the Maxscape content database.

List of Member Functions

1. Character
2. EndTag
3. listFunctions
4. makeManual
5. new
6. StartTag
7. stripManual
8. stripSource
9. Text

Member Functions

new

Synopsis

my $Manual = Maxscape::Manual->new (%Parameter);

Description

Creates a Maxscape::Manual object.

makeManual

Synopsis

my $Text = $Manual->makeManual ($XMLText);

Description

Creates HTML from a XML test.

listFunctions

Synopsis

my $Text = $Manual->listFunctions (@FunctionList);

Description

Creates a function list.

StartTag

Synopsis

my $Text = $Manual->StartTag (@FunctionList);

Description

Handles an XML start tag.

EndTag

Synopsis

my $Text = $Manual->EndTag ($p, $Name);

Description

Handles an XML end tag.

Character

Synopsis

my $Text = $Manual->Character ($p, $Name);

Description

Handles a character.

Text

Synopsis

my $Text = $Manual->Text ($p, $Name);

Description

Returns the assembled text.

stripManual

Synopsis

my $Text = $Manual->stripManual ($Text);

Description

Strips a text.

stripSource

Synopsis

my $Text = $Manual->stripSource ($PerlSource);

Description

Strips the manual parts from a Perl source.

1