Changes
Jump to navigation
Jump to search
Template:Infobox OS component/doc (view source)
Revision as of 15:16, 30 January 2017
, 15:16, 30 January 2017Update for the new name for Apple's current UNIX-for-Macs.
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{tl|{{PAGENAME}}}} 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 {{tl|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 [[WP:IINFO|redundant or without context, lacking encyclopedic value]].
== Usage ==
{{mbox |type=content |text='''Caution:''' Lone space characters (or other invisible characters) after equal sign are regarded as a parameter value and may have undesirable effects in case of {{para|logo_size}} or {{para|screenshot_size}}.}}
{| style="float: left; background: transparent; border: none;"
|<pre>
{{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 =
}}
</pre>
|}
{{Clr}}
== Parameters ==
=== Basic information ===
; 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 {{tl|ffdc}} template in this field.
=== Details ===
; 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 (computing)|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==
{{TemplateDataHeader}}
<templatedata>
{
"description": "{{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.",
"params": {
"name": {
"label": "Name",
"description": "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.",
"type": "string",
"default": "{{PAGENAME}}",
"required": true,
"suggested": true
},
"bodystyle": {
"label": "Body style (CSS)",
"description": "CSS styling for the infobox as a whole",
"type": "unbalanced-wikitext"
},
"os": {
"label": "Operating system (OS)",
"description": "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\".",
"type": "wiki-page-name",
"suggested": true
},
"logo": {
"label": "Icon (or logo)",
"description": "The computer icon associated with the component. e.g. \"Paint Windows 7 icon.png\"",
"type": "wiki-file-name",
"suggested": true
},
"logo_size": {
"label": "Icon (or logo) size",
"description": "Size of the logo. Any valid CSS size value is acceptable. Use of this parameter is discouraged.",
"type": "string",
"default": "64px"
},
"logo caption": {
"label": "Icon (or logo) caption",
"description": "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}}.",
"type": "unbalanced-wikitext"
},
"screenshot": {
"label": "Screenshot",
"description": "File name for a screenshot of the image",
"type": "wiki-file-name",
"suggested": true
},
"screenshot_size": {
"label": "Screenshot size",
"description": "Size of the screenshot. Any valid CSS size value is acceptable. Default is 300px. Use of this parameter is not recommended.",
"type": "string"
},
"caption": {
"label": "Screenshot caption",
"description": "Caption for the screenshot. Inclusion is highly recommended.",
"type": "string",
"suggested": true
},
"other_names": {
"label": "Other name",
"description": "Old name or alternative popular names",
"type": "string"
},
"type": {
"label": "Type or genre",
"description": "Type of program. Should be wikilinked to an article such as '[[Geographic information system]]'. For more information, consult [[Category:List of software categories]].",
"type": "string",
"suggested": true
},
"included_with": {
"label": "Included with",
"description": "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.",
"type": "string",
"suggested": true
},
"replaces": {
"label": "Replaces...",
"description": "Name of components that were deprecated in favor of this one.",
"type": "string",
"suggested": true
},
"replaced_by": {
"label": "Replaced by...",
"description": "Name of the component(s) that deprecated the subject of this article.",
"type": "string",
"suggested": true
},
"service_name": {
"label": "Service/daemon name",
"description": "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.",
"type": "string"
},
"service_description": {
"label": "Service description",
"description": "Official service description, if a service name is specified.",
"type": "string"
},
"also_available_for": {
"label": "Also available for",
"description": "A list of operating systems for which this component may be downloaded as an update.",
"type": "string",
"suggested": true
},
"support_status": {
"label": "Support status",
"description": "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.",
"type": "unbalanced-wikitext"
},
"related_components": {
"label": "Related components",
"description": "List of components closely related to this component.",
"type": "string",
"suggested": true
}
},
"paramOrder": [
"name",
"logo",
"logo_size",
"logo caption",
"screenshot",
"screenshot_size",
"caption",
"os",
"other_names",
"type",
"service_name",
"service_description",
"included_with",
"also_available_for",
"replaces",
"replaced_by",
"support_status",
"related_components",
"bodystyle"
],
"format": "block"
}
</templatedata>
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Software infobox templates|Os Component]]
[[Category:Operating system templates]]
}}</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{tl|{{PAGENAME}}}} 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 {{tl|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 [[WP:IINFO|redundant or without context, lacking encyclopedic value]].
== Usage ==
{{mbox |type=content |text='''Caution:''' Lone space characters (or other invisible characters) after equal sign are regarded as a parameter value and may have undesirable effects in case of {{para|logo_size}} or {{para|screenshot_size}}.}}
{| style="float: left; background: transparent; border: none;"
|<pre>
{{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 =
}}
</pre>
|}
{{Clr}}
== Parameters ==
=== Basic information ===
; 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 {{tl|ffdc}} template in this field.
=== Details ===
; 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 (computing)|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==
{{TemplateDataHeader}}
<templatedata>
{
"description": "{{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.",
"params": {
"name": {
"label": "Name",
"description": "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.",
"type": "string",
"default": "{{PAGENAME}}",
"required": true,
"suggested": true
},
"bodystyle": {
"label": "Body style (CSS)",
"description": "CSS styling for the infobox as a whole",
"type": "unbalanced-wikitext"
},
"os": {
"label": "Operating system (OS)",
"description": "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\".",
"type": "wiki-page-name",
"suggested": true
},
"logo": {
"label": "Icon (or logo)",
"description": "The computer icon associated with the component. e.g. \"Paint Windows 7 icon.png\"",
"type": "wiki-file-name",
"suggested": true
},
"logo_size": {
"label": "Icon (or logo) size",
"description": "Size of the logo. Any valid CSS size value is acceptable. Use of this parameter is discouraged.",
"type": "string",
"default": "64px"
},
"logo caption": {
"label": "Icon (or logo) caption",
"description": "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}}.",
"type": "unbalanced-wikitext"
},
"screenshot": {
"label": "Screenshot",
"description": "File name for a screenshot of the image",
"type": "wiki-file-name",
"suggested": true
},
"screenshot_size": {
"label": "Screenshot size",
"description": "Size of the screenshot. Any valid CSS size value is acceptable. Default is 300px. Use of this parameter is not recommended.",
"type": "string"
},
"caption": {
"label": "Screenshot caption",
"description": "Caption for the screenshot. Inclusion is highly recommended.",
"type": "string",
"suggested": true
},
"other_names": {
"label": "Other name",
"description": "Old name or alternative popular names",
"type": "string"
},
"type": {
"label": "Type or genre",
"description": "Type of program. Should be wikilinked to an article such as '[[Geographic information system]]'. For more information, consult [[Category:List of software categories]].",
"type": "string",
"suggested": true
},
"included_with": {
"label": "Included with",
"description": "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.",
"type": "string",
"suggested": true
},
"replaces": {
"label": "Replaces...",
"description": "Name of components that were deprecated in favor of this one.",
"type": "string",
"suggested": true
},
"replaced_by": {
"label": "Replaced by...",
"description": "Name of the component(s) that deprecated the subject of this article.",
"type": "string",
"suggested": true
},
"service_name": {
"label": "Service/daemon name",
"description": "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.",
"type": "string"
},
"service_description": {
"label": "Service description",
"description": "Official service description, if a service name is specified.",
"type": "string"
},
"also_available_for": {
"label": "Also available for",
"description": "A list of operating systems for which this component may be downloaded as an update.",
"type": "string",
"suggested": true
},
"support_status": {
"label": "Support status",
"description": "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.",
"type": "unbalanced-wikitext"
},
"related_components": {
"label": "Related components",
"description": "List of components closely related to this component.",
"type": "string",
"suggested": true
}
},
"paramOrder": [
"name",
"logo",
"logo_size",
"logo caption",
"screenshot",
"screenshot_size",
"caption",
"os",
"other_names",
"type",
"service_name",
"service_description",
"included_with",
"also_available_for",
"replaces",
"replaced_by",
"support_status",
"related_components",
"bodystyle"
],
"format": "block"
}
</templatedata>
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Software infobox templates|Os Component]]
[[Category:Operating system templates]]
}}</includeonly>
