Below are examples of using $jslink with Velocity. Only the syntax of the URLs is valid, so do not expect them to return a page.

Variable Value
General URL
jslink $jslink
jslink.HomePage $jslink.HomePage
Templates in the URL
jslink.Template $jslink.Template
jslink.getTemplate("myScreen") $jslink.getTemplate("myScreen")
Path and Query item on URL
jslink.addPathInfo("pathItem","Item_value") $jslink.addPathInfo("pathItem","Item_value")
jslink.addQueryData("QueryData","Data_value") $jslink.addQueryData("QueryData","Data_value")
jslink.getAction("myAction").addQueryData("QueryData","Data_value") $jslink.getAction("myAction").addQueryData("QueryData","Data_value")
Actions items in the URL
jslink.ActionKey $jslink.ActionKey
jslink.getAction("save") $jslink.getAction("save")
jslink.getAction("update","p12345") $jslink.getAction("update","p12345")
jslink.getAction("update",\$portlet) $jslink.getAction("update",$portlet)
Group/Role/User/Page element on URL
jslink.getGroup("Warehouse") $jslink.getGroup("Warehouse")
jslink.getGroup("lab","LabHome") $jslink.getGroup("lab","LabHome")
jslink.getRole("manager") $jslink.getRole("manager")
jslink.getRole("clerk","ClerkHome") $jslink.getRole("clerk","ClerkHome")
jslink.getUser("joe") $jslink.getUser("joe")
jslink.getUser("sam","sam_home") $jslink.getUser("sam","sam_home")
jslink.getPage("myPage") $jslink.getPage("myPage")
Pane items in the URL
jslink.getPaneById("P_12345") $jslink.getPaneById("P_12345")
jslink.getPaneByName("pane_1") $jslink.getPaneByName("pane_1")
Portlet items in the URL
jslink.getPortletById("P_56789_1234") $jslink.getPortletById("P_56789_1234")
jslink.getPortletByName("portlet_2") $jslink.getPortletByName("portlet_2")
Information about the PSML Document
jslink.Anonymous $jslink.Anonymous
jslink.GroupName $jslink.GroupName
jslink.RoleName $jslink.RoleName
jslink.UserName $jslink.UserName
jslink.PageName $jslink.PageName
jslink.MediaType $jslink.MediaType
jslink.Country $jslink.Country
jslink.Language $jslink.Language

setLink()
Variable
  Value
$jslink.getLink(\$jslink.CURRENT,"abc", \$jslink.PageName, \$jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")
  $jslink.getLink($jslink.CURRENT,"abc", $jslink.PageName, $jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")
\$jslink.getLink(\$jslink.CURRENT,"abc","", \$jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")
  $jslink.getLink($jslink.CURRENT,"abc","", $jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")
\$jslink.getLink(\$jslink.DEFAULT,"def", \$jslink.DEFAULT_PAGE, \$jslink.PANE_NAME,"456","myAction","myTemplate","html","en","US")
  $jslink.getLink($jslink.DEFAULT,"def", $jslink.DEFAULT_PAGE, $jslink.PANE_NAME,"456","myAction","myTemplate","html","en","US")
\$jslink.getLink(\$jslink.GROUP,"apache","news", \$jslink.PORTLET_ID,"789","myAction","myTemplate","html","en","US")
  $jslink.getLink($jslink.GROUP,"apache","news", $jslink.PORTLET_ID,"789","myAction","myTemplate","html","en","US")
\$jslink.getLink(\$jslink.ROLE,"manager","status", \$jslink.PORTLET_NAME,"abc","myAction","myTemplate","html","en","US")
  $jslink.getLink($jslink.ROLE,"manager","status", $jslink.PORTLET_NAME,"abc","myAction","myTemplate","html","en","US")
\$jslink.getLink(\$jslink.USER,"joe","birthdays",\$jslink.CURRENT,"def","Template","Action","html","en","US")
  $jslink.getLink($jslink.USER,"joe","birthdays",$jslink.CURRENT,"def","Template","Action","html","en","US")
\$jslink.getLink(\$jslink.USER,"joe","birthdays",\$jslink.DEFAULT,"ghi","Template","Action","html","en","US")
  $jslink.getLink($jslink.USER,"joe","birthdays",$jslink.DEFAULT,"ghi","Template","Action","html","en","US")
\$jslink.getLink(\$jslink.GROUP,"apache","news",301,"1234","Template","Action")
$jslink.getLink($jslink.GROUP,"apache","news",301,"1234","Template","Action")