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

From blackwiki
Jump to navigation Jump to search
imported>Favre1fan93
 
(23 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
<noinclude>{{Documentation subpage}}</noinclude>
 
<noinclude>{{Documentation subpage}}</noinclude>
{{incomplete}}
+
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
 
==Usage==
 
==Usage==
<pre>
+
{{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|frequently_updated|preview version|preview version release date|update|updated|platform|operating system|OS|os|pricing|status|members|website}}
{{Infobox video game online service
+
<pre style="overflow:auto;">
|name                        =  
+
{{Infobox online service
|title                        =  
+
| name                        =
|logo                        =  
+
| title                        =
|caption                     =  
+
| logo                        =
|developer                    =
+
| logo_size                    =
|type                        =
+
| logo_alt                    =
|released                     =
+
| logo caption                 =
|version                      =
+
| image                        =
|version release date        =  
+
| image_size                  =
|preview version              =  
+
| image_alt                    =
|preview version release date =
+
| collapsible          = <!-- set as "on", "y", etc, otherwise omit/leave blank -->
|update                      =
+
| collapsetext        = <!-- collapsible area's heading (default "Screenshot"); omit/leave blank if collapsible not set -->
|platform                    =
+
| developer                    =
|os                          =
+
| generation                  =
|status                      =
+
| type                        =
|members                      =
+
| launched                     =
|website                      =
+
| discontinued                =
 +
| version                      =
 +
| version release date        =
 +
| preview version              =
 +
| preview version release date =
 +
| updated                      =
 +
| platform                    =
 +
| operating system            =
 +
| status                      =
 +
| pricing                      =
 +
| members                      =
 +
| website                      =
 
}}
 
}}
 
</pre>
 
</pre>
  
 
==Parameters==
 
==Parameters==
 
+
{{TemplateData header}}
{| class="wikitable"
+
<templatedata>
! style="text-align: left" | Parameter
+
{
! style="text-align: left" | Explanation
+
"description": "Produces infobox for an article on an online video game service, such a digital distribution service, a gaming server or software plus service.",
|-
+
"params": {
| '''title'''
+
"title": {
| Insert the name of the online service/online market.
+
"label": "Display name",
|-
+
"type": "string",
| '''logo'''
+
"required": false,
| If it has one, insert an image link in form <nowiki>[[Image:IMAGENAME|???px]]</nowiki>
+
"description": "Title of the infobox displayed at the top. If not supplied, Name or article title is used. Must be text only. (No wikicode.)"
|-
+
},
| '''caption'''
+
"name": {
| Insert a caption for the image (if needed).
+
"label": "Name",
|-
+
"type": "string",
| '''developer'''
+
"required": false,
| Insert the developer(s) name e.g. ''Sony''.
+
"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.)"
|-
+
},
| '''type'''
+
"logo": {
| Insert the type of the online service e.g. ''Online Market'', ''Online Service'' etc.
+
"label": "Logo",
|-
+
"type": "string",
| '''released'''
+
"required": false,
| Insert the date(s) it was first available (public) to users e.g. ''December 2007'', ''July 12, 2004'' or ''21 August 2001''.
+
"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."
|-
+
},
| '''version'''
+
"logo_size": {
| Insert the latest version of the online service (include a reference) e.g. ''v2.00'' or ''1.05''.
+
"label": "Logo size",
|-
+
"type": "string",
| '''update'''
+
"required": false,
| Insert the last time it was updated (include a reference) e.g. ''May 2006'', ''March 25, 2008'' or ''1 January 2007''.
+
"description": "Size of the logo, if not specified in Logo parameter"
|-
+
},
| '''platform'''
+
"logo_alt": {
| Insert the platform(s) its available to e.g. ''Xbox 360'' or ''PC''.
+
"label": "Logo alt text",
|-
+
"type": "string",
| '''os'''
+
"required": false,
| Insert the Operating System (for PC based services) e.g. ''Microsoft Windows''.
+
"description": "Logo's alt text, if not specified in Logo parameter"
|-
+
},
| '''status'''
+
"logo caption": {
| For use on defunct (historical) services; insert a brief note about the status e.g. ''Superseded by X'' or ''Defunct''.
+
"label": "Logo caption",
|-
+
"type": "string",
| '''members'''
+
"required": false,
| Insert the number of registered members the online service (approximately) has e.g. ''14 million'' or ''Over 18 million''.
+
"description": "Logo's caption. Logos do not need a caption; yet it is sometimes required to use this field to add image review/deletion notices."
|-
+
},
| '''website'''
+
"image": {
| Insert the online service's website e.g. ''www.xbox.com/live''
+
"label": "Image",
|}
+
"type": "string",
 +
"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.",
 +
"aliases": [
 +
"photo"
 +
]
 +
},
 +
"image_size": {
 +
"label": "Image size",
 +
"type": "string",
 +
"required": false,
 +
"description": "Image's size, if not specified in Image parameter"
 +
},
 +
"image_alt": {
 +
"label": "Image alt text",
 +
"type": "string",
 +
"required": false,
 +
"description": "Image's alt text, if not specified in Image parameter"
 +
},
 +
"collapsible": {
 +
"description": "Whether the screenshot should be collapsed or visible at page load. (Yes / No)",
 +
"label": "Is screenshot collapsible?",
 +
"example": "yes",
 +
"type": "boolean",
 +
"default": "No"
 +
},
 +
"collapsetext": {
 +
"description": "Text for the header of the collapsed section, defaults to ''Screenshot''.",
 +
"label": "Collapsed screenshot header",
 +
"type": "string"
 +
},
 +
"caption": {
 +
"label": "Image caption",
 +
"type": "string",
 +
"required": false,
 +
"description": "A caption for image"
 +
},
 +
"developer": {
 +
"label": "Developer",
 +
"type": "string",
 +
"required": false,
 +
"description": "Name of the developer, owner or operator (depending on the subject)"
 +
},
 +
"type": {
 +
"label": "Type/Genre",
 +
"type": "string",
 +
"required": false,
 +
"description": "Type or genre of the subject (depending on what it is)"
 +
},
 +
"launched": {
 +
"label": "Launch date",
 +
"type": "string",
 +
"required": false,
 +
"description": "Date of the launch, introduction or release of the subject of the article. Use {{tl|Start date}} template.",
 +
"aliases": [
 +
"released",
 +
"introduced"
 +
]
 +
},
 +
"discontinued": {
 +
"label": "Discontinued?",
 +
"type": "string",
 +
"required": false,
 +
"description": "Include \"yes\" to indicate the subject of the article is discontinued"
 +
},
 +
"version": {
 +
"label": "Latest stable version",
 +
"type": "string",
 +
"required": false,
 +
"description": "Version number of the latest stable release of the computer program associated with the subject of the article, if any"
 +
},
 +
"version release date": {
 +
"label": "Latest stable release date",
 +
"type": "string",
 +
"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."
 +
},
 +
"frequently updated": {
 +
"label": "Frequently updated mode?",
 +
"type": "string",
 +
"required": false,
 +
"description": "Include \"yes\" to activate ''Frequently Updated'' mode, in which the infobox receives release data from outside the template. Consult [[Template:Infobox software]] for details."
 +
},
 +
"preview version": {
 +
"label": "Latest preview version",
 +
"type": "string",
 +
"required": false,
 +
"description": "Version number of the latest preview release of the computer program associated with the subject of the article, if any"
 +
},
 +
"preview version release date": {
 +
"label": "Latest preview release date",
 +
"type": "string",
 +
"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."
 +
},
 +
"updated": {
 +
"label": "Latest update date",
 +
"type": "string",
 +
"required": false,
 +
"description": "Date of the last update to the subject of the article (Remote service or website). Use {{tl|Start date}} template.",
 +
"aliases": [
 +
"update"
 +
]
 +
},
 +
"platform": {
 +
"label": "Platform(s)",
 +
"type": "string",
 +
"required": false,
 +
"description": "Hardware and software platform(s) that the subject of the article supports. Omit if platform-independent."
 +
},
 +
"os": {
 +
"label": "Operating system(s)",
 +
"type": "string",
 +
"required": false,
 +
"description": "Operating system(s) that the subject of the article supports. Omit if platform-independent.",
 +
"aliases": [
 +
"OS",
 +
"operating system"
 +
]
 +
},
 +
"status": {
 +
"label": "Status",
 +
"type": "string",
 +
"required": false,
 +
"description": "Status of the subject of the article. Use one or two descriptive words, e.g. \"Active\", \"Defunct\", \"Down\", \"Discontinued\""
 +
},
 +
"pricing": {
 +
"label": "Pricing",
 +
"type": "string",
 +
"required": false,
 +
"description": "Pricing model for the subscription."
 +
},
 +
"members": {
 +
"label": "No. of members",
 +
"type": "number",
 +
"required": false,
 +
"description": "Number of registered members."
 +
},
 +
"website": {
 +
"label": "Website",
 +
"type": "string",
 +
"required": false,
 +
"description": "URL to the company or service website, in a printer-friendly form. Use {{tl|URL}}.",
 +
"default": "{{URL|}}"
 +
}
 +
}
 +
}
 +
</templatedata>
  
 
NOTE: all dates should follow the format of the rest of the article. For more info see: [[:Wikipedia:Manual of Style (dates and numbers)]].
 
NOTE: all dates should follow the format of the rest of the article. For more info see: [[:Wikipedia:Manual of Style (dates and numbers)]].
<includeonly>
+
<includeonly>{{Sandbox other||
 
 
 
[[Category:Video game infobox templates|Online service]]
 
[[Category:Video game infobox templates|Online service]]
 
+
}}</includeonly>
</includeonly>
 

Latest revision as of 15:55, 11 February 2021

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                      =
}}

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).