Roll20 Wiki

{{documentation subpage|override=script overview/doc|Script overview}}
Creates a metadata box for displaying on an [[API]] script page, along with giving the page [[:Category:User API Scripts]].

== Parameters ==

{| class="wikitable"
|-
! Name
! Description
|-
|| name
|| The name to use when categorizing this script page in [[:Category:User API Scripts|User API Scripts]].
|-
|| author
|| The user ID of the script author. This template will then link to that user's wiki userpage. Please use {{tlx|User profile}} or wiki link for each author of the script.
|-
|| code
|| Name of the directory and JavaScript file in the {{api-gh| API Script Repository}}. If this parameter is not supplied, it will default to the value of <code>name</code>.
|-
|| lastmodified
|| The date that the script was most recently updated. Should be in the form <code>yyyy-mm-dd</code>
|-
|| version
|| The current version of the script. A version number in the form <code>major.minor</code> is recommended.
|-
|| dependencies
|| Links to scripts in to API Script Repository which are required for this script to function. Please use {{tlx|api-gh}}, {{tlx|Api repository link}} for each dependency.
|-
|| conflicts
|| Links to scripts in the API Script Repository which cause problems when run alongside this script. Please use {{tlx|api-gh}}, or {{tlx|Api repository link}} for each conflict.
|-
|| 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>.) If two unnamed parameters are given, the second will be used as the default value for <code>name</code>

== Usage ==

{| class="wikitable"
|-
! Wikitext
! Output
|-
| <pre>{{script overview
|name=Auto Initiative
|author={{user profile|84478|Josh}}
|lastmodified=2013-12-30
|version=2.2}}</pre>
| {{script overview|name=Auto Initiative|author={{user profile|84478|Josh}}|lastmodified=2013-12-30|version=2.2|nocat=true}}
|-
| <pre>{{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 repository link|Extensions}}
|conflicts={{api repository link|Kitchen Sink}}
|version=0.0}}</pre>
| {{script overview|name=Example Script|code=Example API Script|dependencies={{api repository link|Utilities Example}}, {{api repository link|Extensions}}|author={{user profile|0001|John Doe}}, {{user profile|0002|Jane Doe}}|lastmodified=0001-01-01|conflicts={{api repository link|Kitchen Sink}}|version=0.0|nocat=true}}
|}
This page would also be categorized with <code><nowiki>[[Category:User API Scripts|Auto Initiative]]</nowiki></code> and <code><nowiki>[[Category:UserAPI Scripts|Example Script]]</nowiki></code>, although the <code>nocat</code> parameter is being invoked on this demonstration.
<includeonly>[[Category:API Templates]]</includeonly>