A-Z listing

Elements available in the Velocity Context

Name

Type and description

jcrSession

javax.jcr.Session


The JCR Session

portlet

javax.jcr.Node


This portlet. See properties below

request

javax.portlet.PortletRequest


The portlet request

searchResult

senselogic.sitevision.api.search.SearchResult


The search result

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

 

Additional properties available for the portlet element ($portlet)

Name

Type and Description



 

LETTER AND QUERYING

ajaxLetterBaseURL

javax.jcr.PropertyType.STRING

 

Base URL to use for Ajax querying calls

autoSelectFirstLetter

javax.jcr.PropertyType.BOOLEAN

 

Whether or not to auto select first letter (likely A) if no specific letter query was invoked

contentMarker

javax.jcr.PropertyType.STRING

 

The unique content marker

idMarker

javax.jcr.PropertyType.STRING

 

The unique id marker

letterFont

javax.jcr.PropertyType.WEAKREFERENCE

 

The letter font Node (sv:font)

letterMarker

javax.jcr.PropertyType.STRING

 

The unique letter marker

searchField

javax.jcr.PropertyType.STRING

 

What field to query ("nameField" or "titleField", see fields section below)

selectedLetter

javax.jcr.PropertyType.STRING

 

The letter that is queried

selectedLetterFont

javax.jcr.PropertyType.WEAKREFERENCE

 

The selected letter font Node (sv:font)



 

TYPE RESTRICTIONS

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

  
 

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

uriField

javax.jcr.PropertyType.STRING

 

Name of the relative URL field

urlField

javax.jcr.PropertyType.STRING

 

Name of the absolute URL field

  
 

SEARCH HITS

searchHitBackgroundColor

javax.jcr.PropertyType.WEAKREFERENCE

 

The background color for every odd search hit (sv:color)

showFileIcons

javax.jcr.PropertyType.BOOLEAN

 

Whether or not a file icons should be displayed for each search hit

showSearchHitNumbering

javax.jcr.PropertyType.BOOLEAN

 

Whether or not search hits should be displayed numbered

useSearchHitBackgroundColor

javax.jcr.PropertyType.BOOLEAN

 

Whether or not a searchHitBackgroundColor (see line below) are in use

  
 

MISC

bundle

javax.jcr.PropertyType.WEAKREFERENCE

 

A temporary Node holding all i18n:ized texts used for output. See available properties in table below



 

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

useCustomIndex

javax.jcr.PropertyType.BOOLEAN

 

Whether or not a custom index is used

  

 

Properties available for sub-nodes of the letters Node

Name

Type and Description

isSelected

javax.jcr.PropertyType.BOOLEAN

 

Whether or not this letter is selected

letterURL

javax.jcr.PropertyType.STRING

 

The search URL for this letter

letter

javax.jcr.PropertyType.STRING

 

The letter

 

Properties available for the templates Node

Name

Type and Description

hitsTemplate

javax.jcr.PropertyType.STRING

 

The search hits Velocity template

lettersScriptTemplate

javax.jcr.PropertyType.STRING

 

The letter script Velocity template

lettersTemplate

javax.jcr.PropertyType.STRING

 

The letters listing Velocity template

noHitsTemplate

javax.jcr.PropertyType.STRING

 

The no hits/search error Velocity template

 

Properties available for the bundle Node

Name

Type and Description

noPagesFoundStartingWithText

javax.jcr.PropertyType.STRING

 

The i18n:ized search tip text (en: "Could not find any pages that starts with")