RV – Template
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Add subst:Preload/Note encoded URI link - no more Template:Add_new_note usage) |
Lou Montana (talk | contribs) m (Add Example colons and ids) |
||
| Line 144: | Line 144: | ||
{{#if:{{{x1|}}}{{{x2|}}}{{{x3|}}}{{{x4|}}}{{{x5|}}}{{{x6|}}}{{{x7|}}}{{{x8|}}}{{{x9|}}}{{{x10|}}} | {{#if:{{{x1|}}}{{{x2|}}}{{{x3|}}}{{{x4|}}}{{{x5|}}}{{{x6|}}}{{{x7|}}}{{{x8|}}}{{{x9|}}}{{{x10|}}} | ||
| | | | ||
{{#if: {{{x1|}}}|<dt>Example 1</dt><dd>{{{x1}}}</dd>}}<!-- | {{#if: {{{x1|}}}|<dt id="Example 1">Example 1:</dt><dd>{{{x1}}}</dd>}}<!-- | ||
-->{{#if: {{{x2|}}}|<dt>Example 2</dt><dd>{{{x2}}}</dd>}}<!-- | -->{{#if: {{{x2|}}}|<dt id="Example 2">Example 2:</dt><dd>{{{x2}}}</dd>}}<!-- | ||
-->{{#if: {{{x3|}}}|<dt>Example 3</dt><dd>{{{x3}}}</dd>}}<!-- | -->{{#if: {{{x3|}}}|<dt id="Example 3">Example 3:</dt><dd>{{{x3}}}</dd>}}<!-- | ||
-->{{#if: {{{x4|}}}|<dt>Example 4</dt><dd>{{{x4}}}</dd>}}<!-- | -->{{#if: {{{x4|}}}|<dt id="Example 4">Example 4:</dt><dd>{{{x4}}}</dd>}}<!-- | ||
-->{{#if: {{{x5|}}}|<dt>Example 5</dt><dd>{{{x5}}}</dd>}}<!-- | -->{{#if: {{{x5|}}}|<dt id="Example 5">Example 5:</dt><dd>{{{x5}}}</dd>}}<!-- | ||
-->{{#if: {{{x6|}}}|<dt>Example 6</dt><dd>{{{x6}}}</dd>}}<!-- | -->{{#if: {{{x6|}}}|<dt id="Example 6">Example 6:</dt><dd>{{{x6}}}</dd>}}<!-- | ||
-->{{#if: {{{x7|}}}|<dt>Example 7</dt><dd>{{{x7}}}</dd>}}<!-- | -->{{#if: {{{x7|}}}|<dt id="Example 7">Example 7:</dt><dd>{{{x7}}}</dd>}}<!-- | ||
-->{{#if: {{{x8|}}}|<dt>Example 8</dt><dd>{{{x8}}}</dd>}}<!-- | -->{{#if: {{{x8|}}}|<dt id="Example 8">Example 8:</dt><dd>{{{x8}}}</dd>}}<!-- | ||
-->{{#if: {{{x9|}}}|<dt>Example 9</dt><dd>{{{x9}}}</dd>}}<!-- | -->{{#if: {{{x9|}}}|<dt id="Example 9">Example 9:</dt><dd>{{{x9}}}</dd>}}<!-- | ||
-->{{#if:{{{x10|}}}|<dt>Example 10</dt><dd>{{{x10}}}</dd>}} | -->{{#if:{{{x10|}}}|<dt id="Example 10">Example 10:</dt><dd>{{{x10}}}</dd>}} | ||
| <dt>Examples:</dt><dd>{{Example needed}}</dd> | | <dt>Examples:</dt><dd>{{Example needed}}</dd> | ||
}} | }} | ||
Revision as of 03:28, 16 January 2021
Commands/Functions documentation template.
Usage
{{RV|type=|other parameters, see below}}
- meta information:
- type: (named argument, case-insensitive) "command" or "function"
- displayTitle: (Optional, default {{PAGENAMEE}} (encoded page name, i.e with underscores)) use to force page's displayTitle (e.g diag_log (Arma 2))
- sortKey: (Optional, default commandName or functionName without BIS/BIN_fnc_ prefix) use to force category's sort key
- primary parameters:
- game1: (can be unnamed parameter 1) short game name - same as Name template input format. e.g ofp, tkoh, arma3, etc.
- version1: (Optional, default empty (unknown)) (can be version or unnamed parameter 2) number in Template:GVI template format: <Major>.<Minor>. e.g 1.46, 1.75, 1.86 etc.
- arg: (Optional, default empty) argument locality definition - same as EffArg template input format. e.g local, loc or global, glob
- eff: (Optional, default empty) effects locality definition - same as EffArg template input format. e.g local, loc or global, glob
- serverExec: (Optional, default empty) if provided, will display the Template:ServerExec icon informing the command must be run on the server
- descr: (can be unnamed parameter 3) the command description
- gr1..gr5: (Optional, default empty) Command groups. Case sensitive.
- s1: (Optional, default {{PAGENAMEE}}; can be unnamed parameter 4) command syntax with named parameters. e.g
unit1 setDammage 1 - p1..20: (Optional, default empty) command parameters with description
- r1: (Optional, default Nothing) (can be unnamed parameter 5) syntax's return value
- x1..10: (Optional, default {{Example needed}}) command examples (to be put between <code></code> tags where needed)
- seealso: (Optional, default See also needed) (can be unnamed param 6) list of related links in wiki format, separated by comma or space. e.g [[setDir]] [[setPos]]
- secondary parameters:
- mp: (Optional, default empty) if provided, will show a Multiplayer note under the description
- pr: (Optional, default empty) if provided, will show a Problems note under the description
- game2..5: (Optional, default empty) same as game1
- version2..5: (Optional, default empty) same as version1, for the corresponding game#
- s2..6: (Optional, default empty) Alternative syntaxes 1 to 5 (see s1)
- p21..120: (Optional, default empty) Alternative syntaxes parameters (20 each: p21..40, p41..60, p61..80, p81..100, p101..120)
- r2..r6: (Optional, default empty) Alternative syntaxes' return value (see r1)
Automatic categories
| Command | Function |
|---|---|
|
|
Examples
| Code | Result |
|---|---|
| {{RV}} | -no type provided- |
| {{RV|type=abc}} | -wrong type provided- |
| {{RV|type=command}} | Hover & click on the images for descriptions
Description
Syntax
ExamplesAdditional InformationNotes |
| {{RV|type=function}} | Hover & click on the images for descriptions
Description
Syntax
ExamplesAdditional InformationNotes |
Template
{{RV|type=Command
|game1=
|game2=
|game3=
|game4=
|game5=
|version1=
|version2=
|version3=
|version4=
|version5=
|arg=
|eff=
|serverExec=
|gr1=
|gr2=
|gr3=
|gr4=
|gr5=
|descr=
|mp=
|pr=
|s1=
|p1=
|p2=
|p3=
|p4=
|p5=
|p6=
|p7=
|p8=
|p9=
|p10=
|p11=
|p12=
|p13=
|p14=
|p15=
|p16=
|p17=
|p18=
|p19=
|p20=
|r1=
|x1=
|seealso=
}}