Skip to the content
Documentation

[SearchSuggestSettings]

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

The group [SearchSuggestSettings] of settings/admininterface.ini.

File

settings/admininterface.ini; override it in settings/override/admininterface.ini.append.php, in a siteaccess or in an extension.

Settings

Setting Default Description
Enabled true Suggestions under the header search field of the administration (design admin and admin4) while the user types: content, PDF pages, users, content classes and the administration's own pages, in groups, each only as far as the user may see it, with "View all results" leading to the full search (content/search). The script (javascript/page/search_suggest.js) asks content/suggest/(text)/<text> for them (expSearchSuggest). Guide: doc/eng-us/help/searching.md ("Suggestions while typing"). The view content/suggest needs the policy content/read (as content/search): a user without it gets no suggestions at all, not even the administration's pages, and the field is a plain search field for them. The groups pages and limits below also bound the load: one request per typed pause (250 ms), plus at most Limits[pages] requests for the pages of documents. true or false. false: the field is a plain search field, content/suggest answers 404.
MinLength 3 The fewest characters typed before suggestions are asked for.
Groups[] content; pages; users; classes; admin The groups, in the order they are shown. Leave one out to switch it off: content the content search (eZ Find when it is the search engine, else the kernel's search engine), with the user's read permissions applied by the search itself pages the PDF pages holding the words: only with eZ Find and the extension ezfindpdfdeepsearch active; without them a document is suggested as a whole, in the content group users user accounts by login, e-mail address or name, only those the user may read classes content classes by name or identifier, only for a user who may open the class module admin the top tabs and the links of their left menus, as the design draws them for the user ("Setup › Cache")
Limits[<key>] content=6; pages=3; users=3; classes=3; admin=4 The most suggestions per group (0 to 20; 0 switches the group off).
PagesPerDocument 2 The pages of one document, at most (pages group).
PageHitClasses[] file The classes whose objects are documents with pages (pages group): the file class of the binary files.
Wildcard auto A "*" after the last word typed, so that a word is found while it is typed ("Oste" finds "Ostern"): auto only when site.ini [SearchSettings] EnableWildcard=true (both search engines honour it only then), and only for a word of MinCharacterWildcard characters or more enabled always (for a word of MinCharacterWildcard characters or more) disabled never: only whole words are found
AdminPagesCacheTTL 300 The administration's pages of a user are drawn from the menus once and kept for this many seconds, per user and rights (cache item searchsuggest, cleared with the template caches). 0: drawn on every request.
AdminMenuSkipParts[] ezcontentnavigationpart; ezmedianavigationpart Navigation parts whose left menu holds no list of pages (a tree): only their tab is suggested.

See also

Generated example: admininterface.ini [SearchSuggestSettings]

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/admininterface.ini.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.