Template:Infobox Wikipedia user script/doc: Difference between revisions

From The Global Wiki
Jump to navigation Jump to search
en>Rublov
 
m (1 revision imported)
 
(No difference)

Latest revision as of 01:15, 18 January 2023

Usage

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

Script error: No such module "Parameter names example".

Full syntax

{{infobox Wikipedia user script
|styled             = 
|bodystyle          = 
|install-target     = 
|name               = 
|logo               = 
|logosize           = 
|logoupright        = 
|logoalt            = 
|logo-caption       = 
|screenshot         = 
|screenshotsize     = 
|screenshotupright  = 
|screenshotalt      = 
|screenshot-caption = 
|desc               = 
|author             = 
|maintainer         = 
|status             = 
|released           = 
|version            = 
|updated            = 
|browsers           = 
|skins              = 
|source             = <!-- or " |mainsource = " or " |beta = " -->
|gitHub             = <!-- or " |Github = " -->
|categorize         = <!-- or " |cat = " -->
}}

Example

MyScript
File:Wikimedia-logo.svg
File:Floater script screenshot.png
MyScript in action
DescriptionDoes something useful
Author(s)Username
StatusStable
First releasedJuly 7, 2008; Script error: No such module "Time ago". (2008-07-07)
Version2.1.0
UpdatedMarch 3, 2013; Script error: No such module "Time 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
Author(s)Username
StatusStable
First releasedJuly 7, 2008; Script error: No such module "Time ago". (2008-07-07)
Version2.1.0
UpdatedMarch 3, 2013; Script error: No such module "Time 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
}}

Parameters

  • 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.
  • released: 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 web browser(s).
  • github: The script's repository on GitHub, as input to the {{github}} template.
  • logo: Image file address for logo
  • logoupright: See Module:InfoboxImage: upright=yes displays image at 75% of default size, upright=value with values under 1 scaling the image down (0.9 = 90%) and values greater than 1 scaling the image up (1.15 = 115%).
  • logosize: Logo size in pixels. Use of logoupright is recommended as pixels can vary in size depending on display used.
  • screenshot: Image file address for screenshot
  • screenshotupright: See logoupright.
  • screenshotsize: See logosize.
  • screenshot-caption: Text caption for screenshot
  • styled: Set to yes for an alternate colored version (see example above)
  • categorize: Set to no to prevent categorizing the page into Category:Wikipedia scripts

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.

Templatedata

No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
styledstyled

no description

Unknownoptional
bodystylebodystyle

no description

Unknownoptional
mainsourcemainsource

no description

Unknownoptional
install-targetinstall-target

no description

Unknownoptional
namename

no description

Unknownoptional
logologo

no description

Unknownoptional
logosizelogosize

no description

Unknownoptional
logoaltlogoalt

no description

Unknownoptional
logo-captionlogo-caption

no description

Unknownoptional
screenshotscreenshot

no description

Unknownoptional
screenshotsizescreenshotsize

no description

Unknownoptional
screenshotaltscreenshotalt

no description

Unknownoptional
screenshot-captionscreenshot-caption

no description

Unknownoptional
descdesc

no description

Unknownoptional
authorauthor

no description

Unknownoptional
maintainermaintainer

no description

Unknownoptional
statusstatus

no description

Unknownoptional
releasedreleased

no description

Unknownoptional
versionversion

no description

Unknownoptional
updatedupdated

no description

Unknownoptional
browsersbrowsers

no description

Unknownoptional
skinsskins

no description

Unknownoptional
betabeta

no description

Unknownoptional
sourcesource

no description

Unknownoptional
githubgithub

no description

Unknownoptional


{{Wikipedia:User scripts/Navbox}}