string summary( max_words, min_words, max_chars, trailer, preserve_tags, format_all )

Description:

Retrieve a summary block for the asset

Parameters:

max_words

The maximum number of words that can appear in a dynamically created summary. Defaults to no maximum.

min_words

The minimum number of words that can appear in a dynamically created summary. Defaults to no minimum

max_chars

The maximum number of characters (UTF-8 safe) that can appear in a summary. Defaults to no maximum.

trailer

A string of characters to replace in a dynamically generated summary that exceeds max_chars. The max_chars of a string is reduced by the length of the supplied string. Defaults to '...'.

preserve_tags

By default, all HTML is stripped. Specific HTML tags can be preserved by providing an array of tags - one tag per entry in the form of <tag>.

format_all

If enabled, an asset that has a prologue or pre-formatted summary will be made subject to max_words, max_chars, trailer, and preserve_tags. The default is false.

Return:

The summary of the asset