ability to highlight any result article field with highlight_result tag.

[bse.git] / site / docs / config.pod

diff --git a/site/docs/config.pod b/site/docs/config.pod
index 6618eb7a8a29b45300d81c704c9836b2b40b5d24..453acca0117c0abc565885e240973efe03063253 100644 (file)
--- a/site/docs/config.pod
+++ b/site/docs/config.pod
@@ -526,6 +526,26 @@ user are listed in the search results.  Default: false.
 
 =back
 
+=head2 [search highlight]
+
+Sets the prefix and suffix used for highlighting matches for different
+fields.
+
+These are used by the highlight_result, excerpt, pageTitle, author,
+keywords and matchFile tags.
+
+Each field has a prefix and suffix entry.  The key is
+I<fieldname>_prefix or I<fieldname>_suffix.  For file fields this is
+file_I<fieldname}_prefix and file_I<fieldname}_suffix.
+
+The default prefix is <b>.  The default suffix is </b>.
+
+For example you can do:
+
+  [search highlight]
+  body_prefix=<span class="searchfound">
+  body_suffix=</span>
+
 =head2 [shop]
 
 =over