Difference between revisions of "Template:Script overview/doc"
From Roll20 Wiki
m |
|||
| Line 7: | Line 7: | ||
! Name | ! Name | ||
! Description | ! Description | ||
| + | |- | ||
| + | || name | ||
| + | || The name to use when categorizing this script page in [[:Category:User API Scripts|User API Scripts]] | ||
|- | |- | ||
|| author | || author | ||
| Line 16: | Line 19: | ||
|| version | || version | ||
|| The current version of the script. A version number in the form <code>major.minor</code> is recommended. | || The current version of the script. A version number in the form <code>major.minor</code> is recommended. | ||
| + | |- | ||
| + | || nocat | ||
| + | || If given and set to any value except <code>false</code>, the page will ''not'' be automatically categorized. The <code>name</code> parameter and the second unnamed parameter then become superfluous. | ||
|} | |} | ||
| − | Additionally, if an unnamed parameter is given, it will be used to set the float direction of the box. (Default is <code>right</code>.) | + | Additionally, if an unnamed parameter is given, it will be used to set the float direction of the box. (Default is <code>right</code>.) If two unnamed parameters are given, the second will be used as the default value for <code>name</code> |
== Usage == | == Usage == | ||
Revision as of 00:11, 3 January 2015
Creates a metadata box for displaying on a script page
Parameters
| Name | Description |
|---|---|
| name | The name to use when categorizing this script page in API Scripts |
| author | The user ID of the script author. This template will then link to that user's wiki userpage. |
| lastmodified | The date that the script was most recently updated. Should be in the form yyyy-mm-dd
|
| version | The current version of the script. A version number in the form major.minor is recommended.
|
| nocat | If given and set to any value except false, the page will not be automatically categorized. The name parameter and the second unnamed parameter then become superfluous.
|
Additionally, if an unnamed parameter is given, it will be used to set the float direction of the box. (Default is right.) If two unnamed parameters are given, the second will be used as the default value for name
Usage
| Wikitext | Output |
|---|---|
{{script overview
|author=84478
|lastmodified=2013-12-30
|version=2.2}}
|
API ScriptAuthor: 84478
Version: 2.2 Last Modified: 2013-12-30 Code: {{{2}}} Dependencies: None Conflicts: None |
