Template:Infobox Wikipedia user script/doc
Appearance
This is a documentation subpage for Template:Infobox Wikipedia user script. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Usage
[edit]This infobox is intended to be used on user script description/documentation pages.
[[File:{{{logo}}}|{{{logosize}}}|alt={{{logoalt}}}|upright={{{logoupright}}}]] | |
[[File:{{{screenshot}}}|{{{screenshotsize}}}|alt={{{screenshotalt}}}|upright={{{screenshotupright}}}]] | |
Description | {{{desc}}} |
---|---|
Author(s) | {{{author}}} |
Maintainer(s) | {{{maintainer}}} |
Status | {{{status}}} |
First released | {{{released}}} |
Version | {{{version}}} |
Updated | {{{updated}}} |
Browsers | {{{browsers}}} |
Skins | {{{skins}}} |
Source | {{{source}}} |
GitHub repository | {{{github}}} |
Full syntax
[edit]{{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 =
|categorize = <!-- or " |cat = " -->
}}
Example
[edit]Description | Does something useful |
---|---|
Author(s) | Username |
Status | Stable |
First released | July 7, 2008 |
Version | 2.1.0 |
Updated | March 3, 2013 |
Browsers | Firefox, Chrome |
Skins | 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(s) | Username |
Status | Stable |
First released | July 7, 2008 |
Version | 2.1.0 |
Updated | March 3, 2013 |
Browsers | Firefox, Chrome |
Skins | 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
}}
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.
- 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
[edit]No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
styled | styled | no description | Unknown | optional |
bodystyle | bodystyle | no description | Unknown | optional |
mainsource | mainsource | no description | Unknown | optional |
install-target | install-target | no description | Unknown | optional |
name | name | no description | Unknown | optional |
logo | logo | no description | Unknown | optional |
logosize | logosize | no description | Unknown | optional |
logoalt | logoalt | no description | Unknown | optional |
logo-caption | logo-caption | no description | Unknown | optional |
screenshot | screenshot | no description | Unknown | optional |
screenshotsize | screenshotsize | no description | Unknown | optional |
screenshotalt | screenshotalt | no description | Unknown | optional |
screenshot-caption | screenshot-caption | no description | Unknown | optional |
desc | desc | no description | Unknown | optional |
author | author | no description | Unknown | optional |
maintainer | maintainer | no description | Unknown | optional |
status | status | no description | Unknown | optional |
released | released | no description | Unknown | optional |
version | version | no description | Unknown | optional |
updated | updated | no description | Unknown | optional |
browsers | browsers | no description | Unknown | optional |
skins | skins | no description | Unknown | optional |
beta | beta | no description | Unknown | optional |
source | source | no description | Unknown | optional |
github | github | no description | Unknown | optional |