GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POD::ELEMENTAL::SELECTORS (3)

.ds Aq ’

NAME

Pod::Elemental::Selectors - predicates for selecting elements

CONTENTS

VERSION

version 0.103004

OVERVIEW

Pod::Elemental::Selectors provides a number of routines to check for Pod::Elemental paragraphs with given qualities.

SELECTORS

Selectors are predicates: they examine paragraphs and return either true or false. All the selectors have (by default) names like: s_whatever. They expect zero or more parameters to affect the selection. If these parameters are given, but no paragraph, a callback will be returned that will expect a paragraph. If a paragraph is given, the selector will return immediately.

For example, the s_command selector expects a parameter that can be the name of the command desired. Both of the following uses are valid:



  # create and use a callback:

  my $selector = s_command(head1);
  my @headers  = grep { $selector->($_) } @paragraphs;

  # just check a paragraph right now:

  if ( s_command(head1, $paragraph) ) { ... }



The selectors can be imported individually or as the -all group, and can be renamed with Sub::Exporter features. (Selectors cannot yet be curried by Sub::Exporter.)

    s_blank



  my $callback = s_blank;

  if( s_blank($para) ) { ... }



s_blank tests whether a paragraph is a Generic::Blank element.

    s_flat



  my $callback = s_flat;

  if( s_flat($para) ) { ... }



s_flat tests whether a paragraph does Pod::Elemental::Flat — in other words, is content-only.

    s_node



  my $callback = s_node;

  if( s_node($para) ) { ... }



s_node tests whether a paragraph does Pod::Elemental::Node — in other words, whether it may have children.

    s_command



  my $callback = s_command;
  my $callback = s_command( $command_name);
  my $callback = s_command(\@command_names);

  if( s_command(undef, \$para) ) { ... }

  if( s_command( $command_name,  \$para) ) { ... }
  if( s_command(\@command_names, \$para) ) { ... }



s_command tests whether a paragraph does Pod::Elemental::Command. If a command name (or a reference to an array of command names) is given, the tested paragraph’s command must match one of the given command names.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Ricardo SIGNES.

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 POD::ELEMENTAL::SELECTORS (3) 2014-12-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.