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

Personal tools

Difference between revisions of "Template:Script overview/doc"

From Roll20 Wiki

Jump to: navigation, search
m (Usage)
Line 9: Line 9:
 
|-
 
|-
 
|| name
 
|| name
|| The name to use when categorizing this script page in [[:Category:User API Scripts|User API Scripts]]
+
|| The name to use when categorizing this script page in [[:Category:User API Scripts|User API Scripts]].
 
|-
 
|-
 
|| author
 
|| author
Line 19: 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.
 +
|-
 +
|| code
 +
|| Name of the directory and JavaScript file in the [https://github.com/Roll20/roll20-api-scripts API Script Repository]. If this parameter is not supplied, it will default to the value of <code>name</code>.
 +
|-
 +
|| 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
 
|| nocat

Revision as of 20:36, 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: {{{2}}}
Dependencies: None
Conflicts: None
{{script overview
|name=Example Script
|author={{user profile|0001|John Doe}}, {{user profile|0002|Jane Doe}}
|lastmodified=0001-01-01
|version=0.0}}
API ScriptAuthor: John Doe, Jane Doe
Version: 0.0
Last Modified: 0001-01-01
Code: {{{2}}}
Dependencies: None
Conflicts: None

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