Character Vault
Any Concept / Any System
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Template:Script overview

From Roll20 Wiki

Jump to: navigation, search
[view] [edit] [history] [purge] Documentation icon Template documentation

Creates a metadata box for displaying on an API script page, along with giving the page Category:User API Scripts.


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. Please use {{ profile}} or wiki link for each author of the script.
code Name of the directory and JavaScript file in the GitHubLogo.png. If this parameter is not supplied, it will default to the value of name.
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.
dependencies Links to scripts in to API Script Repository which are required for this script to function. Please use {{api-gh}}, {{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 {{api-gh}}, or {{Api repository link}} for each conflict.
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


Wikitext Output
{{script overview
|name=Auto Initiative
|author={{user profile|84478|Josh}}
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}}
|code=Example API Script
|dependencies={{api repository link|Utilities Example}}, {{api repository link|Extensions}}
|conflicts={{api repository link|Kitchen Sink}}
API ScriptAuthor: John Doe, Jane Doe
Version: 0.0
Last Modified: 0001-01-01
Code: Example API Script
Dependencies: Utilities Example, Extensions
Conflicts: Kitchen Sink

This page would also be categorized with [[Category:User API Scripts|Auto Initiative]] and [[Category:UserAPI Scripts|Example Script]], although the nocat parameter is being invoked on this demonstration.