NOTE! This portlet shows the result based on the request invoked via a Tag cloud portlet.
The custom Velocity template in the Tag cloud 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 | |
---|---|---|
Days | ||
limitNofDays | javax.jcr.PropertyType.BOOLEAN | |
Whether to limit number of days or not | ||
nofDays | javax.jcr.PropertyType.LONG | |
Number of days | ||
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) | ||
Paging | ||
usePaging | javax.jcr.PropertyType.BOOLEAN | |
Whether or not to use paging | ||
hitsPerPage | javax.jcr.PropertyType.LONG | |
Maximum number of hits to display for each 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") | ||
ajaxPagingBaseURL | javax.jcr.PropertyType.STRING | |
The base URL to use for Ajax paging calls | ||
isRenderingAjaxPagingResult | javax.jcr.PropertyType.BOOLEAN | |
Whether or not the paged search result is retrieved via Ajax | ||
startAtHit | javax.jcr.PropertyType.LONG | |
First hit number for the paged search result | ||
previousFrameURI | javax.jcr.PropertyType.STRING | |
The relative URL for previous paged frame | ||
nextFrameURI | javax.jcr.PropertyType.STRING | |
The relative URL for next paged frame | ||
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 | ||
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 | |
---|---|---|
pagingTemplate | javax.jcr.PropertyType.STRING | |
The paging Velocity template | ||
pagingScriptTemplate | javax.jcr.PropertyType.STRING | |
The paging script Velocity template | ||
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:") | ||
previousText | javax.jcr.PropertyType.STRING | |
The i18n:ized previous text (en: "Previous") | ||
nextText | javax.jcr.PropertyType.STRING | |
The i18n:ized next text (en: "Next") |
Sidan uppdaterad:
Nästa generations publiceringsverktyg är här!