Template:Labviewconfigurationkey: Difference between revisions

Latest revision as of 16:07, 2 August 2024

[view] [edit] Template documentation

This documentation is transcluded from Template:Labviewconfigurationkey/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.

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=

@@ Line 1: / Line 1: @@
-Example: {{{example}}}<br />
+<includeonly>== {{{keyname}}} ==
-Description: {{{description}}}<br />
+{| class="wikitable"
-Datatype: {{
+! scope="row" style="text-align: right;" | Example
-#switch: {{{datatype}}}
+| <code>{{ #if:{{{example|{{{example|}}} }}} | {{{example}}} }}</code>
- | b = Boolean
+|-
- | i = Integer
+! scope="row" style="text-align: right;" | Description
- | s = String}}
+| {{ #if:{{{description|{{{description|}}} }}} | {{{description}}} }}
-<br />
+|-
-Permitted Values: {{{permitted values}}}<br />
+! scope="row" style="text-align: right;" | Datatype
-Default Value: {{{default}}}<br />
+| {{ #if:{{{datatype|{{{datatype|}}} }}} | {{ #switch: {{{datatype}}} | b = [[Boolean]] | i = [[Integer]] | s = [[String]] | p = [[Path]] | h = [[Integer HEX]] | f = [[Float]] | #default = {{{datatype}}} }} }}
-LabVIEW Versions: {{{LV}}}<br />
+|-
-OS's Supported: {{{OS}}}<br />
+! scope="row" style="text-align: right;" | Permitted Values
-Notes: {{{notes}}}<br />
+| {{ #if:{{{permitted_values|{{{permitted_values|}}} }}} | {{{permitted_values}}} }}
+|-
-<noinclude>
+! scope="row" style="text-align: right;" | Default Value
-== Usage Example ==
+| {{ #if:{{{default|{{{default|}}} }}} | {{{default}}} }}
+|-
-<pre><nowiki>
+! scope="row" style="text-align: right;" | LabVIEW Versions
-{{inikey
+|
-|example=
+{{ #if:{{{LV1|{{{LV1|}}} }}} |  {{ #switch: {{{LV1}}} | 3 = 3.x | 4 = 4.x | 5 = 5.x | 6 = 6.x | 7 = 7.x | 8 = 8.x | #default = {{{LV1}}} }} | [[Image:spacer.png]]}}
-|description=
+{{ #if:{{{LV2|{{{LV2|}}} }}} |, {{ #switch: {{{LV2}}} | 3 = 3.x | 4 = 4.x | 5 = 5.x | 6 = 6.x | 7 = 7.x | 8 = 8.x | #default = {{{LV2}}} }} | [[Image:spacer.png]]}}
-|datatype=
+{{ #if:{{{LV3|{{{LV3|}}} }}} |, {{ #switch: {{{LV3}}} | 3 = 3.x | 4 = 4.x | 5 = 5.x | 6 = 6.x | 7 = 7.x | 8 = 8.x | #default = {{{LV3}}} }} | [[Image:spacer.png]]}}
-|permitted values=
+{{ #if:{{{LV4|{{{LV4|}}} }}} |, {{ #switch: {{{LV4}}} | 3 = 3.x | 4 = 4.x | 5 = 5.x | 6 = 6.x | 7 = 7.x | 8 = 8.x | #default = {{{LV4}}} }} | [[Image:spacer.png]]}}
-|default=
+{{ #if:{{{LV5|{{{LV5|}}} }}} |, {{ #switch: {{{LV5}}} | 3 = 3.x | 4 = 4.x | 5 = 5.x | 6 = 6.x | 7 = 7.x | 8 = 8.x | #default = {{{LV5}}} }} | [[Image:spacer.png]]}}
-|LV=
+{{ #if:{{{LV6|{{{LV6|}}} }}} |, {{ #switch: {{{LV6}}} | 3 = 3.x | 4 = 4.x | 5 = 5.x | 6 = 6.x | 7 = 7.x | 8 = 8.x | #default = {{{LV6}}} }} | [[Image:spacer.png]]}}
-|OS=
+|-
-|notes=
+! scope="row" style="text-align: right;" | OS's Supported
-}}
+|
-</nowiki></pre>
+{{ #if:{{{OS1|{{{OS1|}}} }}} | {{ #switch: {{{OS1}}} | m = [[Image:logo.Mac.png]] | w = [[Image:logo.Windows.png]] | l = [[Image:logo.Linux.png]] | u = [[Image:logo.Sun.png]] | #default = [[Image:spacer.png]] }} | [[Image:spacer.png]]}}
+{{ #if:{{{OS2|{{{OS2|}}} }}} | {{ #switch: {{{OS2}}} | m = [[Image:logo.Mac.png]] | w = [[Image:logo.Windows.png]] | l = [[Image:logo.Linux.png]] | u = [[Image:logo.Sun.png]] | #default = [[Image:spacer.png]] }} | [[Image:spacer.png]]}}
+{{ #if:{{{OS3|{{{OS3|}}} }}} | {{ #switch: {{{OS3}}} | m = [[Image:logo.Mac.png]] | w = [[Image:logo.Windows.png]] | l = [[Image:logo.Linux.png]] | u = [[Image:logo.Sun.png]] | #default = [[Image:spacer.png]] }} | [[Image:spacer.png]]}}
-Image:logo.Windows.pngImage:logo.Mac.pngImage:logo.Linux.pngImage:logo.Sun.png</noinclude>
+{{ #if:{{{OS4|{{{OS4|}}} }}} | {{ #switch: {{{OS4}}} | m = [[Image:logo.Mac.png]] | w = [[Image:logo.Windows.png]] | l = [[Image:logo.Linux.png]] | u = [[Image:logo.Sun.png]] | #default = [[Image:spacer.png]] }} | [[Image:spacer.png]]}}
-<noinclude>[[Category:Template]]</noinclude>
+|-
+! scope="row" style="text-align: right;" | Notes
+| {{ #if:{{{notes|{{{notes|}}} }}} | {{{notes}}} }}__NOEDITSECTION__
+|}</includeonly><noinclude>{{documentation}}</noinclude>