Difference between revisions of "Template:Infobox online service/doc"
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 | + | {{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.)" |
| − | |||
}, | }, | ||
"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.)" |
| − | |||
}, | }, | ||
"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." |
| − | |||
}, | }, | ||
"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": [ | + | "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" |
| − | |||
}, | }, | ||
"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": { | |
"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" |
| − | |||
}, | }, | ||
"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)" |
| − | |||
}, | }, | ||
"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" |
| − | |||
}, | }, | ||
"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." |
| − | |||
}, | }, | ||
"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" |
| − | |||
}, | }, | ||
"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." |
| − | |||
}, | }, | ||
"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" | + | "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|}}" |
| − | |||
} | } | ||
} | } | ||
Revision as of 15:04, 30 October 2020
| 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. |
| 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 =
| predecessor =
| successor =
}}
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).