Search faceted
Name | Type and description |
|---|---|
jcrSession | |
The JCR Session | |
portlet | |
This portlet. See properties below | |
request | javax.portlet.PortletRequest |
The portlet request | |
searchResult | |
The search result | |
sitevisionUtils | |
The main entry point to all utility classes | |
velocityEvaluator | |
A evaluator that can parse Velocity templates or Velocity expressions on the fly |
Name | Type and Description |
|---|---|
| SEARCH FORM |
searchButtonFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The search button Node (sv:font) |
searchButtonImage | javax.jcr.PropertyType.WEAKREFERENCE |
| The search button image Node (sv:image) |
searchButtonText | javax.jcr.PropertyType.STRING |
| The i18n:ized search button text (en: "Search") |
searchFieldFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The search field font Node (sv:font) |
searchFieldSize | javax.jcr.PropertyType.LONG |
| The size of the search form input field |
useTextSearchButton | javax.jcr.PropertyType.BOOLEAN |
| Whether to use a text button or not (i.e. an image button) |
|
|
| AUTO COMPLETE SUGGESTIONS |
autocompleteField | javax.jcr.PropertyType.STRING |
| What index field to use when extracting auto complete suggestions ("nameField" or "titleField", se Index fields section below) |
autoCompleteURL | javax.jcr.PropertyType.STRING |
| The autocomplete suggestion URL to use in Ajax calls |
maxAutoSuggestions | javax.jcr.PropertyType.LONG |
| Max number of autocomplete suggestions |
useAutoSuggestions | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to use auto complete suggestions |
|
|
| QUERYING |
ajaxQueryBaseURL | javax.jcr.PropertyType.STRING |
| Base URL to use for Ajax querying calls |
isRenderingAjaxResult | javax.jcr.PropertyType.BOOLEAN |
| Whether or not the search result was retrieved via Ajax |
queryParameter | javax.jcr.PropertyType.STRING |
| The name of the parameter to use when submitting a query |
searchFormTargetPage | javax.jcr.PropertyType.WEAKREFERENCE |
| The Node (typically a sv:page) rendering all templates for a search result |
updateResultFunctionName | javax.jcr.PropertyType.STRING |
| A unique name for the JavaScript update function |
useInstantSearch | javax.jcr.PropertyType.BOOLEAN |
Whether or not to use instant search ("Search as you type") | |
|
|
| TYPE RESTICTIONS |
includeArticles | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to include articles in the search result |
includeFiles | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to include files in the search result |
includeImages | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to include images in the search result |
includePages | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to include pages in the search result |
includeStructurePages | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to include structure pages in the search result |
| SEARCH FAILED |
errorMessage | javax.jcr.PropertyType.STRING |
| An i18n:ized message describing why search could not be executed |
searchErrorFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The search error font Node (sv:font) |
showSearchError | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to show search errors or no hits messages |
|
|
| SEARCH RESULT |
countThreshold | javax.jcr.PropertyType.LONG |
| Effective hit count threshold (exact count vs. approximate count) |
didYouMeanFont | javax.jcr.PropertyType.WEAKREFERENCE |
The "Did you mean" font Node (sv:font) | |
numberOfHitsFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The number of hits font Node (sv:font) |
showNumberOfHits | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to show number of hits |
useDidYouMean | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to use and show "Did you mean" |
| |
| PAGING |
ajaxPagingBaseURL | javax.jcr.PropertyType.STRING |
| The base URL to use for Ajax paging calls |
hitsPerPage | javax.jcr.PropertyType.LONG |
| Maximum number of hits to display for each paged frame |
isRenderingAjaxPagingResult | javax.jcr.PropertyType.BOOLEAN |
| Whether or not the paged search result is retrieved via Ajax |
nextFrameURI | javax.jcr.PropertyType.STRING |
| The relative URL for next paged frame |
pagingFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The paging font Node (sv:font) |
pagingPosition | javax.jcr.PropertyType.STRING |
| Where the paging navigation should be located ("top", "bottom" or "top_bottom") |
previousFrameURI | javax.jcr.PropertyType.STRING |
| The relative URL for previous paged frame |
startAtHit | javax.jcr.PropertyType.LONG |
| First hit number for the paged search result |
usePaging | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to use paging |
|
|
| HIGHLIGHTING |
searchHitHighlightingFragsize | javax.jcr.PropertyType.LONG |
Size (approximated char count) for highlighted fragments | |
searchHitHighlightingType | javax.jcr.PropertyType.STRING |
| Type of highlighting ("strong" or "em") |
useSearchHitHighlighting | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to use search hit highlighting |
|
|
| INDEX FIELDS |
lastPublishedField | javax.jcr.PropertyType.STRING |
| Name of the last published field |
mimetypeField | javax.jcr.PropertyType.STRING |
| Name of the mime type field |
nameField | javax.jcr.PropertyType.STRING |
| Name of the name field |
namepathField | javax.jcr.PropertyType.STRING |
| Name of the name path field |
siteField | javax.jcr.PropertyType.STRING |
| Name of the site field |
sizeField | javax.jcr.PropertyType.STRING |
| Name of the size field |
summaryField | javax.jcr.PropertyType.STRING |
| Name of the summary field |
titleField | javax.jcr.PropertyType.STRING |
| Name of the title field |
urlField | javax.jcr.PropertyType.STRING |
| Name of the absolute URL field |
uriField | javax.jcr.PropertyType.STRING |
| Name of the relative URL field |
|
|
| SEARCH HITS |
headingField | javax.jcr.PropertyType.STRING |
| What field to fetch the heading text from ("nameField" or "titleField", see Index fields section above) |
searchHitBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE |
| The background color for every odd search hit (sv:color) |
searchHitExcerptFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The hit excerpt font Node (sv:font) |
searchHitExcerptLength | javax.jcr.PropertyType.LONG |
| Approximate length (char count) for search hit excerpts |
searchHitHeadingFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The hit heading font Node (sv:font) |
searchHitInfoFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The hit info font Node (sv:font) |
searchHitPathFont | javax.jcr.PropertyType.WEAKREFERENCE |
| The hit path font Node (sv:font) |
showFileIcons | javax.jcr.PropertyType.BOOLEAN |
| Whether or not a file icons should be displayed for each search hit |
showSearchHitExcerpt | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to show hit excerpts |
showSearchHitInfo | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to show hit info (date + size) |
showSearchHitNumbering | javax.jcr.PropertyType.BOOLEAN |
| Whether or not search hits should be displayed numbered |
showSearchHitPath | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to show a linked path to the search hit |
useSearchHitBackgroundColor | javax.jcr.PropertyType.BOOLEAN |
| Whether or not a searchHitBackgroundColor (see line below) are in use |
FACETING | |
facetsBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE |
Background color Node (sv:color) to use for the faceting result | |
facetNameFont | javax.jcr.PropertyType.WEAKREFERENCE |
The facet name font Node (sv:font) | |
facetValueFont | javax.jcr.PropertyType.WEAKREFERENCE |
The facet value font Node (sv:font) | |
hasFacetsToRender | javax.jcr.PropertyType.BOOLEAN |
Convenience to check if there are any facets that actually should be rendered. | |
hideEmptyFacetValue | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to hide empty facet values |
selectedFacetValueBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE |
Background color Node (sv:color) to use for selected facet values | |
selectedFacetValueFont | javax.jcr.PropertyType.WEAKREFERENCE |
The font Node (sv:font) to use for selected facet values | |
| MISC |
hasCustomSortsToRender | javax.jcr.PropertyType.BOOLEAN |
Convenience to check if there are any custom sorts that actually should be rendered. | |
nonce | javax.jcr.PropertyType.STRING |
The nonce attribute value for the current request | |
useCustomSortFields | javax.jcr.PropertyType.BOOLEAN |
| Whether or not to use custom sort fields (i.e. use a custom "relevance" sorting") |
useCustomIndex | javax.jcr.PropertyType.BOOLEAN |
| Whether or not a custom index is used |
|
|
| AGGREGATED PORTLET PREFERENCES/SETTINGS: |
bundle | javax.jcr.PropertyType.WEAKREFERENCE |
| A temporary Node holding all i18n:ized texts used for output. See available properties in table below |
templates | javax.jcr.PropertyType.WEAKREFERENCE |
| A temporary Node holding all sub-templates used by the main template. See available properties in table below |
Name | Type and Description |
|---|---|
didYouMeanTemplate | javax.jcr.PropertyType.STRING |
| The Did you mean Velocity template |
hitCountTemplate | javax.jcr.PropertyType.STRING |
| The hit count Velocity template |
hitsTemplate | javax.jcr.PropertyType.STRING |
| The search hits Velocity template |
noHitsTemplate | javax.jcr.PropertyType.STRING |
| The no hits/search error Velocity template |
pagingTemplate | javax.jcr.PropertyType.STRING |
| The paging Velocity template |
pagingScriptTemplate | javax.jcr.PropertyType.STRING |
| The paging script Velocity template |
searchFormTemplate | javax.jcr.PropertyType.STRING |
| The search form Velocity template |
searchFormScriptTemplate | javax.jcr.PropertyType.STRING |
| The search form script Velocity template |
Name | Type and Description |
|---|---|
checkSpellingText | javax.jcr.PropertyType.STRING |
| The i18n:ized check spelling text (en: "Check spelling.") |
didYouMeanText | javax.jcr.PropertyType.STRING |
| The i18n:ized did you mean text (en: "Did you mean:") |
lastModifiedText | javax.jcr.PropertyType.STRING |
| The i18n:ized last modified text (en: "Last modified:") |
nextText | javax.jcr.PropertyType.STRING |
| The i18n:ized next text (en: "Next") |
noHitsPatternText | javax.jcr.PropertyType.STRING |
| The i18n:ized and parameterized no hits text (en: "Your search <strong>{0}</strong> did not match any documents") |
numberOfHitsText | javax.jcr.PropertyType.STRING |
| The i18n:ized number of hits text (en: "Number of hits:") |
ofText | javax.jcr.PropertyType.STRING |
| The i18n:ized of text (en: "of") |
previousText | javax.jcr.PropertyType.STRING |
The i18n:ized previous text (en: "Previous") | |
searchHereText | javax.jcr.PropertyType.STRING |
| The i18n:ized search here text (en: "Search here") |
searchPhraseHitCountPatternText | javax.jcr.PropertyType.STRING |
| The i18n:ized and parameterized phrase/count text (en: "Your search <strong>{0}</strong> resulted in <strong>{1}</strong> {1,choice,0#hits|1#hit|2#hits}") |
searchTipText | javax.jcr.PropertyType.STRING |
| The i18n:ized search tip text (en: "To find what you are looking for, try one of the following:") |
showingHitText | javax.jcr.PropertyType.STRING |
| The i18n:ized showing hit text (en: "Showing hit") |
showingHitsText | javax.jcr.PropertyType.STRING |
he i18n:ized showing hits text (en: "Showing hits") | |
sizeText | javax.jcr.PropertyType.STRING |
| The i18n:ized size text (en: "Size:") |
useGenericText | javax.jcr.PropertyType.STRING |
| The i18n:ized use generic text (en: "Use less words or more common words.") |
useSynonymText | javax.jcr.PropertyType.STRING |
| The i18n:ized use synonym text (en: "Try a synonym or a similar term.") |
useWildcardText | javax.jcr.PropertyType.STRING |
| The i18n:ized use wildcard text (en: "Use an asterisk to find other word endings. If you want to search for web<em>site</em> and web<em>page</em>, use web*.") |
youSearchedForText | javax.jcr.PropertyType.STRING |
| The i18n:ized you searched for text (en:"You searched for:") |