Template:Script

From Arianne
Revision as of 22:36, 16 January 2022 by imported>AntumDeluge (template for writing script usage inscructions)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 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 parameter example.

TODO

Parse individual parameters instead of requiring manual formatting.