Template:Script: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
template for writing script usage inscructions
 
imported>AntumDeluge
Use dark blue for script invocation line
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
Template for creating usage info for invoking a script.
Template for creating usage info for invoking a script.


</noinclude>; /script {{{1|}}}.class {{#if: {{{params|}}} | ''{{{params|}}}'' }} {{#if: {{{desc|}}} |
</noinclude>; <span style="color:darkblue;">/script {{{1|}}}.class {{#if: {{{params|}}} | ''{{{params|}}}'' }}</span> {{#if: {{{desc|}}} |
: Description:
: Description:
:: {{{desc|}}} }} {{#if: {{{params|}}} |
:: {{{desc|}}} }} {{#if: {{{params|}}} |
Line 13: Line 13:
{| class="wikitable"
{| class="wikitable"
|-
|-
| Input || <nowiki>{{Script|ExampleScript|desc=A script example.|params=param1 <param2> [<param3>] [...]|
| Input || <nowiki>{{</nowiki>{{PAGENAME}}<nowiki>|ExampleScript|desc=A script example.|params=param1 <param2> [<param3>] [...]|</nowiki>
:: '''param1:''' Required verbatim parameter example.
<nowiki>:: '''param1:''' Required verbatim parameter example.</nowiki>
:: '''param2:''' Required parameter example.
<br><nowiki>:: '''param2:''' Required parameter example.</nowiki>
:: '''param3:''' Optional parameter example.}}</nowiki>
<br><nowiki>:: '''param3:''' ''(optional)'' Optional parameter example.}}</nowiki>
|-
|-
| Output || {{Script|ExampleScript|desc=A script example.|params=param1 <param2> [<param3>] [...]|
| Output || {{{{PAGENAME}}|ExampleScript|desc=A script example.|params=param1 <param2> [<param3>] [...]|
:: '''param1:''' Required verbatim parameter example.
:: '''param1:''' Required verbatim parameter example.
:: '''param2:''' Required parameter example.
:: '''param2:''' Required parameter example.
:: '''param3:''' Optional parameter example.}}
:: '''param3:''' ''(optional)'' Optional parameter example.}}
|}
|}