The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
String-Elide-Lines-0.003
River stage one • 2 direct dependents • 3 total dependents
++
/ String::Elide::Lines

NAME

String::Elide::Lines - Elide lines from a string, with options

VERSION

This document describes version 0.003 of String::Elide::Lines (from Perl distribution String-Elide-Lines), released on 2017-01-29.

SYNOPSIS

 use String::Elide::Lines qw(elide);

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')

  • default_prio => int (default: 1)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/String-Elide-Lines.

SOURCE

Source repository is at https://github.com/perlancar/perl-String-Elide-Lines.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=String-Elide-Lines

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by perlancar@cpan.org.

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