Ben Lilburne > Pod-Abstract > Pod::Abstract::Filter::find

Download:
Pod-Abstract-0.20.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.20   Source  

NAME ^

Pod::Abstract::Filter::find - paf command to find specific nodes that contain a string.

DESCRIPTION ^

The intention of this filter is to allow a reduction of large Pod documents to find a specific function or method. You call paf find -f=function YourModule, and you get a small subset of nodes matching "function".

For this to work, there has to be some assumptions about Pod structure. I am presuming that find is not useful if it returns anything higher than a head2, so as long as your module wraps function doco in a head2, head3, head4 or list item, we're fine. If you use head1 then it won't be useful.

In order to be useful as an end user tool, head1 nodes (...) are added between the found nodes. This stops perldoc from dying with no documentation. These can be easily stripped using: $pa->select('/head1'), then hoist and detach, or reparent to other Node types.

A good example of this working as intended is:

 paf find select Pod::Abstract::Node

AUTHOR ^

Ben Lilburne <bnej@mac.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2009 Ben Lilburne

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: