The Label object contains a name and descriptive information that is displayed in the Probekit registry. A probe can contain many labels, each containing the user-visible information in a different language. The Probekit registry selects and displays the label that is appropriate for the locale. You can specify a default label to be displayed when no matching locale-specific label is provided.
The Label object is optional. Labels are used only for identification, they do not affect the operation of the probe.
Property | Description |
---|---|
xml:lang | Optional. Specify the locale code for the label (for example, "en" for english, "fr" for french). This value must be in the same format used by the java.Locale class. If this property is not specified or is an empty string, this label will be displayed by default when no other label matches the user's locale. A probe source file can only have one default label. |
name | Required. Specify a name to be displayed in the Probekit registry. This value should be short, appropriate for display in a list of user-selectable probes. |
description | Optional. Specify descriptive information about the probe to be displayed in the Probekit registry. This value should be longer and more detailed than the label name. |
In this example, the first label will be displayed in a french locale. The second label, since it has no xml:lang attribute, will be displayed by default in all other locales.
<probekit> <label xml:lang="fr" name="Exemple" description="Une sonde d'exemple"/> <label name= "Example" description="An example probe"/> <probe> ... </probe> </probekit>
Contained by
The Probekit object
Parent topic: Probekit element reference