NAME

Pod::Abstract::Filter::ptree - convert the incoming document to a summarised parse tree, and dump that into a verbatim block.

DESCRIPTION

This can be very useful to understand the generated structure of a POD file when you are building your own filters or code based on Pod::Abstract.

USAGE

$ paf ptree bin/paf

...

Parse Tree
      1 [[ROOT]]
      2   [#cut] #!/usr/bin/perl
      3   [#cut] package paf;use strict;use warnings;
      4   [#cut] use Pod::Abstract;use Pod::Abstract::Filter;
      5   [#cut] use File::Temp qw(tempfile tempdir);
      8   [head1] NAME
      9     [:paragraph]
     10       [:text] paf - Pod Abstract Filter. Transform Pod documents from t
<... etc>

METHODS

filter

This is the only method for the module, and it just makes use of the "ptree" in Pod::Abstract::Node method to generate a visual parse tree, and nests that into a heading generated by Pod::Abstract::BuildNode.