Template:Labviewconfigurationkey/doc: Difference between revisions
New page: == Usage == {| style="background: transparent;" | <pre> {{ labviewconfigurationkey | keyname = | example = | datatype = | description = | permitted_values = | default = | LV1 = | LV2 = ... |
m Use {{Documentation}} instead of {{template doc}} |
||
| (17 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<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. | |||
{| style="background: transparent;" | {| style="background: transparent;" | ||
| | | | ||
| Line 15: | Line 21: | ||
| LV4 = | | LV4 = | ||
| LV5 = | | LV5 = | ||
| LV6 = | |||
| OS1 = | | OS1 = | ||
| OS2 = | | OS2 = | ||
| Line 25: | Line 32: | ||
== Example == | == Example == | ||
Shown below is an example of the template used with real values inserted. | |||
{| style="background: transparent;" | {| style="background: transparent;" | ||
| | | | ||
| Line 31: | Line 39: | ||
| keyname = copyDeleteFPDCOFromFPTerm | | keyname = copyDeleteFPDCOFromFPTerm | ||
| example = copyDeleteFPDCOFromFPTerm=TRUE | | example = copyDeleteFPDCOFromFPTerm=TRUE | ||
| datatype = | | datatype = b | ||
| description = Delete front panel terminals from diagram | | description = Delete front panel terminals from diagram | ||
| permitted_values = TRUE or FALSE | | permitted_values = TRUE or FALSE | ||
| default = FALSE | | default = FALSE | ||
| LV1 = 4 | | LV1 = 3 | ||
| | | LV2 = 4 | ||
| | | LV3 = 5 | ||
| | | LV4 = 6 | ||
| | | LV5 = 7 | ||
| LV6 = 8 | |||
| OS1 = w | | OS1 = w | ||
| OS2 = m | | OS2 = m | ||
| Line 48: | Line 57: | ||
</pre> | </pre> | ||
|} | |} | ||
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: | |||
{{ 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 | |||
<center> | |||
{| class="wikitable" | |||
|- | |||
! 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=[[Image:logo.Windows.png]], l=[[Image:logo.Linux.png]], m=[[Image:logo.Mac.png]], u=[[Image:logo.Sun.png]] | |||
|} | |||
</center> | |||
<includeonly> | |||
[[Category:Templates]] | |||
</includeonly> | |||
Latest revision as of 16:10, 2 August 2024
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=
|