Difference between revisions of "Template:Script overview/doc"
From Roll20 Wiki
(→Usage) |
(→Usage) |
||
| Line 55: | Line 55: | ||
|code=Example API Script | |code=Example API Script | ||
|dependencies={{api repository link|Utilities Example|API Utilities|js}}, {{api repository link|Extensions|Extensions|js}} | |dependencies={{api repository link|Utilities Example|API Utilities|js}}, {{api repository link|Extensions|Extensions|js}} | ||
| + | |conflicts={{api repository link|Kitchen Sink|Kitchen Sink|js}} | ||
|version=0.0}}</pre> | |version=0.0}}</pre> | ||
| − | | {{script overview|name=Example Script|code=Example API Script|dependencies={{api repository link|Utilities Example|API Utilities|js}}, {{api repository link|Extensions|Extensions|js}}|author={{user profile|0001|John Doe}}, {{user profile|0002|Jane Doe}}|lastmodified=0001-01-01|version=0.0|nocat=true}} | + | | {{script overview|name=Example Script|code=Example API Script|dependencies={{api repository link|Utilities Example|API Utilities|js}}, {{api repository link|Extensions|Extensions|js}}|author={{user profile|0001|John Doe}}, {{user profile|0002|Jane Doe}}|lastmodified=0001-01-01|conflicts={{api repository link|Kitchen Sink|Kitchen Sink|js}}|version=0.0|nocat=true}} |
|} | |} | ||
This page would also be categorized with <code><nowiki>[[Category:User API Scripts|Auto Initiative]]</nowiki></code>, although the <code>nocat</code> parameter is being invoked on this demonstration. | This page would also be categorized with <code><nowiki>[[Category:User API Scripts|Auto Initiative]]</nowiki></code>, although the <code>nocat</code> parameter is being invoked on this demonstration. | ||
<noinclude>[[Category:Template Documentation]]</noinclude> | <noinclude>[[Category:Template Documentation]]</noinclude> | ||
<includeonly>[[Category:API Templates]]</includeonly> | <includeonly>[[Category:API Templates]]</includeonly> | ||
Revision as of 21:12, 7 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.
|
| code | Name of the directory and JavaScript file in the API Script Repository. If this parameter is not supplied, it will default to the value of name.
|
| dependencies | Links to scripts in to API Script Repository which are required for this script to function. |
| conflicts | Links to scripts in the API Script Repository which cause problems when run alongside this script. |
| 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
|name=Auto Initiative
|author={{user profile|84478|Josh}}
|lastmodified=2013-12-30
|version=2.2}}
|
API ScriptAuthor: Josh
Version: 2.2 Last Modified: 2013-12-30 Code: Auto Initiative Dependencies: None Conflicts: None |
{{script overview
|name=Example Script
|author={{user profile|0001|John Doe}}, {{user profile|0002|Jane Doe}}
|lastmodified=0001-01-01
|code=Example API Script
|dependencies={{api repository link|Utilities Example|API Utilities|js}}, {{api repository link|Extensions|Extensions|js}}
|conflicts={{api repository link|Kitchen Sink|Kitchen Sink|js}}
|version=0.0}}
|
API ScriptAuthor: John Doe, Jane Doe
Version: 0.0 Last Modified: 0001-01-01 Code: Example API Script Dependencies: API Utilities, Extensions Conflicts: Kitchen Sink |
This page would also be categorized with [[Category:User API Scripts|Auto Initiative]], although the nocat parameter is being invoked on this demonstration.
