Chris Josephes > ubertext > Text::UberText::Node::Text

Download:
ubertext-0.95.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.95   Source  

NAME ^

Text::UberText::Node::Text - UberText Text Node

DESCRIPTION ^

The Node::Text module handles processing an UberText text segment embedded within an UberText file. It is a subclass of the Text::UberText::Node class.

ESCAPE SEQUENCES ^

UberText files cannot contain certain characters, as a result of which, they need to be specified with escape sequences.

Escape sequences start with a percent sign (%), and end with a semi-colon (;). Two alpabetic characters in the middle specify what character they intend to replace.

%pc;

Percent sign (%)

%dq;

Double quote (")

%sq;

Single quote (')

%co;

Colon (:)

%sc;

Semi-colon (;)

%lb;

Left bracket ([)

%rb;

Right bracket (])

%lp;

Left parenthesis (()

%rp;

Right parenthesis ())

METHODS ^

The following methods are overriden from the Text::UberText::Node module to perform specific functions on passed input.

$node->process();

Generates the output, replacing all escape sequences.

$node->quickReplace();

Performs the actual escape sequence replacement.

$node->run();

The run method does nothing. All processing of the text is performed before the document tree is actually run.

AUTHOR ^

Chris Josephes <cpj1@visi.com>

SEE ALSO ^

Text::UberText::Node, Text::UberText::Node::Command

COPYRIGHT ^

Copyright 2002, Chris Josephes. All rights reserved. This module is free software. It may be used, redistributed, and/or modified under the same terms as Perl itself. ~

syntax highlighting: