pod::abstract::filter(3pm) [debian man page]
Pod::Abstract::Filter(3pm) User Contributed Perl Documentation Pod::Abstract::Filter(3pm) NAME
Pod::Abstract::Filter - Generic Pod-in to Pod-out filter. DESCRIPTION
This is a superclass for filter modules using Pod::Abstract. Subclasses should override the "filter" sub. Pod::Abstract::Filter classes in the Pod::Abstract::Filter namespace will be used by the "paf" utility. To create a filter, you need to implement: filter Takes a Pod::Abstract::Node tree, and returns either another tree, or a string. If a string is returned, it will be re-parsed to be input to any following filter, or output directly if it is the last filter in the list. It is recommended your filter method produce a Node tree if you are able to, as this will improve interoperability with other "Pod::Abstract" based software. require_params If you want positional arguments following your filter in the style of: paf find [thing] Pod::Abstract then override require_params to list the named arguments that are to be accepted after the filter name. METHODS
new Create a new filter with the specified arguments. require_params Override to return a list of parameters that must be provided. This will be accepted in order on the command line, unless they are first set using the "-flag=xxx" notation. param Get the named param. Read only. filter Stub method. Does nothing, just returns the original tree. run Run the filter. If $arg is a string, it will be parsed first. Otherwise, the Abstract tree will be used. Returns either a string or an abstract tree (which may be the original tree, modified). 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. perl v5.10.1 2010-01-03 Pod::Abstract::Filter(3pm)
Check Out this Related Man Page
Pod::Abstract::Tree(3pm) User Contributed Perl Documentation Pod::Abstract::Tree(3pm) NAME
Pod::Abstract::Tree - Manage a level of Pod document tree Nodes. DESCRIPTION
Pod::Abstract::Tree keeps track of a set of Pod::Abstract::Node elements, and allows manipulation of that list of elements. Elements are stored in an ordered set - a single node can appear once only in a single document tree, so inserting a node at a point will also remove it from it's previous location. This is an internal class to Pod::Abstract::Node, and should not generally be used externally. METHODS
detach $tree->detach($node); Unparent the $node from $tree. All other elements will be shifted to fill the empty spot. push Add an element to the end of the node list. pop Remove an element from the end of the node list. insert_before $tree->insert_before($target,$node); Insert $node before $target. Both must be children of $tree insert_after $tree->insert_after($target,$node); Insert $node after $target. Both must be children of $tree unshift Remove the first node from the node list and return it. Unshift takes linear time - it has to relocate every other element in id_map so that they stay in line. children Returns the in-order node list. index_relative my $node = $tree->index_relative($target, $offset); This method will return a node at an offset of $offset (which may be negative) from this tree structure. If there is no such node, undef will be returned. For example, an offset of 1 will give the following element of $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. perl v5.10.1 2010-01-03 Pod::Abstract::Tree(3pm)