Difference between revisions of "Template:Infobox online service/doc"
imported>Favre1fan93 m (→Usage) |
|||
| (22 intermediate revisions by 13 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>{{Documentation subpage}}</noinclude> | <noinclude>{{Documentation subpage}}</noinclude> | ||
| − | {{ | + | {{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 | + | <pre style="overflow:auto;"> |
| − | |name = | + | {{Infobox online service |
| − | |title = | + | | name = |
| − | |logo = | + | | title = |
| − | |caption | + | | logo = |
| − | |developer = | + | | logo_size = |
| − | |type = | + | | logo_alt = |
| − | | | + | | 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 --> |
| − | | | + | | collapsetext = <!-- collapsible area's heading (default "Screenshot"); omit/leave blank if collapsible not set --> |
| − | |platform = | + | | developer = |
| − | | | + | | 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}} | |
| − | { | + | <templatedata> |
| − | + | { | |
| − | + | "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": { | |
| − | + | "label": "Display name", | |
| − | + | "type": "string", | |
| − | + | "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.)" | |
| − | + | }, | |
| − | + | "name": { | |
| − | + | "label": "Name", | |
| − | + | "type": "string", | |
| − | + | "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.)" | |
| − | + | }, | |
| − | + | "logo": { | |
| − | + | "label": "Logo", | |
| − | + | "type": "string", | |
| − | + | "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." | |
| − | + | }, | |
| − | + | "logo_size": { | |
| − | + | "label": "Logo size", | |
| − | | | + | "type": "string", |
| − | + | "required": false, | |
| − | + | "description": "Size of the logo, if not specified in Logo parameter" | |
| − | + | }, | |
| − | + | "logo_alt": { | |
| − | + | "label": "Logo alt text", | |
| − | + | "type": "string", | |
| − | + | "required": false, | |
| − | + | "description": "Logo's alt text, if not specified in Logo parameter" | |
| − | + | }, | |
| − | + | "logo caption": { | |
| − | + | "label": "Logo caption", | |
| − | + | "type": "string", | |
| − | + | "required": false, | |
| − | + | "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." | |
| − | + | }, | |
| − | + | "image": { | |
| − | + | "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
| 40px | This is a documentation subpage for Template:Infobox online service. It contains usage information, categories and other content that is not part of the original template page. |
| 30px | This template uses Lua: |
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
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Display name | title | Title of the infobox displayed at the top. If not supplied, Name or article title is used. Must be text only. (No wikicode.) | String | optional |
| Name | name | 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.) | String | optional |
| Logo | logo | 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. | String | optional |
| Logo size | logo_size | Size of the logo, if not specified in Logo parameter | String | optional |
| Logo alt text | logo_alt | Logo's alt text, if not specified in Logo parameter | String | optional |
| Logo caption | logo 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. | String | optional |
| Image | image 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. | String | optional |
| Image size | image_size | Image's size, if not specified in Image parameter | String | optional |
| Image alt text | image_alt | Image's alt text, if not specified in Image parameter | String | optional |
| Is screenshot collapsible? | collapsible | Whether the screenshot should be collapsed or visible at page load. (Yes / No)
| Boolean | optional |
| Collapsed screenshot header | collapsetext | Text for the header of the collapsed section, defaults to ''Screenshot''. | String | optional |
| Image caption | caption | A caption for image | String | optional |
| Developer | developer | Name of the developer, owner or operator (depending on the subject) | String | optional |
| Type/Genre | type | Type or genre of the subject (depending on what it is) | String | optional |
| Launch date | launched released introduced | Date of the launch, introduction or release of the subject of the article. Use {{tl|Start date}} template. | String | optional |
| Discontinued? | discontinued | Include "yes" to indicate the subject of the article is discontinued | String | optional |
| Latest stable version | version | Version number of the latest stable release of the computer program associated with the subject of the article, if any | String | optional |
| Latest stable release date | version 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. | String | optional |
| 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. | String | optional |
| Latest preview version | preview version | Version number of the latest preview release of the computer program associated with the subject of the article, if any | String | optional |
| Latest preview release date | preview 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. | String | optional |
| Latest update date | updated update | Date of the last update to the subject of the article (Remote service or website). Use {{tl|Start date}} template. | String | optional |
| Platform(s) | platform | Hardware and software platform(s) that the subject of the article supports. Omit if platform-independent. | String | optional |
| Operating system(s) | os OS operating system | Operating system(s) that the subject of the article supports. Omit if platform-independent. | String | optional |
| Status | status | Status of the subject of the article. Use one or two descriptive words, e.g. "Active", "Defunct", "Down", "Discontinued" | String | optional |
| Pricing | pricing | Pricing model for the subscription. | String | optional |
| No. of members | members | Number of registered members. | Number | optional |
| Website | website | URL to the company or service website, in a printer-friendly form. Use {{tl|URL}}.
| String | optional |
NOTE: all dates should follow the format of the rest of the article. For more info see: Wikipedia:Manual of Style (dates and numbers).