Template:Script: Difference between revisions

From Arianne
Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
template for writing script usage inscructions
 
imported>AntumDeluge
mNo edit summary
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.}}
|}
|}



Revision as of 22:41, 16 January 2022

Description

Template for creating usage info for invoking a script.

/script .class

Examples

Input {{Script|ExampleScript|desc=A script example.|params=param1 <param2> [<param3>] [...]|

:: '''param1:''' Required verbatim parameter example.
:: '''param2:''' Required parameter example.
:: '''param3:''' ''(optional)'' Optional parameter example.}}

Output
/script ExampleScript.class param1 <param2> [<param3>] [...]
Description:
A script example.
Parameters:
param1: Required verbatim parameter example.
param2: Required parameter example.
param3: (optional) Optional parameter example.

TODO

Parse individual parameters instead of requiring manual formatting.