Template:Infobox OS/doc

From TSP Encyclopedia
Revision as of 15:04, 24 August 2024 by Genericsequencealias (talk | contribs) (~~~Added slightly modified docs for OS Infobox Template.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This template can be used to provide a summary for articles on computer operating systems.

Usage

{{{title}}}
Version of the {{{version_of}}} operating system
[[File:{{{logo}}}|{{{logo_size}}}|alt={{{logo_alt}}}]]
{{{logo_caption}}}
Screenshot
[[File:{{{screenshot}}}|{{{screenshot_size}}}|alt={{{screenshot_alt}}}]]
{{{caption}}}
Developer{{{developer}}}
Written in{{{programmed_in}}}
OS family{{{family}}}
Working state{{{working_state}}}
Source model{{{source_model}}}
Released to
manufacturing
{{{RTM_date}}}[1]
General
availability
{{{GA_date}}}[2]
Final release{{{latest release version}}} / {{{latest release date}}}[3]
Final preview{{{latest preview version}}} / {{{latest preview date}}}[4]
Marketing target{{{marketing_target}}}
Available in{{{language}}}
Update method{{{updatemodel}}}
Package manager{{{package_manager}}}
Platforms{{{supported_platforms}}}
Kernel type{{{kernel_type}}}
Userland{{{userland}}}
Influenced{{{influenced}}}
Influenced by{{{influenced_by}}}
Default
user interface
{{{ui}}}
License{{{license}}}
Preceded by{{{preceded_by}}}
Succeeded by{{{succeeded_by}}}
Tagline{{{tagline}}}
Support status
{{{support_status}}}
Articles in the series
{{{other_articles}}}
{{Parameter names example|_template=||bodystyle|title|name|version_of|version of|logo|logo_size|logo size|logo_alt|logo alt|logo_caption|logo caption|collapsible|screenshot|screenshot_size|screenshot_alt|caption|developer|programmed_in|programmed in|prog_language|prog language|family|working_state|working state|source_model|source model|RTM_date|RTM date|first_release_date|first release date|GA_date|GA date|released|RTM_url|RTM url|GA_url|GA url|discontinued|latest release version|latest_release_version|release_version|release version|latest release date|latest_release_date|release_date|release date|release_url|release url|latest preview version|latest_preview_version|preview_version|preview version|latest preview date|latest_preview_date|preview_date|preview date|preview_url|preview url|repo|marketing_target|marketing target|language|human_language|human language|updatemodel|update_model|update model|package_manager|package manager|supported_platforms|supported platforms|kernel_type|kernel type|userland|influenced|influenced_by|influenced by|ui|license|preceded_by|preceded by|succeeded_by|succeeded by|website|tagline|support_status|support status|other_articles|other articles}}
<syntaxhighlight lang="wikitext" style="overflow: auto; white-space: pre;"></syntaxhighlighting>
</br>
{{Infobox OS
| name                   = <!--Name of program or distribution. It is displayed at the top of the infobox if the Title parameter is absent -->
| title			 = <!-- Name of the operating system, displayed at the top of the infobox. If not specified the 'Name' or PAGENAME parameers are used -->
| logo                   = <!-- Filename only: no wikilink, Image: or File:ImageName.svg -->
| logo size              = <!-- Width of the image, including px; the default is '250px'. For example, '125px'. -->
| logo caption           = <!-- Icon to deplay at the title. -->
| logo alt               = <!-- Alternative text for the logo. -->
| screenshot             = <!-- De facto deprecated. -->
| caption                = <!-- De facto deprecated. -->
| screenshot_alt         = <!-- De facto deprecated. -->
| collapsible            = <!-- If the image file is too big. -->
| version of             = <!-- For articles about releases of operating systems ONLY. -->
| developer              = <!-- Name of main developer or sponsor-->
| family                 = <!-- Things "Unix-like" or "Microsoft Windows". Can be custom. -->
| working state          = <!-- "Current", "Discontinued" (operating systems), or "No longer supported" (releases) -->
| source model           = <!-- "[[Open-source software|Open source]]", "Closed-source", or "Source-available" -->
| released               = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| discontinued           = <!-- DON'T use this for articles about releases of operating systems. -->
| RTM date               = <!-- The date when operating system version was released to manufacturing. Should be set to {{Start date and age|Year|Month|Day}}. -->
| GA date                = <!-- The date when operating system version became generally available. Should be set to {{Start date and age|Year|Month|Day}}. -->
| latest release version = <!-- For operating system versions, the version of latest stable build (for example '6.3.9600') -->
| latest release date    = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| latest preview version = 
| latest preview date    = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| repo                   = <!-- Link. Optional. -->
| marketing target       = 
| programmed in          = <!-- Programming languages this operating system is written in. For example: '[[C (programming language)|C]]' -->
| language               = <!-- Supported human languages (Austral, etc. ...) -->
| language count         = 
| language footnote      = 
| update model           = <!-- How is the system receiving updates? -->
| package manager        = <!-- If your OS supports package management, specify. Example: .deb, .vba, etc. -->
| supported platforms    = <!-- [[IA-32]], [[x86-64]], [[Itanium]], [[ARM architecture family|ARM]], etc. -->
| kernel type            = <!-- Hybrid, Monolithic, Microkernel, Exokernel, Nanokernel, etc. -->
| userland               = <!-- Only if supported. -->
| ui                     = <!-- User Interface. -->
| license                = <!-- For fiction, should be the same as the source model. Elaborated in the article. -->
| preceded by            = 
| succeeded by           = 
| website                = <!-- {{URL|www.example.org}} -->
| tagline                = 
| support status         = <!-- For articles about releases of operating systems ONLY -->
| other articles         = 
}}

Parameters

This template can be used to provide a summary for articles on computer operating systems and their particular releases.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Name of the infobox. This is used internally in combination with Template:Latest stable software release/'name' and is also displayed at the top of the infobox if the Title parameter is absent. It must be pure text. Do not include any wikimarkup in this parameter.

Default
PAGENAME
Stringrequired
Titletitle

Name of the operating system. Displayed at the top of the infobox. If not specified the 'Name' parameter or the PAGENAME are used. It should be plain text. Do not include a wikilink, hyperlink or image in this parameter.

Stringoptional
Logologo

An image path for the logo associated with this operating system. Logos used must comply with [[Wikipedia:Logos]] guidelines. For example: 'File:Microsoft Windows XP Logo.svg'

Fileoptional
Logo sizelogo size logo_size

A width for the image, including the 'px'; the default is '250px'. For example: '106px'

Stringoptional
Logo captionlogo caption logo_caption

Icon to display in the title

Contentoptional
Logo's alternative textlogo alt logo_alt

An alternative text for the logo. The alternative text is read by screen readers for the blind and must fill out the role of the logo.

Stringoptional
Screenshotscreenshot

A screenshot depicting the operating system in its default configuration. Screen shots should not include any non-standard themes, third-party applications, or personally identifiable information. For example: 'File:Windows 8 screenshot.png'

Fileoptional
Screenshot sizescreenshot_size

A width for the screenshot, including the 'px'; the default is '290px'. For example: '200px'

Stringoptional
Screenshot's alternative textscreenshot_alt

An alternative text for the screenshot. The alternative text is read by screen readers for the blind and must fill out the role of the screenshot.

Stringoptional
Captioncaption

A caption describing the screenshot. Use of the word 'screenshot' in the description can be considered redundant, as the template places the image in a section titled 'Screenshot'. For example: 'Screenshot of the Windows 8 desktop'

Contentoptional
Collapsiblecollapsible

If the screenshot is too big, this parameter set to 'yes' will collapse this

Default
no
Lineoptional
Version ofversion of version_of

Name of operating system. (For articles about particular operating system releases.)

Contentoptional
Developerdeveloper

Name of the current developer of the software product. It can be either an individual or an organization/business. For example: 'Microsoft'

Contentoptional
Programmed inprogrammed in prog language prog_language programmed_in

Programming languages this operating system is written in. For example: '[[C (programming language)|C]]'

Contentoptional
Familyfamily

The name of the family of operating systems that this version is a part of. Examples include '[[Microsoft Windows]]', '[[Unix-like]]' and '[[Mac OS]]'; 'Linux' and 'Mac OS X' are not OS families

Stringoptional
Working stateworking state working_state

Working state of the operating system. Can be 'Current', 'Discontinued', or 'No longer supported'

Lineoptional
Source modelsource model source_model

Source model of the operating system. Can be '[[Open-source software]]', '[[Closed-source]]', or '[[Source-available]]'. Do not use 'free software', 'free and open-source software' or 'FOSS' as they are mainly licensing models and may or may not use the 'open-source' development methodology

Lineoptional
Initial releasereleased

The date of first public release of operating system. Should be set to {{Start date and age|Year|Month|Day}}. The value of this field is not shown if 'RTM date' or 'GA date' parameters are set

Contentoptional
Discontinueddiscontinued

Set to 'yes' if operating system is discontinued. Note: operating-system versions cannot be discontinued; do not use this parameter in articles about operating-system versions

Default
no
Lineoptional
Released to manufacturingRTM date RTM_date first release date first_release_date

The date when operating system version was released to manufacturing. Should be set to {{Start date and age|Year|Month|Day}}. Any value in this field disables display of 'Released' parameter. Note: only particular versions of operating systems may be released to manufacturing; do not use this parameter in articles about operating systems

Contentoptional
Citation for release to manufacturing infoRTM url RTM_url

DEPRECATED. Do not use.

Unbalanced wikitextdeprecated
General availabilityGA date GA_date

The date when operating system version became generally available. Should be set to {{Start date and age|Year|Month|Day}}. Any value in this field disables display of 'Released' parameter. Note: only particular versions of operating systems may be released to manufacturing; do not use this parameter in articles about operating systems

Contentoptional
Citation for general availability infoGA url GA_url

DEPRECATED. Do not use.

Unbalanced wikitextdeprecated
Latest release versionlatest release version latest_release_version release version release_version

For operating systems, the version number of latest stable release (for example 'Windows 8.1'). For operating system versions, the version of latest stable build (for example '6.3.9600')

Lineoptional
Latest release datelatest release date latest_release_date release date release_date

The date of latest stable release (for operating systems) or build (for operating system versions). Should be set to {{Start date and age|Year|Month|Day}}

Contentoptional
Citation for release inforelease url release_url

DEPRECATED. Do not use.

Unbalanced wikitextdeprecated
Latest preview versionlatest preview version latest_preview_version preview version preview_version

For operating systems, the version number of latest preview ('beta', 'unstable', 'development') release (for example 'Windows 8 Consumer Preview'). For operating system versions, the version of latestpreview ('beta', 'unstable', 'development') build (for example '8250')

Lineoptional
Latest preview datelatest preview date latest_preview_date preview date preview_date

The date of latest preview ('beta', 'unstable', 'development') release (for operating systems) or build (for operating system versions). Should be set to {{Start date and age|Year|Month|Day}}

Contentoptional
Citation for preview infopreview url preview_url

DEPRECATED. Do not use.

Unbalanced wikitextdeprecated
Source code repositoryrepo

The online source code repository, if available. For example, the sourceforge or github project page. As with the website parameter, this should use the {{URL}} template. In the absence of this parameter, infobox attempts to acquire the repository link from Wikidata. This parameter overrides the Wikidata link.

Stringoptional
Marketing targetmarketing target marketing_target

Target audience of operating system or its version

Stringoptional
Language countlanguage count

Number of languages supported. Causes the list of languages to become collapsed.

Numberoptional
Language footnotelanguage footnote

A citation for the number of languages supported. (The list of languages can have an independent citation.) Include<ref> tags if you use the footnote system.

Unbalanced wikitextoptional
Languagelanguage human language human_language

Human languages this operating system is available in. Avoid stating just number of translations or wikilinking languages

Stringoptional
Update modelupdate model updatemodel update_model

Tools or methods of updating operating system

Stringoptional
Package managerpackage manager package_manager

Wikilinked name of package management software supplied with operating system

Contentoptional
Supported platformssupported platforms supported_platforms

Hardware platforms supported by operating system

Stringoptional
Kernel typekernel type kernel_type

Type of kernel of operating system. Possible values include '[[Monolithic kernel|Monolithic]]' or '[[Microkernel]]'. Note: for Linux distributions, this should be '[[Monolithic kernel|Monolithic]] ([[Linux kernel|Linux]])'

Contentoptional
Userlanduserland

(For Unix-like operating systems) type of userland of operating system. Examples include 'BSD' and '[[GNU Core Utilities|GNU]]'

Contentoptional
Influencedinfluenced

Name of technologies, software, devices or methodologies that this operating system influenced.

Stringoptional
Influenced byinfluenced by influenced_by

Name of other technology, software, devices or methodology that influenced the creation of this operating system.

Stringoptional
Default user interfaceui

User interface the default installation of operating system boots into

Contentoptional
Licenselicense

License or licensing model used for this operating system. May be set either to well-known license or licenses with wikilink (for example: '[[GPLv2]]'), or to licensing model ('[[Proprietary software|Proprietary]]' or '[[Freeware]]')

Contentoptional
Preceded bypreceded by preceded_by

For operating system: OS or list of OSs that were officially superseded by this operating system. For operating system versions: previous version of the operating system intended for the same target audience

Contentoptional
Succeeded bysucceeded by succeeded_by

For operating system: OS that officially superseded this operating system. For operating system versions: next version of the operating system intended for the same target audience

Stringoptional
Official websitewebsite

The web site URL of the software package. This URL must be readable in print. Therefore, you should use '{{tl|URL}}' template like this: '{{URL|http://www.example.com}}'. Avoid using printer-hostile forms like '[http://www.example.com Example website]'. In absence of this parameter, infobox attempts to acquire the website link from Wikidata. This parameter overrides the Wikidata link. (It is useful when a second infobox for something different is defined on a page.) In addition, the special value 'hide' suppresses this field, even in presence of a Wikidata link. (It is useful for articles that have several infoboxes and do not want all of them show a Wikidata link ad nauseam.)

Contentoptional
Taglinetagline

A marketing tagline fits perfectly here. Used on iOS and iPadOS version pages.

Stringoptional
Support statussupport status support_status

Support status of operating system version. Not applicable to operating systems

Stringoptional
Other articlesother articles other_articles

List of very closely related articles. For loosely related articles, consider using the 'See also' section instead.

Contentoptional
Body stylebodystyle

CSS style rules to be applied to the entire infobox. Use only when absolutely necessary. Do not use for evil. ;)

Stringoptional

Examples

T.B.D.

Other

  1. {{{RTM_url}}}
  2. {{{GA_url}}}
  3. {{{release_url}}}
  4. {{{preview_url}}}