[SiteSearchSuggestSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
Suggestions under the header search field of a site's design while the visitor types (the include design:parts/front_search_suggest.tpl in the design's search form; the script javascript/page/search_suggest.js asks content/sitesuggest/(text)/<text>, expSearchSuggest::siteSuggest()). Per siteaccess: switch it off in the siteaccess's site.ini.append.php. Guide: doc/eng-us/help/searching.md ("Suggestions on the site"). Only content objects the user may read are suggested (the anonymous user: what is public), with their name, address, class name and a small image; never user accounts, content classes, administration pages or settings. The view needs the policy content/read, as content/search.
File
settings/site.ini; override it in settings/override/site.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| Enabled | true | true or false. false: the field is a plain search field, content/sitesuggest answers 404. |
| MinLength | 3 | The fewest characters typed before suggestions are asked for. |
| Limit | 6 | The most suggestions (0 to 20). |
| ExcludeClasses[] | user; user_group | Classes never suggested (besides every class with a user account attribute, which never is). |
| IncludeClasses[] | (empty array) | Only these classes are suggested and offered in the content type filter of the search page (content/front_search_page.tpl); empty: every class not excluded above. A site whose tree holds other sites' classes (a multisite package) names its own here, in the siteaccess's site.ini.append.php. |
| ThumbnailAlias | small | The image alias of the small picture of a suggestion (image.ini), from the object's first image attribute; empty: the class icon only. |
| Wildcard | auto | auto, enabled or disabled, as admininterface.ini [SearchSuggestSettings] Wildcard. |
| PublicCacheTTL | 60 | Seconds an anonymous answer is kept (on the server and as Cache-Control: public, max-age), 0 to 3600. 0: not kept. A signed-in user's answer is never kept (private, no-store). |
| RateLimit | 60 | Requests of one address within RateWindow seconds; more are answered 429 with Retry-After. 0: no limit. |
| RateWindow | 60 |
See also
Generated example: site.ini [SiteSearchSuggestSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/site.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment