Template:Infobox information appliance/doc

< Template:Infobox information appliance
Revision as of 17:16, 25 May 2019 by wikipedia>Brainulator9 (→‎Parameters: documenting upright)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Usage

{{{name}}}
[[File:{{{logo}}}|frameless|upright=1]]
[[File:{{{image}}}|300px|upright=1]]
{{{caption}}}
Also known as{{{aka}}}
Developer{{{developer}}}
Manufacturer{{{manufacturer}}}
Product family{{{family}}}
Type{{{type}}}
Generation{{{generation}}}
Release date{{{release date}}}
Retail availability{{{retail availability}}}
Lifespan{{{lifespan}}}
Introductory price{{{price}}}
Discontinued{{{discontinued}}}
Units sold{{{units sold}}}
Units shipped{{{units shipped}}}
Media{{{media}}}
Operating system{{{os}}}
System-on-chip used{{{soc}}}
CPU{{{cpu}}}
Memory{{{memory}}}
Storage{{{storage}}}
Removable storage{{{memory card}}}
Display{{{display}}}
Graphics{{{graphics}}}
Sound{{{sound}}}
Input{{{input}}}
Controller input{{{controllers}}}
Camera{{{camera}}}
Touchpad{{{touchpad}}}
Connectivity{{{connectivity}}}
Power{{{power}}}
Platform{{{platform}}}
Current firmware{{{currentfw}}}
Online services{{{service}}}
Dimensions{{{dimensions}}}
Mass{{{weight}}}
Best-selling game{{{topgame}}}
Backward
compatibility
{{{compatibility}}}
Predecessor{{{predecessor}}}
Successor{{{successor}}}
Related articles{{{related}}}
Website{{{website}}}
{{Infobox information appliance
| name         = 
| title        = 
| aka          = 
| logo         = 
| image        = 
| caption      = 
| developer    = 
| manufacturer = 
| family       = 
| type         = 
| generation   = 
| release date  = {{Start date|YYYY|MM|DD}}
| retail availability =
| lifespan     = 
| price        = 
| discontinued = 
| units sold    = 
| units shipped = 
| media        = 
| os           = 
| power        = 
| soc          = 
| cpu          = 
| memory       = 
| storage      = 
| memory card  = 
| display      = 
| graphics     = 
| sound        = 
| input        = 
| controllers  = 
| camera       = 
| touchpad     = 
| connectivity = 
| currentfw    =
| platform     = 
| service      = 
| dimensions   = 
| weight       = 
| topgame      = 
| compatibility= 
| predecessor  = 
| successor    = 
| related      = 
| website      = {{URL|example.org}}
}}

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 information appliance

No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename Name Title

Name of the appliance. Default it the article name. However it is a required parameter as it does not accept null.

Default
PAGENAME
Stringoptional
Logologo

File name of the logo to be appeared at the top of the infobox

Stringoptional
Logo sizelogo_size

Size of the logo. Default is 250px. Must not normally be changed.

Default
250px
Stringoptional
Logo uprightlogo_upright

Size of the logo, scaling per user preferences. Default is 1. Must not normally be changed.

Default
1
Stringoptional
Logo alternative textlogo_alt

Alternative text for the logo, used when the web browser cannot display the image or when a visually-impaired person uses a screen reader.

Stringoptional
Logo captionlogo caption

Caption for the logo. Must only be used to provide anything far more important than 'This is the logo of X'. e.g. used for inserting {{ffdc}} or {{deletable image-caption}}.

Stringoptional
Imageimage Image photo Photo

File name of the image of the appliance to be appeared at the top of the infobox.

Stringoptional
Image sizeimage_size ImageWidth

Image size. Defaults to 300px. The best practice is to ensure the image is displayed at the default resolution. Hence, use of this parameter is discouraged.

Default
300px
Stringoptional
Image uprightimage_upright

Size of the logo, scaling per user preferences. Default is 1.

Default
1
Stringoptional
Image alternative textalt

Alternative text for the screenshot (used by the blind and when web browsers cannot or do not load the image)

Stringoptional
Image captioncaption

Caption for the image of the appliance.

Stringoptional
Also known as? ("AKA")aka

Device nickname

Stringoptional
Developerdeveloper Developer

Name of the developer, if applicable

Stringoptional
Manufacturermanufacturer

Name of the manufacturer, if applicable

Stringoptional
Familyfamily

Product family

Stringoptional
Typetype Type

Type of the device

Stringoptional
Generationgeneration

Name of the device generation, if it is part of a line of products developed iteratively

Stringoptional
Release daterelease date releasedate first_release_date Released Introduced

Date introduced

