Template:TerminalAsDataType: Difference between revisions

Latest revision as of 11:14, 4 January 2025

[view] [edit] Template documentation

This documentation is transcluded from Template:TerminalAsDataType/doc (history).

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.

Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Provides a simple way to get terminal images as data type that link to the corresponding wiki page.

Parameters

Parameter	Description
`type`	Terminal type (control or indicator). Default is control.
1	Type name (e.g., string)

Type names

This is a complete reference of supported type names:

Type Name	Control	Indicator
String
String Array, 1D Array of String
U8, Unsigned Byte
U16, Unsigned Word
U32, Unsigned Long
U64, Unsigned Quad
I8, Byte
I16, Word
I32, Long
I64, Quad
CSG, Complex Single Float
CDB, Complex Double Float
CXT, Complex Extended Float
FXP, Fixed-Point
SGL, Single Precision
DBL, Double Precision
EXT, Extended Precision
Boolean
Variant
Error Cluster
Void
Enum U8
Enum U16, Enum
Enum U32
LabVIEW Object

Examples

Source	Result
`{{TerminalAsDataType\|type=control\|string}}`
`{{TerminalAsDataType\|type=indicator\|string}}`

@@ Line 4: / Line 4: @@
    | string array
    | 1d array of string = String Array.png{{!}}link=1D array of string
+  | byte
    | i8 = I8.png{{!}}link=I8
+  | word
    | i16 = I16.png{{!}}link=I16
+  | long
    | i32 = I32.png{{!}}link=I32
+  | quad
    | i64 = I64.png{{!}}link=I64
+  | unsigned byte
    | u8 = U8.png{{!}}link=U8
+  | unsigned word
    | u16 = U16.png{{!}}link=U16
+  | unsigned long
    | u32 = U32.png{{!}}link=U32
+  | unsigned quad
    | u64 = U64.png{{!}}link=U64
    | complex single float
@@ Line 26: / Line 34: @@
    | extended precision
    | ext = Extended Float.png{{!}}link=EXT
+  | boolean = Boolean.png{{!}}link=Boolean
+  | variant = LV Variant.png{{!}}link=Variant
+  | error cluster = Error Cluster.png{{!}}link=Error Cluster
+  | void = Void.png{{!}}link=Void
+  | enum u8 = Enum U8.png{{!}}link=Enum U8
+  | enum
+  | enum u16 = Enum U16.png{{!}}link=Enum U16
+  | enum u32 = Enum U32.png{{!}}link=Enum U32
+  | labview object = LabVIEW Object Control Terminal.png{{!}}link=LabVIEW Object
    }}
 | indicator = {{#switch:{{lc:{{{1}}}}}
@@ Line 31: / Line 48: @@
    | string array
    | 1d array of string = String Array Indicator.png{{!}}link=1D array of string
+  | byte
    | i8 = I8 Indicator.png{{!}}link=I8
+  | word
    | i16 = I16 Indicator.png{{!}}link=I16
+  | long
    | i32 = I32 Indicator.png{{!}}link=I32
+  | quad
    | i64 = I64 Indicator.png{{!}}link=I64
+  | unsigned byte
    | u8 = U8 Indicator.png{{!}}link=U8
+  | unsigned word
    | u16 = U16 Indicator.png{{!}}link=U16
+  | unsigned long
    | u32 = U32 Indicator.png{{!}}link=U32
+  | unsigned quad
    | u64 = U64 Indicator.png{{!}}link=U64
    | complex single float
@@ Line 53: / Line 78: @@
    | extended precision
    | ext = Extended Float Indicator.png{{!}}link=EXT
+  | boolean = Boolean Indicator.png{{!}}link=Boolean
+  | variant = LV Variant Indicator.png{{!}}link=Variant
+  | error cluster = Error Cluster Indicator.png{{!}}link=Error Cluster
+  | void = Void Indicator.png{{!}}link=Void
+  | enum u8 = <!-- Using U16 indicator because there is no visual difference -->Enum U16 Indicator.png{{!}}link=Enum U8
+  | enum
+  | enum u16 = Enum U16 Indicator.png{{!}}link=Enum U16
+  | enum u32 = Enum U32 Indicator.png{{!}}link=Enum U32
+  | labview object = LabVIEW Object Indicator Terminal.png{{!}}link=LabVIEW Object
    }}
 }}]]</includeonly><noinclude>{{documentation}}</noinclude>