Jump to content

Template:Infobox Wikipedia user script/doc

From Meta, a Wikimedia project coordination wiki

Example

[edit]
MyScript
MyScript in action
DescriptionDoes something useful
AuthorUsername
StatusStable
First releasedJuly 7, 2008; 16 years ago (2008-07-07)
Version2.1.0
UpdatedMarch 3, 2013; 11 years ago (2013-03-03)
Browser supportFirefox, Chrome
Skin supportVector
SourceUser: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):
User script
MyScript
DescriptionDoes something useful
AuthorUsername
StatusStable
First releasedJuly 7, 2008; 16 years ago (2008-07-07)
Version2.1.0
UpdatedMarch 3, 2013; 11 years ago (2013-03-03)
Browser supportFirefox, Chrome
Skin supportVector
SourceUser: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 skins.
  • browsers: Supported en:web browser(s).
  • github: The script's repository on en:GitHub.
  • 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.