A-Z listing portlet
NOTE! As of SiteVision 3, this portlet replaces earlier versions of the A-Z portlet (that wasn't using the SiteVision Public API).
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 | |
|---|---|---|
| Letter and querying | ||
| autoSelectFirstLetter | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not to auto select first letter (likely A) if no specific letter query was invoked | ||
| letterFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The letter font Node (sv:font) | ||
| selectedLetterFont | javax.jcr.PropertyType.WEAKREFERENCE | |
| The selected letter font Node (sv:font) | ||
| searchField | javax.jcr.PropertyType.STRING | |
| What field to query ("nameField" or "titleField", see fields section below) | ||
| ajaxLetterBaseURL | javax.jcr.PropertyType.STRING | |
| Base URL to use for Ajax querying calls | ||
| idMarker | javax.jcr.PropertyType.STRING | |
| The unique id marker | ||
| letterMarker | javax.jcr.PropertyType.STRING | |
| The unique letter marker | ||
| contentMarker | javax.jcr.PropertyType.STRING | |
| The unique content marker | ||
| selectedLetter | javax.jcr.PropertyType.STRING | |
| The letter that is queried | ||
| 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 | ||
| 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 | ||
| 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) | ||
| Misc | ||
| useCustomIndex | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not a custom index is used | ||
| Aggregated portlet preferences/settings: | ||
| letters | javax.jcr.PropertyType.WEAKREFERENCE | |
| A temporary Node holding all sub-templates used by the main template. See available properties in table below | ||
| templates | javax.jcr.PropertyType.WEAKREFERENCE | |
| A temporary Node with sub-nodes that holds properties about all letters. See available properties for letters sub-nodes 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 | |
|---|---|---|
| letter | javax.jcr.PropertyType.STRING | |
| The letter | ||
| isSelected | javax.jcr.PropertyType.BOOLEAN | |
| Whether or not this letter is selected | ||
| letterURL | javax.jcr.PropertyType.STRING | |
| The search URL for this letter |
| Name | Type and Description | |
|---|---|---|
| lettersTemplate | javax.jcr.PropertyType.STRING | |
| The letters listing Velocity template | ||
| lettersScriptTemplate | javax.jcr.PropertyType.STRING | |
| The letter 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 | |
|---|---|---|
| noPagesFoundStartingWithText | javax.jcr.PropertyType.STRING | |
| The i18n:ized search tip text (en: "Could not find any pages that starts with") |
Sidan uppdaterad:
Nästa generations publiceringsverktyg är här!
se-sto-ste-sv5-1
216.73.217.134
216.73.217.134