Template:Infobox user script/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Example[edit]

MyScript
Wikimedia-logo.svg
Floater script screenshot.png
MyScript in action
Description Does something useful
Author Username
Status Stable
First released Template:Start date and age
Version 2.1.0
Updated Template:Start date and age
Browser support Firefox, Chrome
Skin support Vector
Source User:Username/Example.js
{{infobox user script
 | name = MyScript
 | desc = Does something useful
 | author = [[User:Username|Username]]
 | updated = {{start date and age|2013|03|03}}
 | status = Stable
 | released = {{start date and age|2008|07|07}}
 | version = 2.1.0
 | source = [[User:Username/Example.js]]
 | skins = Vector
 | browsers = [[Firefox]], [[Google Chrome|Chrome]]
 | logo = [[File:Wikimedia-logo.svg|50px]]
 | screenshot = [[File:Floater script screenshot.png|300px]]
 | screenshot-caption = MyScript in action
}}
  • Add |styled = yes for an alternate colored version (see second example):
MyScript
Description Does something useful
Author Username
Status Stable
First released July 07, 2007
Version 2.1.0
Updated March 03, 2013
Browser support Firefox, Chrome
Skin support Vector
Source User:Username/Example.js
{{infobox user script
 | name = MyScript
 | desc = Does something useful
 | author = [[User:Username|Username]]
 | updated = {{start date and age|2013|03|03}}
 | released = {{start date and age|2008|07|07}}
 | status = Stable
 | version = 2.1.0
 | source = [[User:Username/Example.js]]
 | skins = Vector
 | browsers = [[Firefox]], [[Google Chrome|Chrome]]
 | styled = yes
}}

Usage[edit]

This infobox is intended to be used on user script description/documentation pages.

Parameters[edit]

  • name: The name of the script. Defaults to page name.
  • desc: A short description of what the script does.
  • author: The script author's user name.
  • release: When the script was first released.
  • updated: The date of last update. Use {{Start date and age}} to automatically display time since the last update.
  • status: Script's development status. You may describe this any way you like, such as alpha/beta/release, or stable/experimental/inactive.
  • source: The source code page.
  • skins: Supported.
  • browsers: Supported(s).
  • github: The script's repository on.
  • logo: Image file address for logo
  • screenshot: Image file address for screenshot
  • screenshot-caption: Text caption for screenshot
  • styled: Set to yes for an alternate colored version (see example above)

The following parameters can aid in automatic installation:

  • mainsource: The main source file, which is to be loaded from the user's custom script.
  • install-target: The preferred page on which the script should be included. The default is common.js.