NAME

Puma::Parser - the base Puma tag parser


SYNOPSIS

No synopsis available at this time.


DESCRIPTION

The Puma tag parser is the core module for all tag parsing functions. It is used as a base class for Puma::Parser::XML and Puma::ServerPages::Parser.

At this time, the API documentation for this class is still limited, given the push to get to a functional release. If you wish to extend this class, check out the two modules listed above and the rest of this documention. Good luck!


METHODS

parse() parseFile(FILENAME)

parse() can be called in any of the following methods:

   parse(TEXT)
   parse(Text => TEXT)
   parse(FileName => FILENAME)

It returns a data structure representation of the parsed text that looks like this:

   $tree = [ [
      label,
      {
         param => [ value, ... ],
         ...
      },
      text | [ tree ]
   ] ... ];

This data structure is similar to the structure created by the (CPAN) XML::Parser package.

parseFile() is simply a wrapper around parse() that takes the name of a file as a parameter and invokes the parser as parse(FileName => FILENAME);


SEE ALSO

Puma::RegEx(3) Puma::Parser::XML(3) Puma::ServerPages::Parser(3) XML::Parser(3)


COPYRIGHT

Copyright (c) 2001, 2002 by Ingmar Ellenberger.

Distributed under The Artistic License. For the text of this license, see http://puma.site42.com/license.psp or read the file LICENSE in the root of the distribution.