Difference between revisions of "SHIP:Node:alternate"

From Serious Documentation
Jump to: navigation, search
(Created page with "Node Home __TOC__ {| class="wikitable" style="margin: 1em auto 1em auto;" ! scope="col" | Node Type ! scope="col" | Description |- |<onlyinclude>{{Node|alternat...")
 
(→‎Ancestors)
Line 18: Line 18:
  
 
== Ancestors ==
 
== Ancestors ==
−
The following nodes are permitted to have {{Node|alternate}}s as descendants:
+
 
 +
{{Node|alternate}} nodes are only permitted within the {{Node|resources}} area and within the following nodes:
 
{| class="wikitable" style="margin: 1em auto 1em auto;"  
 
{| class="wikitable" style="margin: 1em auto 1em auto;"  
 
! scope="col" | Node Type
 
! scope="col" | Node Type

Revision as of 07:13, 27 January 2013

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:

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.
SHIP:Property:all:language
SHIP:Property:all:text

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

Examples

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Node:alternate&oldid=2340"