Stringoptional
Retail availabilityretail availability

Average expected retail availability (date first available in retail to date last available in retail (i.e. the date no more units are being sold, which may be years after production stops))

Stringoptional
Lifespanlifespan

Average expected lifespan (release date to discontinuation date (i.e. end of production))

Stringoptional
Base pricebaseprice Baseprice price MSRP

Price at the initial release. Per [[WP:NOTCATALOGUE]], "An article should not include product pricing information unless there is an independent source and a justified reason for the mention. Encyclopedic significance may be indicated if mainstream media sources (not just product reviews) provide commentary on these details instead of just passing mention.

Stringoptional
Discontinuation datediscontinued Discontinued discontinuation_date

Date at which the product is discontinued

Stringoptional
Units soldunits sold unitssold

Number of units sold, including pre-orders

Stringoptional
Units shippedunits shipped unitsshipped

Number of units shipped

Stringoptional
Mediamedia Media

Supported media. Where applicable, consider using "removable storage" parameter instead.

Stringoptional
Operating systemos OS operatingsystem

Operating system bundled with the product

Stringoptional
Powerpower Power

Power consumption specifications

Stringoptional
System-on-chip usedsoc

System-on-chip used, if applicable

Stringoptional
CPU make and modelcpu CPU processor Processor

Central processing unit's brand name and model

Stringoptional
CPU clock speedCPUspeed

Central processing unit's clock speed, expressed in hertz

Stringoptional
Amount of memory installedmemory Memory RAM

Amount of volatile random-access memory installed on the appliance

Stringoptional
Memory typeRAMtype

Make and model of the volatile random-access memory modules used

Stringoptional
Storage devicestorage

Type(s) and specifications of non-volatile internal storage device(s)

Stringoptional
Removable storagememory card

Type(s) and specifications of non-volatile removable storage device(s) supported

Stringoptional
Displaydisplay Display

Specifications of included or supported display device, e.g resolution

Stringoptional
Graphicsgraphics Graphics GPU

Specifications of the included graphics component, which is responsible for outputing content to display devices

Stringoptional
Soundsound Sound

Specifications of audio subsystem

Stringoptional
Inputinput Input

Input devices included or supported. Specialized versions of this parameter include: Controllers, camera and touch pad.

Stringoptional
Controllerscontrollers

Video gaming controller supported

Stringoptional
Cameracamera

Specifications of camera included

Stringoptional
Touchpadtouchpad

Specifications of touchpad included; e.g. make, model, number of buttons or whether it support multitouch

Stringoptional
Connectivityconnectivity Connectivity

Specifications of component that support data transfer in and out of the device, including networking subsystems

Stringoptional
Current firmwarecurrentfw

Indication of the current version of the device's firmware.

Stringoptional
Underlying platformplatform

Name of any underlying platforms

Stringoptional
Online serviceonline service onlineservice service

Name of associated online service(s)

Stringoptional
Dimensionsdimensions Casing

Dimensions

Stringoptional
Massweight

Mass

Stringoptional
Best-selling video gametop game topgame

Name of the best selling video game that works on the appliance, if appliable. Please include source and sale stats.

Stringoptional
Compatibilitycompatibility

Details of backward compatibility with its predecessor

Stringoptional
Predecessorpredecessor

Name of predecessor

Stringoptional
Successorsuccessor

Name of successor

Stringoptional
Relatedrelated

Name of sibling devices

Stringoptional
Websitewebsite Website

URL of the official website, in a printer-friendly form. Consider using {{URL}} template.

Stringoptional

Important notes

Under WP:NOPRICES, "product prices should not be quoted in an article unless they can be sourced and there is a justified reason for their mention". Use of the "price" field should therefore be the exception rather than the norm.

In addition to the tracking category below, using this template without including at least one of parameters besides "title", "image", and "caption" will add the page to Category:Articles which use infobox templates with no data rows.

Microformats

The HTML mark-up produced by this template includes an hCalendar microformat that makes event details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Classes used

The HTML classes of this microformat include:

  • attendee
  • contact
  • description
  • dtend
  • dtstart
  • location
  • organiser
  • summary
  • url
  • vevent
Please do not rename or remove these classes
nor collapse nested elements which use them.

The HTML mark-up produced by this template includes an hProduct microformat that makes a product's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

If the product has a URL, use {{URL}} to include it.

Classes used

The HTML classes of this microformat include:

  • brand
  • category
  • description
  • fn
  • hproduct
  • identifier
  • listing
  • photo
  • price
  • review
  • type
  • url
  • value
Please do not rename or remove these classes
nor collapse nested elements which use them.

Tracking category

See also