shorten

Summary

Returns a shortened version of the input string.

Usage

input|shorten( [ length [, sequence [, trim_type ] ] ] )

Parameters

Name	Type	Description	Required
length	integer	The desired length of the returned string.	No.
sequence	string	Custom trailing/end-sequence.	No.
trim_type	string	Controls the type of trimming: "right" (default) or "middle".	No.

Returns

A shortened version of the input string.

Description

This operator shortens the input string to "length" characters and adds a trailing sequence. Please note that the "length" parameter also includes the length of the trailing sequence. If the input string is shorter than "length", it will not be shortened. The default length is 80, the default trailing sequence is three dots: "...". The third parameter controls the type of trimming, it can be set to either "right" (default) or "middle".

Examples

Example 1

{'Led Zeppelin rocks!'|shorten( 15 )}

The following output will be produced: "Led Zeppelin...".

Example 2

{"eZ Systems"|shorten( 7, '...' , 'middle' )}

The following output will be produced: "eZ...ms".