Go to main content

Search result excerpt

On this page:

Syntax

<txp:search_result_excerpt />

The search_result_excerpt tag is a single tag that will show the occurrence of the search term with some surrounding context.

Attributes

Tag will accept the following attributes (case-sensitive):

break="tag" Deprecated v4.7.0
Trailing string.
Default: (ellipsis).
hilight="tag"
HTML tag to be used for search term matches in excerpt text, without brackets.
Default: strong.
limit="integer"
Maximum number of search match excerpts per search result.
Default: 5.
separator="tag" v4.7.0+
Trailing string.
Default: (ellipsis).

Examples

Example 1: Display up to 15 search excerpts with a search results form

<h3>
    <txp:permlink>
        <txp:title />
    </txp:permlink>
</h3>
<p>
    <txp:search_result_excerpt hilight="p" limit="15" /> |
    <txp:permlink>
        <txp:permlink />
    </txp:permlink>
    | <txp:posted />
</p>

Other tags used: permlink, posted, title.

Genealogy

Version 4.7.0

break attribute deprecated in favour of separator.

Version 4.0.6

break attribute added.

If you notice any kind of problem with this page’s construction or content (outdated information, typos, broken links, or whatever), open an issue to have it sorted. Or have a go at it yourself. :)