1Pod::Abstract::Filter::Ufsienrd(C3o)ntributed Perl DocumPeondt:a:tAibosntract::Filter::find(3)
2
3
4

NAME

6       Pod::Abstract::Filter::find - find specific nodes that contain a
7       string.
8

DESCRIPTION

10       The intention of this filter is to allow a reduction of large Pod
11       documents to find a specific function or method. You call "paf find
12       -f=function YourModule", and you get a small subset of nodes matching
13       "function".
14
15       For this to work, there has to be some assumptions about Pod structure.
16       I am presuming that find is not useful if it returns anything higher
17       than a head2, so as long as your module wraps function doco in a head2,
18       head3, head4 or list item, we're fine. If you use head1 then it won't
19       be useful.
20
21       In order to be useful as an end user tool, head1 nodes (...) are added
22       between the found nodes. This stops perldoc from dying with no
23       documentation. These can be easily stripped using:
24       "<$pa-"select('/head1/')>>, then clear and re-nest.
25
26       A good example of this working as intended is:
27
28        paf find select Pod::Abstract::Node
29

AUTHOR

31       Ben Lilburne <bnej@mac.com>
32

34       Copyright (C) 2009 Ben Lilburne
35
36       This program is free software; you can redistribute it and/or modify it
37       under the same terms as Perl itself.
38
39
40
41perl v5.12.0                      2009-05-26    Pod::Abstract::Filter::find(3)
Impressum