Difference between revisions of "Template:Infobox OS component"

From Freephile Wiki
Jump to navigation Jump to search
(Reverted good faith edits by Jeh (talk): Actually, as far as I remember the images were displayed at 300px. The removal is the non-discussed change.)
 
m (1 revision imported: Category:Infobox)
 
(No difference)

Latest revision as of 22:33, 6 February 2017

Documentation icon Template documentation[view] [edit] [history] [purge]

{{Infobox OS component}} is intended for use with articles that discuss a component of an operating system. For instance, Paint (software) article discusses a software application of the same name included with Microsoft Windows. The advantage of this infobox over {{Infobox software}} is that it is lighter, as it does not expose some of the parameters that are not to be populated. For instance, in Microsoft Windows, most components are published by Microsoft, only receive major updates with an operating system release and have the same licensing scheme as that of the operating system. Thus, information such as version number, release date, license and developer are either redundant or without context, lacking encyclopedic value.

Usage[edit source]

{{Infobox OS component
| name                =
| os                  =
| logo                =
| logo_size           =
| logo_caption        =
| screenshot          =
| screenshot_size     =
| caption             =
| other_names         =
| type                =
| service_name        =
| service_description =
| included_with       =
| also_available_for  =
| replaces            =
| replaced_by         =
| support_status      =
| related_components  =
}}

Parameters[edit source]

Basic information[edit source]

name 
Required. The name of the component. This should match the name of the article. e.g. "Microsoft Paint".
os 
Optional. The operating system family the bundles this component. For historical reasons, the default is "Microsoft Windows". Please avoid using names of superfamilies such as "Linux" or "Unix-like", especially when only a small minority of the superfamily have the component. Instead, use an accurate sub-family name when possible, such as "macOS" or "Windows Server".
screenshot 
Optional. A screenshot depicting the main user interface of the component. Screenshots should not include any non-standard themes, third-party applications, or personally identifiable information. Also, per Wikipedia:Avoid self-references, no references to Wikipedia should be visible. e.g. "File:Microsoft Paint screenshot.png"
screenshot_size 
Optional. A width for the screenshot image, including the unit of measurement, e.g. "px"; the default is "300px".
caption 
Optional. A caption describing the screenshot. Use of the word "screenshot" in the description can be considered optional, as the template places the image in a section titled "Screenshot".
logo 
Optional. The computer icon associated with the component. e.g. "Paint Windows 7 icon.png"
logo_size 
Optional. A width for the image, including the unit of measurement, e.g. "px"; the default is "64px".
logo_caption
Optional. Used for providing emergency text with the logo. It is never necessary to tell the reader that they are looking at the computer icon of a computer program. As such this field is used for emergency cases, such as when the computer icon is nominated for deletion; in such cases, the nominator would supply the {{ffdc}} template in this field.

Details[edit source]

type 
This is the type of component. Can be anything, including those listed in utility software and application software articles.
included with 
A list of operating systems with which this component is included. If the component has been included with all releases of a specific line of operating systems, use the family name instead of listing each operating system. For example, use Windows 9x instead of Windows 95, Windows 98 and Windows ME.
also available for 
A list of operating systems for which this component is also available.
service name 
If the article describes a Windows service, daemon, this should be the name of the service. For example, Windows Security Center's service name is "wscsvc".
replaces 
If this component replaces another component, list it here.
replaced by 
If this component is replaced by another component, list it here.
related_components 
Optional. A list of other Wikipedia articles that cover subjects directly related to this component.

TemplateData[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for Infobox OS component

{{Infobox OS component}} is intended for use with articles that discuss a component of an operating system. For instance, Microsoft Paint article discusses a software application of the same name included with Microsoft Windows. The advantage of this infobox over {{Infobox software}} is that it is lighter, as it does not expose some of the parameters that are not to be populated. For instance, in Microsoft Windows, most components are published by Microsoft, only receive major updates with an operating system release and have the same licensing scheme as that of the operating system. Thus, information such as version number, release date, license and developer are either redundant or without context, lacking encyclopedic value.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Name of the computer program. 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.

Default
{{PAGENAME}}
Stringrequired
Icon (or logo)logo

The computer icon associated with the component. e.g. "Paint Windows 7 icon.png"

Filesuggested
Icon (or logo) sizelogo_size

Size of the logo. Any valid CSS size value is acceptable. Use of this parameter is discouraged.

Default
64px
Stringoptional
Icon (or 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}}.

Unbalanced wikitextoptional
Screenshotscreenshot

File name for a screenshot of the image

Filesuggested
Screenshot sizescreenshot_size

Size of the screenshot. Any valid CSS size value is acceptable. Default is 300px. Use of this parameter is not recommended.

Stringoptional
Screenshot captioncaption

Caption for the screenshot. Inclusion is highly recommended.

Stringsuggested
Operating system (OS)os

The operating system family the bundles this component. For historical reasons, the default is "Microsoft Windows". Please avoid using names of superfamilies such as "Linux" or "Unix-like", especially when only a small minority of the superfamily have the component. Instead, use an accurate sub-family name when possible, such as "macOS" or "Windows Server".

Pagesuggested
Other nameother_names

Old name or alternative popular names

Stringoptional
Type or genretype

Type of program. Should be wikilinked to an article such as '[[Geographic information system]]'. For more information, consult [[Category:List of software categories]].

Stringsuggested
Service/daemon nameservice_name

If the article subject is (or encompasses) a service or daemon, please specify the service name and service display name. e.g. "Windows Security Center (wscsvc)". To explain connected services or daemons that are not part of the component, please use the prose and (if applicable) the "related components" parameter.

Stringoptional
Service descriptionservice_description

Official service description, if a service name is specified.

Stringoptional
Included withincluded_with

A list of operating systems with which this component is included. If the component has been included with all releases of a specific line of operating systems, use the family name instead of listing each operating system. For example, use Windows 9x instead of Windows 95, Windows 98 and Windows ME.

Stringsuggested
Also available foralso_available_for

A list of operating systems for which this component may be downloaded as an update.

Stringsuggested
Replaces...replaces

Name of components that were deprecated in favor of this one.

Stringsuggested
Replaced by...replaced_by

Name of the component(s) that deprecated the subject of this article.

Stringsuggested
Support statussupport_status

For components that do not adhere to the operating system's support policy, e.g. have extended or contracted out-of-band supported, use this field to explain those terms.

Unbalanced wikitextoptional
Related componentsrelated_components

List of components closely related to this component.

Stringsuggested
Body style (CSS)bodystyle

CSS styling for the infobox as a whole

Unbalanced wikitextoptional