SYNOPSIS

     use Pod::Elide qw(elide);
     print elide(<<EOP, 20);
     =head1 NAME
    
     Foo - Do something fooish
    
     =head1 VERSION
    
     1.23
    
     =head1 SYNOPSIS
    
      blah blah
      blah blah
      blah blah
    
     =head1 DESCRIPTION
    
     Some description some description some description. Some description some
     description some description some description. Some description some
     description some description. Some description some description some
     description some description. Some description some description some
     description. Some description some description some description some
     description.
    
     =head1 FUNCTIONS
    
     =head2 func1
    
     Blah blah blah
     Blah blah blah
    
     =head2 func2
    
     Blah blah blah
     Blah blah blah
    
     =head1 SEE ALSO
    
     L<Bar>
    
     =cut
     EOP

    The output is something like:

     =head1 NAME
    
     =head1 VERSION
    
     =head1 SYNOPSIS
    
     =head1 DESCRIPTION
    
     Some description some description some description. Some description some
     description some description some description. Some description some
     ..
     =head1 FUNCTIONS
    
     =head2 func1
    
     =head2 func2
    
     =head1 SEE ALSO
    
     =cut

DESCRIPTION

    String::Elide::Lines is based on String::Elide::Parts but works on a
    per-line basis.

FUNCTIONS

 elide($str, $len[, \%opts]) => str

    Elide lines from a string if the string contains more than $len lines.

    String can be marked with <elspan prio=N truncate=T
    marker=M>...</elspan> so there can be multiple parts with different
    priorities and truncate direction. The default priority is 1. You can
    mark less important lines with higher priority to let it be elided
    first. The markup will be removed from the string before eliding.

    Known options:

      * marker => str (default: '..')

      * truncate => 'top'|'middle'|'bottom'|'ends' (default: 'bottom')

SEE ALSO

    String::Elide::Parts is the basis of this module but works on a
    per-character basis. See that module's SEE ALSO for list of other
    string eliding modules.

    Pod::Elide uses this module.

