Template:Infobox Wikipedia user script/sandbox Source: en.wikipedia.org/wiki/Template:Infobox_Wikipedia_user_script/sandbox
 | This is the template sandbox page for Template:Infobox Wikipedia user script (diff). |
 | This template uses Lua: |
Usage
[edit]This infobox is intended to be used on user script description/documentation pages.
| [[File:{{{logo}}}|{{{logosize}}}|alt={{{logoalt}}}]] | |
| [[File:{{{screenshot}}}|{{{screenshotsize}}}|alt={{{screenshotalt}}}]] {{{screenshot-caption}}} | |
| Description | {{{desc}}} |
|---|---|
| Author(s) | {{{author}}} |
| Maintainer(s) | {{{maintainer}}} |
| Status | {{{status}}} |
| First released | {{{released}}} |
| Version | {{{version}}} |
| Updated | {{{updated}}} |
| Browser support | {{{browsers}}} |
| Skin support | {{{skins}}} |
| Source | {{{source}}} |
| GitHub repository | {{{github}}} on 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] | |
 MyScript in action | |
| 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 = yesfor 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
yesfor an alternate colored version (see example above) - categorize: Set to
noto 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]This infobox is intended to be used on user script description/documentation pages.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | The name of the script. Defaults to page name. | String | optional |
| Logo | logo | Image file address for logo | File | optional |
| Logo Upright | 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%). | Number | optional |
| Logo Size | logosize | Logo size in pixels. Use of logoupright is recommended as pixels can vary in size depending on display used. | String | optional |
| logoalt | logoalt | no description | String | optional |
| logo-caption | logo-caption | no description | Unknown | optional |
| Screenshot | screenshot | Image file address for screenshot | File | optional |
| screenshotsize | screenshotsize | no description | String | optional |
| screenshotalt | screenshotalt | no description | String | optional |
| Screenshot Caption | screenshot-caption | Text caption for screenshot | String | optional |
| screenshotupright | screenshotupright | no description | Number | optional |
| Description | desc | A short description of what the script does. | String | optional |
| Author | author | The script author's user name. | User | optional |
| Maintainer(s) | maintainer | no description | String | optional |
| Status | status | Script's development status. You may describe this any way you like, such as alpha/beta/release, or stable/experimental/inactive. | String | optional |
| Released | released | When the script was first released. | Date | optional |
| Version | version | The version of the script. | String | optional |
| Updated | updated | The date of last update. Use {{start date and age}} to automatically display time since the last update. | String | optional |
| Browsers | browsers | Supported web browser(s). | Unknown | optional |
| Skins | skins | Supported skins. | String | optional |
| Beta? | beta | Marks the source as being in beta. Set to any value to enable.
| String | optional |
| Source | source | The source code page. | Page name | optional |
| bodystyle | bodystyle | no description | Unknown | optional |
| GitHub repository | github | The script's repository on GitHub, as input to the {{github}} template. | String | optional |
| Styled? | styled | Set to yes for an alternate colored version (see example on template page)
| String | optional |
| Categorize? | categorize cat | Set to no to prevent categorizing the page into Category:Wikipedia scripts
| String | optional |
| Main Source | mainsource | The main source file, which is to be loaded from the user's custom script. | Page name | optional |
| Install Target | install-target | The preferred page on which the script should be included. The default is common.js. | String | optional |