#*
Copyright 2004 The Apache Software Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*#

<div>
<center>
  <table cellpadding="2" cellspacing="0" border="1" width="600">
    <tr>
      <td>
        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.
      </td>
    </tr>
  </table>
</center>
<br>
  <table cellpadding="2" cellspacing="0" border="1" width="100%">
    <tr>
      <th>Variable</th>
      <th>Value</th>
    </tr>
    <tr>
      <th colspan="2"><center>General URL</center></th>
    </tr>
    <tr>
      <td>jslink</td>
      <td>$jslink</td>
    </tr>
    <tr>
      <td>jslink.HomePage</td>
      <td>$jslink.HomePage</td>
    </tr>
    <tr>
      <th colspan="2"><center>Templates in the URL</center></th>
    </tr>
    <tr>
      <td>jslink.Template</td>
      <td>$jslink.Template</td>
    </tr>
    <tr>
      <td>jslink.getTemplate("myScreen")</td>
      <td>$jslink.getTemplate("myScreen")</td>
    </tr>
    <tr>
      <th colspan="2"><center>Path and Query item on URL</center></th>
    </tr>
    <tr>
      <td>jslink.addPathInfo("pathItem","Item_value")</td>
      <td>$jslink.addPathInfo("pathItem","Item_value")</td>
    </tr>
    <tr>
      <td>jslink.addQueryData("QueryData","Data_value")</td>
      <td>$jslink.addQueryData("QueryData","Data_value")</td>
    </tr>
    <tr>
      <td>jslink.getAction("myAction").addQueryData("QueryData","Data_value")</td>
      <td>$jslink.getAction("myAction").addQueryData("QueryData","Data_value")</td>
    </tr>
    <tr>
      <th colspan="2"><center>Actions items in the URL</center></th>
    </tr>
    <tr>
      <td>jslink.ActionKey</td>
      <td>$jslink.ActionKey</td>
    </tr>
    <tr>
      <td>jslink.getAction("save")</td>
      <td>$jslink.getAction("save")</td>
    </tr>
    <tr>
      <td>jslink.getAction("update","p12345")</td>
      <td>$jslink.getAction("update","p12345")</td>
    </tr>
    <tr>
      <td>jslink.getAction("update",\$portlet)</td>
      <td>$jslink.getAction("update",$portlet)</td>
    </tr>
    <tr>
      <th colspan="2"><center>Group/Role/User/Page element on URL</center></th>
    </tr>

    <tr>
      <td>jslink.getGroup("Warehouse")</td>
      <td>$jslink.getGroup("Warehouse")</td>
    </tr>
    <tr>
      <td>jslink.getGroup("lab","LabHome")</td>
      <td>$jslink.getGroup("lab","LabHome")</td>
    </tr>
    <tr>
      <td>jslink.getRole("manager")</td>
      <td>$jslink.getRole("manager")</td>
    </tr>
    <tr>
      <td>jslink.getRole("clerk","ClerkHome")</td>
      <td>$jslink.getRole("clerk","ClerkHome")</td>
    </tr>
    <tr>
      <td>jslink.getUser("joe")</td>
      <td>$jslink.getUser("joe")</td>
    </tr>
    <tr>
      <td>jslink.getUser("sam","sam_home")</td>
      <td>$jslink.getUser("sam","sam_home")</td>
    </tr>
    <tr>
      <td>jslink.Page</td>
      <td>$jslink.Page</td>
    </tr>
    <tr>
      <td>jslink.getPage("myPage")</td>
      <td>$jslink.getPage("myPage")</td>
    </tr>
    <tr>
      <th colspan="2"><center>Pane items in the URL</center></th>
    </tr>
    <tr>
      <td>jslink.getPaneById("P_12345")</td>
      <td>$jslink.getPaneById("P_12345")</td>
    </tr>
    <tr>
      <td>jslink.getPaneById("Pane_3,SubPane_17")</td>
      <td>$jslink.getPaneById("Pane_3,SubPane_17")</td>
    </tr>
    <tr>
      <td>jslink.getPaneByName("pane_1")</td>
      <td>$jslink.getPaneByName("pane_1")</td>
    </tr>
    <tr>
      <th colspan="2"><center>Portlet items in the URL</center></th>
    </tr>
    <tr>
      <td>jslink.getPortletById("P_56789_1234")</td>
      <td>$jslink.getPortletById("P_56789_1234")</td>
    </tr>
    <tr>
      <td>jslink.getPortletByName("portlet_2")</td>
      <td>$jslink.getPortletByName("portlet_2")</td>
    </tr>
    <tr>
      <th colspan="2"><center>Information about the PSML Document</center></th>
    </tr>
    <tr>
      <td>jslink.Anonymous</td>
      <td>$jslink.Anonymous</td>
    </tr>
    <tr>
      <td>jslink.GroupName</td>
      <td>$jslink.GroupName</td>
    </tr>
    <tr>
      <td>jslink.RoleName</td>
      <td>$jslink.RoleName</td>
    </tr>
    <tr>
      <td>jslink.UserName</td>
      <td>$jslink.UserName</td>
    </tr>
    <tr>
      <td>jslink.PageName</td>
      <td>$jslink.PageName</td>
    </tr>
    <tr>
      <td>jslink.MediaType</td>
      <td>$jslink.MediaType</td>
    </tr>
    <tr>
      <td>jslink.Country</td>
      <td>$jslink.Country</td>
    </tr>
    <tr>
      <td>jslink.Language</td>
      <td>$jslink.Language</td>
    </tr>
  </table>
  <br>
  <table cellpadding="2" cellspacing="0" border="1" width="100%">
    <tr>
      <th colspan="2"><center>setLink()</center></th>
    </tr>
    <tr>
      <th colspan="2"align="left">Variable</th>
    <tr>
    </tr>
      <td width="10%">&nbsp;</td>
      <th align="left">Value</th>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.CURRENT,"abc", \$jslink.PageName, \$jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.CURRENT,"abc", $jslink.PageName, $jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.CURRENT,"abc","", \$jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.CURRENT,"abc","", $jslink.PANE_ID,"123","myAction","myTemplate","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.DEFAULT,"def", \$jslink.DEFAULT_PAGE, \$jslink.PANE_NAME,"456","myAction","myTemplate","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.DEFAULT,"def", $jslink.DEFAULT_PAGE, $jslink.PANE_NAME,"456","myAction","myTemplate","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.GROUP,"apache","news", \$jslink.PORTLET_ID,"789","myAction","myTemplate","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.GROUP,"apache","news", $jslink.PORTLET_ID,"789","myAction","myTemplate","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.ROLE,"manager","status", \$jslink.PORTLET_NAME,"abc","myAction","myTemplate","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.ROLE,"manager","status", $jslink.PORTLET_NAME,"abc","myAction","myTemplate","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.USER,"joe","birthdays",\$jslink.CURRENT,"def","Template","Action","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.USER,"joe","birthdays",$jslink.CURRENT,"def","Template","Action","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.USER,"joe","birthdays",\$jslink.DEFAULT,"ghi","Template","Action","html","en","US")</td>
    </tr>
    <tr>
      <td width="10%">&nbsp;</td>
      <td>$jslink.getLink($jslink.USER,"joe","birthdays",$jslink.DEFAULT,"ghi","Template","Action","html","en","US")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.GROUP,"apache","news",301,"1234","Template","Action")</td>
    </tr>
    <tr>
      <td width="5%"></td>
      <td>$jslink.getLink($jslink.GROUP,"apache","news",301,"1234","Template","Action")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.USER,"turbine","default.psml",305,"HelloVelocity","controls.Maximize","","html")</td>
    </tr>
    <tr>
      <td width="5%"></td>
      <td>$jslink.getLink($jslink.USER,"turbine","default.psml",305,"HelloVelocity","controls.Maximize","","html")</td>
    </tr>

    <tr>
      <td colspan="2">\$jslink.getLink(\$jslink.CURRENT,"","default.psml",305,"DatabaseBrowserTest","controls.Print","","html")</td>
    </tr>
    <tr>
      <td width="5%"></td>
      <td>$jslink.getLink($jslink.CURRENT,"","default.psml",305,"DatabaseBrowserTest","controls.Print","","html")</td>
    </tr>
    
  </table>

</div>