1Pod::Abstract::Filter(3U)ser Contributed Perl DocumentatiPoond::Abstract::Filter(3)
2
3
4

NAME

6       Pod::Abstract::Filter - Generic Pod-in to Pod-out filter.
7

DESCRIPTION

9       This is a superclass for filter modules using Pod::Abstract. Subclasses
10       should override the "filter" sub. Pod::Abstract::Filter classes in the
11       Pod::Abstract::Filter namespace will be used by the "paf" utility.
12
13       To create a filter, you need to implement:
14
15       filter
16           Takes a Pod::Abstract::Node tree, and returns either another tree,
17           or a string. If a string is returned, it will be re-parsed to be
18           input to any following filter, or output directly if it is the last
19           filter in the list.
20
21       require_params
22           If you want positional arguments following your filter in the style
23           of:
24
25            paf find [thing] Pod::Abstract
26
27           then override require_params to list the named arguments that are
28           to be accepted after the filter name.
29

METHODS

31   new
32       Create a new filter with the specified arguments.
33
34   require_params
35       Override to return a list of parameters that must be provided. This
36       will be accepted in order on the command line, unless they are first
37       set using the "-flag=xxx" notation.
38
39   param
40       Get the named param. Read only.
41
42   filter
43       Stub method. Does nothing, just returns the original tree.
44
45   run
46       Run the filter. If $arg is a string, it will be parsed first.
47       Otherwise, the Abstract tree will be used. Returns either a string or
48       an abstract tree (which may be the original tree, modified).
49

AUTHOR

51       Ben Lilburne <bnej@mac.com>
52

54       Copyright (C) 2009 Ben Lilburne
55
56       This program is free software; you can redistribute it and/or modify it
57       under the same terms as Perl itself.
58
59
60
61perl v5.12.0                      2009-05-26          Pod::Abstract::Filter(3)
Impressum