NAME

Pod::WikiDoc::Parser - precompiled recursive descent parser for Pod::WikiDoc

VERSION

version 0.21

SYNOPSIS

    use Pod::WikiDoc::Parser;

    my $parser = Pod::WikiDoc::Parser->new();

    my $tree = $parser->WikiDoc( $text );

DESCRIPTION

Pod::WikiDoc::Parser is a precompiled Parse::RecDescent parser for use with Pod::WikiDoc.

A copy of the Parse::RecDescent grammar used is appended to the Pod::WikiDoc::Parser source and this Pod file for reference or reuse by others.

USAGE

This module is a support module for Pod::WikiDoc and is not intended for general use. Given a string containing WikiDoc markup text, the parser produces a data structure representing the parsed content. The data structure returned is an array of references to hashes. Keys in the hash are:

type: the parser rule that generated the hash
content: either a reference to another AoH or a string of text
level: (only for "Header" type hashes) the level of the header

See Pod::WikiDoc for details of the markup.

AUTHOR

David A Golden <dagolden@cpan.org>

COPYRIGHT AND LICENSE

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004