Predefined search portlet
The custom Velocity template in this portlet uses the JCR (Java Content Repository, JSR 283) programming model. The SiteVision API is available here
| Name | Type and Description |
|---|---|
| request | javax.portlet.PortletRequest |
| The portlet request | |
| portlet | javax.jcr.Node |
| This portlet. See available properties in table below | |
| jcrSession | javax.jcr.Session |
| The JCR Session | |
| sitevisionUtils | senselogic.sitevision.api.Utils |
| The main entry point to all utility classes | |
| velocityEvaluator | senselogic.sitevision.api.render.velocity.VelocityEvaluator |
| A evaluator that can parse Velocity templates or Velocity expressions on the fly | |
| searchResult | senselogic.sitevision.api.search.SearchResult |
| The search result that holds all hits |
| Name | Type and Description | |
|---|---|---|
| Querying | ||
| predefinedSearchQuery | javax.jcr.PropertyType.STRING | |
| The search query expression | ||
| evaluatePredefinedSearchQuery | javax.jcr.PropertyType.BOOLEAN | |
| Whether predefinedSearchQuery should be evaluated via Velocity or not | ||
| Type restrictions | ||
| 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 | ||
| includeArticles | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include articles in the search result | ||
| includeStructurePages | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to include structure pages in the search result | ||
| No hits / Search failed | ||
| showSearchError | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to show search errors or no hits messages | ||
| 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) | ||
| Index fields | ||
| summaryField | javax.jcr.PropertyType.STRING | |
| Name of the summary field | ||
| titleField | javax.jcr.PropertyType.STRING | |
| Name of the title field | ||
| nameField | javax.jcr.PropertyType.STRING | |
| Name of the name field | ||
| namepathField | javax.jcr.PropertyType.STRING | |
| Name of the name path field | ||
| urlField | javax.jcr.PropertyType.STRING | |
| Name of the absolute URL field | ||
| uriField | javax.jcr.PropertyType.STRING | |
| Name of the relative URL field | ||
| lastPublishedField | javax.jcr.PropertyType.STRING | |
| Name of the last published field | ||
| sizeField | javax.jcr.PropertyType.STRING | |
| Name of the size field | ||
| siteField | javax.jcr.PropertyType.STRING | |
| Name of the site field | ||
| mimetypeField | javax.jcr.PropertyType.STRING | |
| Name of the mime type field | ||
| Hit count | ||
| useMaxSearchHits | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to limit number of search hits | ||
| maxSearchHits | javax.jcr.PropertyType.LONG | |
| Maximum number of search hits | ||
| Search hits | ||
| showSearchHitNumbering | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not search hits should be displayed numbered | ||
| showFileIcons | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not a file icons should be displayed for each search hit | ||
| useSearchHitBackgroundColor | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not a searchHitBackgroundColor (see line below) are in use | ||
| searchHitBackgroundColor | javax.jcr.PropertyType.WEAKREFERENCE | |
| The background color for every odd search hit (sv:color) | ||
| headingField | javax.jcr.PropertyType.STRING | |
| What field to fetch the heading text from ("nameField" or "titleField", see Index fields section above) | ||
| searchHitHeadingFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The hit heading font Node (sv:font) | ||
| showSearchHitExcerpt | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to show hit excerpts | ||
| 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 | ||
| showSearchHitInfo | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to show hit info (date + size) | ||
| searchHitInfoFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The hit info font Node (sv:font) | ||
| showSearchHitPath | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to show a linked path to the search hit | ||
| searchHitPathFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The hit path font Node (sv:font) | ||
| Misc | ||
| 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: | ||
| templates | javax.jcr.PropertyType.WEAKREFERENCE | |
| A temporary Node holding all sub-templates used by the main template. See available properties in table below | ||
| bundle | javax.jcr.PropertyType.WEAKREFERENCE | |
| A temporary Node holding all i18n:ized texts used for output. See available properties in table below |
| Name | Type and Description | |
|---|---|---|
| hitsTemplate | javax.jcr.PropertyType.STRING | |
| The search hits Velocity template | ||
| noHitsTemplate | javax.jcr.PropertyType.STRING | |
| The no hits/search error Velocity template |
| Name | Type and Description | |
|---|---|---|
| noInformationAvailableText | javax.jcr.PropertyType.STRING | |
| The i18n:ized last modified text (en: "No information available") | ||
| lastModifiedText | javax.jcr.PropertyType.STRING | |
| The i18n:ized last modified text (en: "Last modified:") | ||
| sizeText | javax.jcr.PropertyType.STRING | |
| The i18n:ized size text (en: "Size:") |
Sidan uppdaterad:
Nästa generations publiceringsverktyg är här!
se-sto-pio-sv5-1
216.73.217.134
216.73.217.134