View source for Custom Labels For Developers

__TOC__
===Accessing a Custom Label in JAVA===
{{:translateToken}}

===Accessing a Custom Label in HTML===
In HTML:
*The <tt>category</tt> and <tt>tokens</tt> defined in [[Custom Labels]] are used to construct a <tt>key</tt>.
*The key and related arguments are passed to a [[#Message Tags|Message Tag]], which returns a localized message.

====Creating a Key====
To access a Custom Label in HTML, you create a ''key'', using the same format as Template Variables:
:{|
{{:key}}
|}

:where
::;<tt>categoryname</tt>:Name of the Category
::;<tt>token</tt>:Name of the Token

;Example:
For a category named ''webtab'', create the following tokens:

::;<tt>welcome_msg = Welcome to the {0}</tt>
::;<tt>message = This application keeps track of your customer service requests quickly and easily</tt>

To create language labels using the custom label <tt>key</tt>, add arguments as follows:
::<tt>{#webtab.welcome_msg^ABC} </tt>
::
:::Which displays in the UI as: ''Welcome to the ABC''

;Considerations:
*The carat <tt>(^)</tt> character is used to separate arguments passed to the function
*If the argument is missing (<tt>{#webtab.message}</tt>), the default message is displayed: ''This application keeps track of your customer service requests quickly and easily.''
*Tokens are supported in:
:*[[Web Tabs]], using:
::*HTML
::*Raw HTML
::*Components
:*[[Components]]

;Example:
:{|
<pre>
<html>
  <head>
    <title></title>
  </head>

  <body>

    <h1>{#webtab.welcom_msg^ABC}</h1>

    <p>{#webtab.messge}</p>
   
  </body>
</html>
</pre>
|}

====Using Message Tags====
Message Tags support multiple languages, using Custom Labels created in the Translation Workbench. 
:* When a message tag is implemented, the message appears in the default language (selected via [[Company Information]]).
:* Message tags are part of the LongJump Tag library
::* The LongJump Tag Library is a [http://java.sun.com/j2ee/tutorial/1_3-fcs/doc/JSPTags.html Java Custom Tag Library]
:* If the <tt>key</tt> is not defined in the [[Translation Workbench]], the <tt>key</tt> defined in the call will be displayed.

;Syntax:
:<syntaxhighlight lang="java" enclose="div">
<%@ taglib uri="/LJTagLib" prefix="lj" %>
<lj:message key="#{category}.{token}" arg1="Julia" arg2="Jones"/>
</syntaxhighlight >

;Example:
Assume the following item is specified in the [[Translation Workbench]]:
:{| border="1" cellpadding="5" cellspacing="1"
| Category || <tt>webtab</tt>
|-
| Token || <tt>message</tt>
|-
| Message || <tt>Requester Name: {1}, {0}</tt>
|}

Then this code:
:<syntaxhighlight lang="java" enclose="div">
<%@ taglib uri="/LJTagLib" prefix="lj" %>
<html>
    <head>
        <title>Customer Details</title>
    </head>
    <body>
        <h1>Customer Details</h1>
           <p>All the details</p>
        <lj:message key="#webtab.message" arg1="Julia" arg2="Jones"/> 
    </body>
</html>
</syntaxhighlight >

Causes this text to be inserted into the HTML:
:<tt>Requester Name: Jones, Julia</tt>