Tag cloud

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

sitevisionUtils

senselogic.sitevision.api.Utils


The main entry point to all utility classes

 

Additional properties available for the portlet element ($portlet)


Name
Type and Description

cloud

javax.jcr.PropertyType.WEAKREFERENCE

 

The JCR-node containing the tag cloud data. The actual node can be resolved by calling getNode() on this property

limitNofTags

javax.jcr.PropertyType.BOOLEAN

 

Corresponds to the 'Limit number of tags' in the tag cloud configuration

nofTagsLimit

javax.jcr.PropertyType.LONG

 

Corresponds to the value of 'Limit number of tags' in the tag cloud configuration

orderBy

javax.jcr.PropertyType.STRING

 

Sort order ("alfabetic" or "weight")

showNofHits

javax.jcr.PropertyType.BOOLEAN

 

Corresponds to the 'Show number of hits' in the tag cloud configuration

tagFont

javax.jcr.PropertyType.WEAKREFERENCE

 

A Node that has property selectorText (java.lang.String) - the css class name of the font.

tagMinSize

javax.jcr.PropertyType.LONG

 

The min size in %

tagMaxSize

javax.jcr.PropertyType.LONG

 

The max size in %

type

javax.jcr.PropertyType.STRING

 

Type of display ("cloud" or "list")



The cloud node has a number of sub nodes which correspond the tags of the tag cloud.
NameType and Description

size

javax.jcr.PropertyType.LONG

 

The number of tags in the cloud



A tag node has the following properties:
NameType and Description

class

javax.jcr.PropertyType.STRING

 

The HTML class attribute for the tag

link

javax.jcr.PropertyType.STRING

 

The tag link (only availble if a search result page has been set up in the tag cloud configuration) pointing to the search result page

name

javax.jcr.PropertyType.STRING

 

The name of the tag. Corresponds to the metadata value

score

javax.jcr.PropertyType.DOUBLE

 

The score of the tag corresponding to the number of hits

weight

javax.jcr.PropertyType.LONG

 

The weight of the tag ranging from 100 to tagMaxSize with steps of 10