Jump to content

Template:Labviewconfigurationkey/doc

From LabVIEW Wiki

Usage

{{ labviewconfigurationkey
| keyname = 
| example =
| datatype =
| description =
| permitted_values =
| default =
| LV1 = 
| LV2 = 
| LV3 = 
| LV4 = 
| LV5 = 
| OS1 =
| OS2 =
| OS3 =
| OS4 =
| notes =
}}

Example

{{ labviewconfigurationkey
| keyname =  copyDeleteFPDCOFromFPTerm
| example = copyDeleteFPDCOFromFPTerm=TRUE
| datatype = b
| description = Delete front panel terminals from diagram
| permitted_values = TRUE or FALSE
| default = FALSE
| LV1 = 4
| LV2 = 5
| LV3 = 6
| LV4 = 7
| LV5 = 8
| OS1 = w
| OS2 = m
| OS3 = l
| OS4 = u
| notes =
}}

You do not need to include all rows. Any can be omitted. For example, if only one LabVIEW version is supported, the other LV parameters can be removed. You can also leave the parameter in place but not include a value. This may be useful for future edits. The above example produces the following formatted output:

Example formated output

The following parameters are explained further below. At any time, you can use a value that is not specified here. It will be accepted as typed. For example, if you want to specify LabVIEW version 6.0.1, then you would use: LV1 = 6.0.1

Parameter Name Options
datatype b=Boolean, i=Integer, s=string, p=path
LV1-5 4=4.x, 5=5.x, 6=6.x, 7=7.x, 8=8.x
OS1-4 w=, l=, m=, u=

If you want to experiment with the template goto: labviewconfigurationkeysandbox