SHIP:Node:alternate

Node Home

Node Type	Description
alternate	Defines a alternate translation for a text resource.

alternate nodes hold alternate text translations within text nodes within the resources area. To create a multi-language GUI:

• Define a text fragment in the resources area
• Add a series of alternate child nodes for the alternate language versions
• Use the text as an attached object for text layout nodes

When the system variable shiplanguage changes, if an alternate translation matching this language exists, the GUI automatically will be updated. If an alternate translation for this text does not exist, the default text within the text resources will be used.

As with text, UTF-8 encoding is used for alternate node values.

Ancestors

alternate nodes are only permitted within the resources area and within the following nodes:

Node Type	Description
text†	Defines a text resource or a visual text representation.

^†alternate nodes are permitted only directly underneath these nodes.

Descendants

The following nodes are permitted within alternates:

Node Type	Description
constant	Defines a constant value for use in SHIPTide properties or SAIL scripts.
group	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.

Properties

Property Name	Data Type	Description
name**	String	The name used to identify this node in SHIPTide.
language
value	String	Value of a text resource or layout area node.

**available only in SHIPTide; cannot be accessed from Sail scripts at run-time.