/ 
Pod-WikiDoc-0.18
River stage two • 1 direct dependent • 22 total dependents
/ Pod::WikiDoc::Parser

NAME

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

VERSION

This documentation refers to version 0.18.

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.

SEE ALSO

There are numerous Perl wikitext parsers, formatters or translators, some of which were instructive in designing this parser. All the ones I could find are included below for reference for those interested in the topic:

  • CGI::Wiki::Formatter

  • Convert::Wiki

  • HTML::WikiConverter

  • Kwiki::Formatter

  • Pod::TikiWiki

  • PurpleWiki::Parser::WikiText

  • Template::Plugin::KwikiFormat

  • Text::WikiFormat

AUTHOR

David A. Golden (DAGOLDEN)

COPYRIGHT AND LICENSE

Copyright (c) 2005, 2006, 2007 by David A. Golden

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Files produced as output though the use of this software, including generated copies of boilerplate templates provided with this software, shall not be considered Derivative Works, but shall be considered the original work of the Licensor.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.