Jump to content

Template:Labviewconfigurationkey/doc: Difference between revisions

From LabVIEW Wiki
m Use {{Documentation}} instead of {{template doc}}
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
If you want to experiment with the template goto: [[labviewconfigurationkeysandbox]]. For support issues on this template see [http://forums.lavag.org/LabVIEW-Configuration-Key-Template-t7814.html here].
<noinclude>{{documentation subpage}}</noinclude>
<includeonly>{{intricate template}}</includeonly>
If you want to experiment with the template goto: [[labviewconfigurationkeysandbox]].<br />
For support issues on this template see [http://forums.lavag.org/LabVIEW-Configuration-Key-Template-t7814.html here].
== Usage ==
== Usage ==
To use the template copy and paste the following code as shown below into the editable page.
To use the template copy and paste the following code as shown below into the editable page.
Line 57: Line 60:
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:
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:


[[Image:Configkeyexample.png|frame|center|Example formated output]]
{{ labviewconfigurationkey
| keyname =  copyDeleteFPDCOFromFPTerm
| example = copyDeleteFPDCOFromFPTerm=TRUE
| datatype = b
| description = Delete front panel terminals from diagram
| permitted_values = TRUE or FALSE
| default = FALSE
| LV1 = 3
| LV2 = 4
| LV3 = 5
| LV4 = 6
| LV5 = 7
| LV6 = 8
| OS1 = w
| OS2 = m
| OS3 = l
| OS4 = u
| notes =
}}


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
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
Line 68: Line 89:
|-
|-
| datatype
| datatype
| b=Boolean, i=Integer, s=string, p=path
| b=Boolean, i=Integer, s=string, p=path, h=Integer HEX, f=Float
|-
|-
| LV1-5
| LV1-6
| 3=3.x, 4=4.x, 5=5.x, 6=6.x, 7=7.x, 8=8.x
| 3=3.x, 4=4.x, 5=5.x, 6=6.x, 7=7.x, 8=8.x
|-
|-
Line 77: Line 98:
|}
|}
</center>
</center>
<includeonly>
[[Category:Templates]]
</includeonly>

Latest revision as of 16:10, 2 August 2024

This is the documentation page for Template:Labviewconfigurationkey.
When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

If you want to experiment with the template goto: labviewconfigurationkeysandbox.
For support issues on this template see here.

Usage

To use the template copy and paste the following code as shown below into the editable page.

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

Example

Shown below is an example of the template used with real values inserted.

{{ labviewconfigurationkey
| keyname =  copyDeleteFPDCOFromFPTerm
| example = copyDeleteFPDCOFromFPTerm=TRUE
| datatype = b
| description = Delete front panel terminals from diagram
| permitted_values = TRUE or FALSE
| default = FALSE
| LV1 = 3
| LV2 = 4
| LV3 = 5
| LV4 = 6
| LV5 = 7
| LV6 = 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:

copyDeleteFPDCOFromFPTerm

Example copyDeleteFPDCOFromFPTerm=TRUE
Description Delete front panel terminals from diagram
Datatype Boolean
Permitted Values TRUE or FALSE
Default Value FALSE
LabVIEW Versions

3.x , 4.x , 5.x , 6.x , 7.x , 8.x

OS's Supported

Notes

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, h=Integer HEX, f=Float
LV1-6 3=3.x, 4=4.x, 5=5.x, 6=6.x, 7=7.x, 8=8.x
OS1-4 w=, l=, m=, u=