.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Petal::Utils 3pm" .TH Petal::Utils 3pm "2011-08-16" "perl v5.12.4" "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" Petal::Utils \- Useful template modifiers for Petal. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # install the default set of Petal modifiers: \& use Petal::Utils; \& \& # you can also install modifiers manually: \& Petal::Utils\->install( \*(Aqsome_modifier\*(Aq, \*(Aq:some_set\*(Aq ); \& \& # see below for modifiers available & template syntax .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The Petal::Utils package contains commonly used Petal modifiers (or plugins), and bundles them with an easy-to-use installation interface. By default, a set of modifiers are installed into Petal when you use this module. You can change which modifiers are installed by naming them after the use statement: .PP .Vb 2 \& # use the default set: \& use Petal::Utils qw( :default ); \& \& # use the date set of modifiers: \& use Petal::Utils qw( :date ); \& \& # use only named modifiers, plus the debug set: \& use Petal::Utils qw( UpperCase Date :debug ); \& \& # don\*(Aqt install any modifiers \& use Petal::Utils qw(); .Ve .PP You'll find a list of plugin sets throughout this document. You can also get a complete list by looking at the variable: .PP .Vb 1 \& %Petal::Utils::PLUGIN_SET; .Ve .PP For details on how the plugins are installed, see the \*(L"Advanced Petal\*(R" section of the Petal documentation. .SH "MODIFIERS" .IX Header "MODIFIERS" Each modifier is listed under the set it belongs to. .SS ":text" .IX Subsection ":text" .ie n .IP "lowercase:, lc: $string" 4 .el .IP "lowercase:, lc: \f(CW$string\fR" 4 .IX Item "lowercase:, lc: $string" Make the entire string lowercase. .Sp .Vb 1 \&
lower
.Ve .ie n .IP "uppercase:, uc: $string" 4 .el .IP "uppercase:, uc: \f(CW$string\fR" 4 .IX Item "uppercase:, uc: $string" Make the entire string uppercase. .Sp .Vb 1 \&upper
.Ve .ie n .IP "uc_first: $string" 4 .el .IP "uc_first: \f(CW$string\fR" 4 .IX Item "uc_first: $string" Make the first letter of the string uppercase. .Sp .Vb 1 \&uc_first
.Ve .ie n .IP "substr: $string [offset] [length] [ellipsis]" 4 .el .IP "substr: \f(CW$string\fR [offset] [length] [ellipsis]" 4 .IX Item "substr: $string [offset] [length] [ellipsis]" Extract a substring from a string. Optionally add an ellipsis (...) to the end. See also, perldoc \-f substr. .Sp .Vb 4 \& string # does nothing \& string # cuts the first two chars \& string # extracts chars 2\-7 \& string with ellipsis # same as above and adds an ellipsis .Ve .IP "printf: format list" 4 .IX Item "printf: format list" The printf modifier acts exactly like Perl's sprintf function to print formatted strings. .Sp .Vb 2 \&Astro
\&$2.50
.Ve .SS ":date" .IX Subsection ":date" .ie n .IP "date: $date" 4 .el .IP "date: \f(CW$date\fR" 4 .IX Item "date: $date" Convert a \fItime()\fR integer to a date string using Date::Format. .Sp .Vb 1 \& Jan 1 1970 01:00:01 .Ve .ie n .IP "us_date: $date" 4 .el .IP "us_date: \f(CW$date\fR" 4 .IX Item "us_date: $date" Convert an international date stamp (e.g., yyyymmdd, yyyy-mm-dd, yyyy/mm/dd) to \s-1US\s0 format (mm/dd/yyyy). .Sp .Vb 1 \&2003\-09\-05
.Ve .SS ":logic" .IX Subsection ":logic" .ie n .IP "if: $expr1 then: $expr2 else: $expr3" 4 .el .IP "if: \f(CW$expr1\fR then: \f(CW$expr2\fR else: \f(CW$expr3\fR" 4 .IX Item "if: $expr1 then: $expr2 else: $expr3" Do an if/then/else test and return the value of the expression executed. Truthfulness of \f(CW$expr1\fR is according to Perl (e.g., non-zero, non-empty string). .Sp .Vb 3 \&\& Some text here... \&
.Ve .ie n .IP "or: $expr1 $expr2" 4 .el .IP "or: \f(CW$expr1\fR \f(CW$expr2\fR" 4 .IX Item "or: $expr1 $expr2" Do a logical or. Truthfulness is according to Perl (e.g., non-zero, non-empty string). .Sp .Vb 3 \&\& first or second = or \&
.Ve .ie n .IP "and: $expr1 $expr2" 4 .el .IP "and: \f(CW$expr1\fR \f(CW$expr2\fR" 4 .IX Item "and: $expr1 $expr2" Do a logical and. Truthfulness is according to Perl (e.g., non-zero, non-empty string). .Sp .Vb 1 \& first and second = and .Ve .ie n .IP "equal:, eq: $expr1 $expr2" 4 .el .IP "equal:, eq: \f(CW$expr1\fR \f(CW$expr2\fR" 4 .IX Item "equal:, eq: $expr1 $expr2" Test for equality. Numbers are compared with \f(CW\*(C`==\*(C'\fR, strings with \f(CW\*(C`eq\*(C'\fR. Truthfulness is according to Perl (e.g., non-zero, non-empty string). .Sp .Vb 1 \& first eq second = equal .Ve .ie n .IP "like: $expr $regex" 4 .el .IP "like: \f(CW$expr\fR \f(CW$regex\fR" 4 .IX Item "like: $expr $regex" Test for equality to a regular expression (see perlre). .Sp .Vb 1 \& name like regex = like .Ve .IP "decode, decode: expression search result [search result]... [default]" 4 .IX Item "decode, decode: expression search result [search result]... [default]" The decode function has the functionality of an IF-THEN-ELSE statement. A case-sensitive regex comparison is performed. All text strings must be enclosed in single quotes. .Sp .Vb 6 \& \*(Aqexpression\*(Aq is the value to compare. \& \*(Aqsearch\*(Aq is the value that is compared against expression. \& \*(Aqresult\*(Aq is the value returned, if expression is equal to search. \& \*(Aqdefault. is optional. If no matches are found, the decode will return \& default. If default is omitted, then the decode statement will return \& null (if no matches are found). \& \&100
# if $str = dog, returns Satchel \&Astro
# if $str = cat, returns Buckey, else Satchel .Ve .SS ":list" .IX Subsection ":list" .ie n .IP "sort: $list" 4 .el .IP "sort: \f(CW$list\fR" 4 .IX Item "sort: $list" Sort the values in a list before returning it. .Sp .Vb 3 \&