Template:Script: Difference between revisions

From Arianne
Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
mNo edit summary
imported>AntumDeluge
Use dark blue for script invocation line
 
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|}}} |

Latest revision as of 22:58, 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.