.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "String::Elide::Parts 3pm"
.TH String::Elide::Parts 3pm "2019-07-11" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
String::Elide::Parts \- Elide a string with multiple parts of different priorities
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.07 of String::Elide::Parts (from Perl distribution String-Elide-Parts), released on 2017\-01\-29.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use String::Elide::Parts qw(elide);
.Ve
.PP
Eliding string with no parts:
.PP
.Vb 6
\& my $text = "this is your brain";
\& # 0\-\-\-\-5\-\-\-10\-\-\-15\-\-\-20
\& elide($text, 16); # \-> "this is your ..."
\& elide($text, 16, {truncate=>"left"}); # \-> "...is your brain"
\& elide($text, 16, {truncate=>"middle"}); # \-> "this is... brain"
\& elide($text, 16, {truncate=>"ends"}); # \-> "... is your b..."
\&
\& elide($text, 16, {marker=>"\-\-"}); # \-> "this is your b\-\-"
.Ve
.PP
Eliding string with multiple parts marked with markup. We want to elide \s-1URL\s0
first (prio=3), then the \f(CW\*(C`Downloading\*(C'\fR text (prio=2), then the speed (prio=1,
default):
.PP
.Vb 10
\& $text = "Downloading http://www.example.com/somefile 320.0k/5.5M";
\& # 0\-\-\-\-5\-\-\-10\-\-\-15\-\-\-20\-\-\-25\-\-\-30\-\-\-35\-\-\-40\-\-\-45\-\-\-50\-\-\-55\-\-\-60
\& elide($text, 56); # \-> "Downloading http://www.example.com/somefile 320.0k/5.5M"
\& elide($text, 55); # \-> "Downloading http://www.example.com/somefile 320.0k/5.5M"
\& elide($text, 50); # \-> "Downloading http://www.e..com/somefile 320.0k/5.5M"
\& elide($text, 45); # \-> "Downloading http://ww..m/somefile 320.0k/5.5M"
\& elide($text, 40); # \-> "Downloading http://..omefile 320.0k/5.5M"
\& elide($text, 35); # \-> "Downloading http..efile 320.0k/5.5M"
\& elide($text, 30); # \-> "Downloading ht..le 320.0k/5.5M"
\& elide($text, 25); # \-> "Downloading . 320.0k/5.5M"
\& elide($text, 24); # \-> "Downloading 320.0k/5.5M"
\& elide($text, 23); # \-> "Download.. 320.0k/5.5M"
\& elide($text, 20); # \-> "Downl.. 320.0k/5.5M"
\& elide($text, 15); # \-> ".. 320.0k/5.5M"
\& elide($text, 13); # \-> " 320.0k/5.5M"
\& elide($text, 10); # \-> " 320.0k/.."
\& elide($text, 5); # \-> " 32.."
\& # 0\-\-\-\-5\-\-\-10\-\-\-15\-\-\-20\-\-\-25\-\-\-30\-\-\-35\-\-\-40\-\-\-45\-\-\-50\-\-\-55\-\-\-60
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
String::Elide::Parts is similar to other string eliding modules, with one main
difference: it accepts string marked with parts of different priorities. The
goal is to retain more important information as much as possible when length is
reduced.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS "elide($str, $len[, \e%opts]) => str"
.el .SS "elide($str, \f(CW$len\fP[, \e%opts]) => str"
.IX Subsection "elide($str, $len[, %opts]) => str"
Elide a string if length exceeds \f(CW$len\fR.
.PP
String can be marked with \f(CW\*(C`...\*(C'\fR
so there can be multiple parts with different priorities and truncate direction.
The default priority is 1. You can mark less important strings with higher
priority to let it be elided first. The markup will be removed from the string
before eliding.
.PP
Known options:
.IP "\(bu" 4
marker => str (default: '..')
.IP "\(bu" 4
truncate => 'left'|'middle'|'middle'|'ends' (default: 'right')
.IP "\(bu" 4
default_prio => int (default: 1)
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at .
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at .
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
.PP
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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SS "Similar elide modules"
.IX Subsection "Similar elide modules"
Text::Elide is simple, does not have many options, and elides at word
boundaries.
.PP
String::Truncate has similar interface like String::Elide::Parts and has some
options.
.PP
String::Elide::Lines is based on this module but works on a line-basis.
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.