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           It is recommended your filter method produce a Node tree if you are
22           able to, as this will improve interoperability with other
23           "Pod::Abstract" based software.
24
25       require_params
26           If you want positional arguments following your filter in the style
27           of:
28
29            paf find [thing] Pod::Abstract
30
31           then override require_params to list the named arguments that are
32           to be accepted after the filter name.
33

METHODS

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

AUTHOR

55       Ben Lilburne <bnej@mac.com>
56

58       Copyright (C) 2009 Ben Lilburne
59
60       This program is free software; you can redistribute it and/or modify it
61       under the same terms as Perl itself.
62
63
64
65perl v5.28.1                      2010-01-03          Pod::Abstract::Filter(3)
Impressum