This plugin has been built up from an earlier plugin, with the plan on being an awful lot more efficient and more reliable.
This plugin is designed to be wrapped around the {full_text} variable on your search results template and will return relevant ‘chunks’ of text containing your search terms. Think Google search results.
Parameters:
wrap="”
The html tag name (don’t include the < > parts) to wrap around each highlighted word. The default value is “strong”.
chunk_wrap="”
The html tag name (don’t include the < > parts) to wrap around each relevant ‘chunk’ extracted from the entire {full_text} value. The default value is “span”. If supplied with “none”, nothing will be wrapped around each chunk.
chunk_prepend="”
Data to prepend to each individual chunk returned. This data will be inserted inside the chunk_wrap tags.
chunk_append="”
Like the chunk_prepend parameter, but this inserts the data immediately before the closing chunk_wrap tag. Defaults to ‘… ‘.
output_wrap="”
The html tag name (don’t include the < > parts) to wrap around the entire output. Defaults to nothing.
output_prepend="”
Data to insert in the output, before any chunks but after the opening output_wrap tag, if supplied.
output_append="”
Like the output_prepend parameter, but this will insert the data immediately before the closing output_wrap tag if supplied.
pre_chars="”
The number of characters to include before the highlighted term. Regardless of given value, the pointer will not dissect whole words. The default value is “50”. If given a value such as “50-100” it will choose a random value between 50 and 100.
post_chars="”
The number of characters to include after the hightlighted term. Regardless of given value, the pointer will not dissect whole words. The default value is “50”. If given a value such as “50-100” it will choose a random value between 50 and 100.
chunks="”
The number of relevant chunks to return. Values can be numeric or “all”. The default value is “3”. Setting this parameter to all will return all relevant chunks found.
keywords="”
Instead of acting dynamically, the plugin can be given the search term, or any term, via this parameter.
sort="”
Sort the chunks ascendingly or descendingly from the order in which they were found. values are “asc” or “desc”. Default is “asc”.
order="”
Order the chunks. Currently this parameter accepts only “random”.
Example usage:
(on a search results template)
{exp:search:search_results}
<h2><a href="{auto_path}" title="{title}">{title}</a></h2>
{exp:zm_excerpt output_wrap="p" output_prepend="<dfn>[excerpt] </dfn>"}{full_text}{/exp:zm_excerpt}
{/exp:search:search_results}
Might return (for each result, on a search for “lorem” in some non-sensical entries)
<h2><a href="http://www.example.com/index.php/template-group/template/nam-tincidunt-pharetra-pede/" title="Nam tincidunt pharetra pede">Nam tincidunt pharetra pede</a></h2>
<p>
<dfn>[excerpt] </dfn>
<span>Curabitur ut tortor. Vivamus nonummy felis a mi. <strong>Lorem</strong> ipsum dolor sit amet, consectetuer adipiscing... </span>
<span>Aenean lobortis. Proin <strong>lorem</strong>. Aenean nunc nisi, sodales a, tincidunt non,... </span>
<span>augue purus posuere velit. Cras blandit leo sed <strong>lorem</strong>. Mauris auctor luctus mi. Curabitur erat ante,... </span>
</p>
Extract and upload to your system/plugins directory.
