Difference between revisions of "Template:Infobox online service/doc"

From blackwiki
Jump to navigation Jump to search
imported>The Grid
(Reverted 1 edit by 2601:3C5:8000:1140:D8FB:BCBB:E6AE:4363 (talk): Test edit? (TW))
imported>Izno
(and in the doc as well)
Line 2: Line 2:
 
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
 
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
 
==Usage==
 
==Usage==
{{Parameter names example|title|Title|name|Name|logo|Logo|logo_size|image|logo_alt|logo caption|photo|Photo|image_size|ImageWidth|image_alt|caption|Caption|Developer|developer|type|released|launched|introduced|discontinued|ended|shutdown|version|Version|version release date |Version Release Date|version release date|frequently updated|frequently_updated|preview version|Preview Version|preview version release date|Preview Version Release Date|Update|update|Updated|updated|platform|operating system|OS|os|pricing|status|members|Website|website}}
+
{{Parameter names example|title|name|logo|logo_size|image|logo_alt|logo caption|photo|image_size|image_alt|caption|developer|type|released|launched|introduced|discontinued|ended|shutdown|version|version release date|version release date|frequently_updated|preview version|preview version release date|update|updated|platform|operating system|OS|os|pricing|status|members|website}}
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
{{Infobox online service
 
{{Infobox online service
Line 47: Line 47:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Title of the infobox displayed at the top. If not supplied, Name or article title is used. Must be text only. (No wikicode.)",
+
"description": "Title of the infobox displayed at the top. If not supplied, Name or article title is used. Must be text only. (No wikicode.)"
"aliases": ["Title"]
 
 
},
 
},
 
"name": {
 
"name": {
Line 54: Line 53:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Name of the infobox. Used by ''Frequently Updated'' mode and displayed at the top of the infobox, unless a Title is specified. Must be text only. (No wikicode.)",
+
"description": "Name of the infobox. Used by ''Frequently Updated'' mode and displayed at the top of the infobox, unless a Title is specified. Must be text only. (No wikicode.)"
"aliases": ["Name"]
 
 
},
 
},
 
"logo": {
 
"logo": {
Line 61: Line 59:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Code representing a logo. Can be just the name of an image file containing the logo (with or without \"File:\") or a full image syntax.",
+
"description": "Code representing a logo. Can be just the name of an image file containing the logo (with or without \"File:\") or a full image syntax."
"aliases": ["Logo"]
 
 
},
 
},
 
"logo_size": {
 
"logo_size": {
Line 87: Line 84:
 
"required": false,
 
"required": false,
 
"description": "Code representing an image, such as the screenshot or a photograph of the subject of the article. Can be just the name of an image file containing the logo (with or without \"File:\") or a full image syntax.",
 
"description": "Code representing an image, such as the screenshot or a photograph of the subject of the article. Can be just the name of an image file containing the logo (with or without \"File:\") or a full image syntax.",
"aliases": ["Image", "photo", "Photo"]
+
"aliases": [
 +
"photo"
 +
]
 
},
 
},
 
"image_size": {
 
"image_size": {
Line 93: Line 92:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Image's size, if not specified in Image parameter",
+
"description": "Image's size, if not specified in Image parameter"
"aliases": ["ImageWidth"]
 
 
},
 
},
 
"image_alt": {
 
"image_alt": {
Line 102: Line 100:
 
"description": "Image's alt text, if not specified in Image parameter"
 
"description": "Image's alt text, if not specified in Image parameter"
 
},
 
},
"collapsible": {
+
"collapsible": {
 
"description": "Whether the screenshot should be collapsed or visible at page load. (Yes / No)",
 
"description": "Whether the screenshot should be collapsed or visible at page load. (Yes / No)",
 
"label": "Is screenshot collapsible?",
 
"label": "Is screenshot collapsible?",
Line 118: Line 116:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "A caption for image",
+
"description": "A caption for image"
"aliases": ["Caption"]
 
 
},
 
},
 
"developer": {
 
"developer": {
Line 125: Line 122:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Name of the developer, owner or operator (depending on the subject)",
+
"description": "Name of the developer, owner or operator (depending on the subject)"
"aliases": ["Developer"]
 
 
},
 
},
 
"type": {
 
"type": {
Line 139: Line 135:
 
"required": false,
 
"required": false,
 
"description": "Date of the launch, introduction or release of the subject of the article. Use {{tl|Start date}} template.",
 
"description": "Date of the launch, introduction or release of the subject of the article. Use {{tl|Start date}} template.",
"aliases": ["released", "introduced"]
+
"aliases": [
 +
"released",
 +
"introduced"
 +
]
 
},
 
},
 
"discontinued": {
 
"discontinued": {
Line 151: Line 150:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Version number of the latest stable release of the computer program associated with the subject of the article, if any",
+
"description": "Version number of the latest stable release of the computer program associated with the subject of the article, if any"
"aliases": ["Version"]
 
 
},
 
},
 
"version release date": {
 
"version release date": {
Line 158: Line 156:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "General availability date of the latest stable release of the computer program associated with the subject of the article, if any. Use {{tl|Start date and age}} template.",
+
"description": "General availability date of the latest stable release of the computer program associated with the subject of the article, if any. Use {{tl|Start date and age}} template."
"aliases": ["Version Release Date"]
 
 
},
 
},
 
"frequently updated": {
 
"frequently updated": {
Line 171: Line 168:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Version number of the latest preview release of the computer program associated with the subject of the article, if any",
+
"description": "Version number of the latest preview release of the computer program associated with the subject of the article, if any"
"aliases": ["Preview Version"]
 
 
},
 
},
 
"preview version release date": {
 
"preview version release date": {
Line 178: Line 174:
 
"type": "string",
 
"type": "string",
 
"required": false,
 
"required": false,
"description": "Publication date of the latest preview release of the computer program associated with the subject of the article, if any. Use {{tl|Start date and age}} template.",
+
"description": "Publication date of the latest preview release of the computer program associated with the subject of the article, if any. Use {{tl|Start date and age}} template."
"aliases": ["Preview Version Release Date"]
 
 
},
 
},
 
"updated": {
 
"updated": {
Line 186: Line 181:
 
"required": false,
 
"required": false,
 
"description": "Date of the last update to the subject of the article (Remote service or website). Use {{tl|Start date}} template.",
 
"description": "Date of the last update to the subject of the article (Remote service or website). Use {{tl|Start date}} template.",
"aliases": ["update", "Update", "Updated"]
+
"aliases": [
 +
"update"
 +
]
 
},
 
},
 
"platform": {
 
"platform": {
Line 199: Line 196:
 
"required": false,
 
"required": false,
 
"description": "Operating system(s) that the subject of the article supports. Omit if platform-independent.",
 
"description": "Operating system(s) that the subject of the article supports. Omit if platform-independent.",
"aliases": ["OS", "operating system"]
+
"aliases": [
 +
"OS",
 +
"operating system"
 +
]
 
},
 
},
 
"status": {
 
"status": {
Line 224: Line 224:
 
"required": false,
 
"required": false,
 
"description": "URL to the company or service website, in a printer-friendly form. Use {{tl|URL}}.",
 
"description": "URL to the company or service website, in a printer-friendly form. Use {{tl|URL}}.",
"default": "{{URL|}}",
+
"default": "{{URL|}}"
"aliases": ["Website"]
 
 
}
 
}
 
}
 
}

Revision as of 15:04, 30 October 2020

Usage

Template:Parameter names example

{{Infobox online service
| name                         =
| title                        =
| logo                         =
| logo_size                    =
| logo_alt                     =
| logo caption                 =
| image                        =
| image_size                   =
| image_alt                    =
| collapsible          = <!-- set as "on", "y", etc, otherwise omit/leave blank -->
| collapsetext         = <!-- collapsible area's heading (default "Screenshot"); omit/leave blank if collapsible not set -->
| developer                    =
| generation                   =
| type                         =
| launched                     =
| discontinued                 =
| version                      =
| version release date         =
| preview version              =
| preview version release date =
| updated                      =
| platform                     =
| operating system             =
| status                       =
| pricing                      =
| members                      =
| website                      =
| predecessor                  =
| successor                    =
}}

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox online service

Produces infobox for an article on an online video game service, such a digital distribution service, a gaming server or software plus service.

Template parameters

ParameterDescriptionTypeStatus
Display nametitle

Title of the infobox displayed at the top. If not supplied, Name or article title is used. Must be text only. (No wikicode.)

Stringoptional
Namename

Name of the infobox. Used by ''Frequently Updated'' mode and displayed at the top of the infobox, unless a Title is specified. Must be text only. (No wikicode.)

Stringoptional
Logologo

Code representing a logo. Can be just the name of an image file containing the logo (with or without "File:") or a full image syntax.

Stringoptional
Logo sizelogo_size

Size of the logo, if not specified in Logo parameter

Stringoptional
Logo alt textlogo_alt

Logo's alt text, if not specified in Logo parameter

Stringoptional
Logo captionlogo caption

Logo's caption. Logos do not need a caption; yet it is sometimes required to use this field to add image review/deletion notices.

Stringoptional
Imageimage photo

Code representing an image, such as the screenshot or a photograph of the subject of the article. Can be just the name of an image file containing the logo (with or without "File:") or a full image syntax.

Stringoptional
Image sizeimage_size

Image's size, if not specified in Image parameter

Stringoptional
Image alt textimage_alt

Image's alt text, if not specified in Image parameter

Stringoptional
Is screenshot collapsible?collapsible

Whether the screenshot should be collapsed or visible at page load. (Yes / No)

Default
No
Example
yes
Booleanoptional
Collapsed screenshot headercollapsetext

Text for the header of the collapsed section, defaults to ''Screenshot''.

Stringoptional
Image captioncaption

A caption for image

Stringoptional
Developerdeveloper

Name of the developer, owner or operator (depending on the subject)

Stringoptional
Type/Genretype

Type or genre of the subject (depending on what it is)

Stringoptional
Launch datelaunched released introduced

Date of the launch, introduction or release of the subject of the article. Use {{tl|Start date}} template.

Stringoptional
Discontinued?discontinued

Include "yes" to indicate the subject of the article is discontinued

Stringoptional
Latest stable versionversion

Version number of the latest stable release of the computer program associated with the subject of the article, if any

Stringoptional
Latest stable release dateversion release date

General availability date of the latest stable release of the computer program associated with the subject of the article, if any. Use {{tl|Start date and age}} template.

Stringoptional
Frequently updated mode?frequently updated

Include "yes" to activate ''Frequently Updated'' mode, in which the infobox receives release data from outside the template. Consult [[Template:Infobox software]] for details.

Stringoptional
Latest preview versionpreview version

Version number of the latest preview release of the computer program associated with the subject of the article, if any

Stringoptional
Latest preview release datepreview version release date

Publication date of the latest preview release of the computer program associated with the subject of the article, if any. Use {{tl|Start date and age}} template.

Stringoptional
Latest update dateupdated update

Date of the last update to the subject of the article (Remote service or website). Use {{tl|Start date}} template.

Stringoptional
Platform(s)platform

Hardware and software platform(s) that the subject of the article supports. Omit if platform-independent.

Stringoptional
Operating system(s)os OS operating system

Operating system(s) that the subject of the article supports. Omit if platform-independent.

Stringoptional
Statusstatus

Status of the subject of the article. Use one or two descriptive words, e.g. "Active", "Defunct", "Down", "Discontinued"

Stringoptional
Pricingpricing

Pricing model for the subscription.

Stringoptional
No. of membersmembers

Number of registered members.

Numberoptional
Websitewebsite

URL to the company or service website, in a printer-friendly form. Use {{tl|URL}}.

Default
{{URL|}}
Stringoptional

NOTE: all dates should follow the format of the rest of the article. For more info see: Wikipedia:Manual of Style (dates and numbers).