Localizing Actions and Action Models
Use .rbInfo files to localize the properties for your action and action models.
Localize Actions
The format for entries in the .rbInfo is:
<objecttype name>.<action name>.<purpose>.value=<value>
|
Element
|
Possible Values
|
Description
|
|---|---|---|
|
object type name
|
Corresponds to the name value for objecttype in the actions.xml file.
|
|
|
action name
|
Corresponds to the name value for action in the actions.xml file.
|
|
|
purpose
|
title
description
tooltip
icon
morurlinfo
hotkey
|
title—Localizable text for the title bar if the action appears in an action window.
description—Localizable text for the label of the action.
tooltip—Localizable text shown when hovering over the action.
icon: An image file, relative to codebase/netmarkets/images
moreurlinfo: Parameters used to size the window for this actions
hotkey: The alphanumeric key to trigger this action.
|
|
value
|
The actual value for the entry.
|
For example:
<objecttype name="document" class="wt.doc.WTDocument"
resourceBundle="com.ptc.windchill.enterprise.doc.documentResource">
<action name="create" uicomponent="CREATE_DOC" dtiUpload="true">
<command
class="com.ptc.windchill.enterprise.doc.forms.CreateDocFormProcessor"
method="execute" windowType="popup"
onClick="validateCreateLocation(event)"/>
<includeFilter name="projectM4D" />
</action>
</objecttype>
resourceBundle="com.ptc.windchill.enterprise.doc.documentResource">
<action name="create" uicomponent="CREATE_DOC" dtiUpload="true">
<command
class="com.ptc.windchill.enterprise.doc.forms.CreateDocFormProcessor"
method="execute" windowType="popup"
onClick="validateCreateLocation(event)"/>
<includeFilter name="projectM4D" />
</action>
</objecttype>
The documentResource.rbinfo file contains an entry as follows:
document.create.title.value=New Document
document.create.description.value=New Document
document.create.tooltip.value=Add a new document with or without attached
content
document.create.icon.value=newdoc.gif
document.create.moreurlinfo.value=height=1000,width=820
document.create.description.value=New Document
document.create.tooltip.value=Add a new document with or without attached
content
document.create.icon.value=newdoc.gif
document.create.moreurlinfo.value=height=1000,width=820
Icon and tooltip are shown here in the toolbar and also in the menus. Note that icons for actions in the menus are only displayed for actions that also display in the toolbar:
document.create.title.value=New Document
document.create.description.value=New Document
document.create.description.value=New Document
Title:
Icon and description:
document.create.description.value=New Document
document.create.icon.value=newdoc.gif
document.create.icon.value=newdoc.gif
You can also specify a resourceBundle property on the on the <objecttype> element. If an <action> element does not specify a resourceBundle property, the resourceBundle property specified on the <objecttype> element for that action is used.
Localize Action Models
Some action models need a display label (for example, third-level navigation action models or menu bar action models). You can specify the rbInfo to use on your action model:
<model name="relatedItems"
resourceBundle="com.ptc.core.ui.navigationRB">
resourceBundle="com.ptc.core.ui.navigationRB">
The entries follow the same format as that of the actions:
object.relatedItems.description.value=
<U class="mnemonic">R</U>elated Objects
object.relatedItems.description.comment=Used for the
text on the Related Objects third level navigation menu.
object.relatedItems.hotkey.value=r
object.relatedItems.hotkey.comment=Mnemonic
<U class="mnemonic">R</U>elated Objects
object.relatedItems.description.comment=Used for the
text on the Related Objects third level navigation menu.
object.relatedItems.hotkey.value=r
object.relatedItems.hotkey.comment=Mnemonic
The <U class="mnemonic > </U> tag should be put around the character that is the access key (“R” in the example above).
Parent topic