Difference between revisions of "Template:Infobox OS/doc"
imported>Netoholic (corrected params) |
imported>Netoholic |
||
| Line 55: | Line 55: | ||
<templatedata> | <templatedata> | ||
{ | { | ||
| − | + | "description": "This template can be used to provide a summary for articles on computer [[operating system]]s.", | |
| − | + | "params": { | |
| − | + | "name": { | |
| − | + | "label": "Name", | |
| − | + | "description": "The name of the operating system. This should match the name of the article. For example: 'Microsoft Windows'", | |
| − | + | "type": "string", | |
| − | + | "required": true | |
| − | + | }, | |
| − | + | "logo": { | |
| − | + | "label": "Logo", | |
| − | + | "description": "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'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "logo_size": { | |
| − | + | "label": "Logo size", | |
| − | + | "description": "A width for the image, including the 'px'; the default is '250px'. For example: '106px'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "logo_caption": { | |
| − | + | "label": "Logo caption", | |
| − | + | "description": "Icon to display in the title.", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "logo_alt": { | |
| − | + | "type": "string", | |
| − | + | "label": "Logo alt", | |
| − | + | "description": "An alternative text for the screenshot. For example: 'Fedora 8 logo'" | |
| − | + | }, | |
| − | + | "screenshot": { | |
| − | + | "label": "Screenshot", | |
| − | + | "description": "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. Also, per [[Wikipedia:Avoid self-references]], no references to Wikipedia should be visible. For example: 'File:MacOS81 screenshot.png'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "screenshot_size": { | |
| − | + | "label": "Screenshot size", | |
| − | + | "description": "A width for the screenshot, including the 'px'; the default is '290px'. For example: '200px'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "screenshot_alt": { | |
| − | + | "label": "Screenshot alt", | |
| − | + | "description": "An alternative text for the screenshot. For example: 'Fedora 8 desktop'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "caption": { | |
| − | + | "label": "Screenshot caption", | |
| − | + | "description": "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 Mac OS 8.1 desktop'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "developer": { | |
| − | + | "label": "Developer", | |
| − | + | "description": "Name of the current developer of the software product. It can be either an individual or an organization/business. For example: 'Microsoft'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "website": { | |
| − | + | "label": "Website", | |
| − | + | "description": "Use the template {{URL|www.website.zzz}}", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "marketing_target": { | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "family": { | |
| − | + | "type": "string/wiki-page-name" | |
| − | + | }, | |
| − | + | "working_state": { | |
| − | + | "label": "Working state", | |
| − | + | "description": "Working state of the operating system. Can be 'Current', 'Discontinued', or 'No longer supported'", | |
| − | + | "type": "string", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "supported_platforms": { | |
| − | + | "type": "string/wiki-page-name" | |
| − | + | }, | |
| − | + | "source_model": { | |
| − | + | "label": "Source model", | |
| − | + | "description": "Source model of the operating system. Can be 'Open source', 'Closed source', or 'Shared source'", | |
| − | + | "type": "string/wiki-page-name", | |
| − | + | "required": false | |
| − | + | }, | |
| − | + | "programmed_in": { | |
| − | + | "label": "Programmed in", | |
| − | + | "description": "Computer language used", | |
| − | + | "type": "string/wiki-page-name" | |
| − | + | }, | |
| − | + | "license": { | |
| − | + | "type": "string/wiki-page-name" | |
| + | }, | ||
| + | "kernel_type": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "ui": { | ||
| + | "label": "User interface", | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "userland": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "update_method": { | ||
| + | "label": "Patch process or system", | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "package_manager": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "influenced": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "influences": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "version_of": { | ||
| + | "description": "When the OS is part of a series of successive releases: ex. [[Microsoft Windows]]", | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "preceded_by": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "succeeded_by": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "RTM_date": { | ||
| + | "label": "Release to manufacturing date (\"going gold\")", | ||
| + | "description": "use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref>", | ||
| + | "type": "date" | ||
| + | }, | ||
| + | "release_date": { | ||
| + | "label": "General release date", | ||
| + | "description": "use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref>", | ||
| + | "type": "date" | ||
| + | }, | ||
| + | "discontinued": { | ||
| + | "description": "Set YES if discontinued, leave blank otherwise" | ||
| + | }, | ||
| + | "latest_release_version": { | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "latest_release_date": { | ||
| + | "description": "use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref>", | ||
| + | "type": "date" | ||
| + | }, | ||
| + | "latest_preview_version": { | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "latest_preview_date": { | ||
| + | "description": "use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref>", | ||
| + | "type": "date" | ||
| + | }, | ||
| + | "support_status": { | ||
| + | "description": "use {{End date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref>", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "other_articles": { | ||
| + | "type": "string/wiki-page-name" | ||
| + | }, | ||
| + | "collapsible": { | ||
| + | "label": "Collapsible", | ||
| + | "description": "If the screenshot is too big, this parameter set to 'yes' will collapse this.", | ||
| + | "type": "string", | ||
| + | "required": false | ||
| + | }, | ||
| + | "bodystyle": { | ||
| + | "type": "string", | ||
| + | "label": "bodystyle", | ||
| + | "description": "Advanced use only." | ||
| + | } | ||
| + | } | ||
} | } | ||
</templatedata> | </templatedata> | ||
| − | |||
=== Notes === | === Notes === | ||
For information about the parameters in this template, see [[Template:Infobox software/doc]]. A number of elements of this template, however, need further explanation: | For information about the parameters in this template, see [[Template:Infobox software/doc]]. A number of elements of this template, however, need further explanation: | ||
| Line 162: | Line 241: | ||
== Example == | == Example == | ||
| + | <pre style="overflow:auto;"> | ||
{{Infobox OS | {{Infobox OS | ||
| name = Debian | | name = Debian | ||
| Line 167: | Line 247: | ||
| logo_size = x64px | | logo_size = x64px | ||
| screenshot = Debian Etch-ja.png | | screenshot = Debian Etch-ja.png | ||
| − | |||
| developer = Debian Project | | developer = Debian Project | ||
| family = [[Unix-like]] | | family = [[Unix-like]] | ||
| − | | | + | | working_state = Current |
| − | | | + | | source_model = [[Open source]] |
| released = {{Start date|df=yes|1993|08|16}} | | released = {{Start date|df=yes|1993|08|16}} | ||
| − | | | + | | latest_release_version = 4.0r2 Etch |
| − | | | + | | latest_release_date = {{start date and age|2007|12|27}} |
| − | | | + | | kernel_type = [[monolithic kernel|Monolithic]] ([[Linux kernel|Linux]], [[FreeBSD]]), [[microkernel|Micro]] ([[GNU Hurd|Hurd]]) |
| userland = [[GNU Core Utilities|GNU]] | | userland = [[GNU Core Utilities|GNU]] | ||
| ui = [[GNOME]], [[KDE]], [[Xfce]], and [[LXDE]] | | ui = [[GNOME]], [[KDE]], [[Xfce]], and [[LXDE]] | ||
| license = [[Free software]], mainly the [[GNU GPL]], and other licenses<ref>{{cite web|url=http://www.debian.org/legal/licenses/|title=License information|publisher=Debian|accessdate=2009-02-28}}</ref> | | license = [[Free software]], mainly the [[GNU GPL]], and other licenses<ref>{{cite web|url=http://www.debian.org/legal/licenses/|title=License information|publisher=Debian|accessdate=2009-02-28}}</ref> | ||
| supported platforms = [[IA-32|i386 (x86)]], [[x86-64|amd64 (x86-64)]], [[PowerPC]], [[SPARC]], [[DEC Alpha]], [[ARM architecture|ARM]], [[MIPS architecture|MIPS]], [[PA-RISC family|HPPA]], [[IBM eServer zSeries|S390]], [[IA-64]] | | supported platforms = [[IA-32|i386 (x86)]], [[x86-64|amd64 (x86-64)]], [[PowerPC]], [[SPARC]], [[DEC Alpha]], [[ARM architecture|ARM]], [[MIPS architecture|MIPS]], [[PA-RISC family|HPPA]], [[IBM eServer zSeries|S390]], [[IA-64]] | ||
| − | | | + | | update_method = [[Advanced Packaging Tool|APT]] (several front-ends available) |
| − | | | + | | package_manager = [[dpkg]] |
| website = {{URL|www.debian.org}} | | website = {{URL|www.debian.org}} | ||
}} | }} | ||
| + | </pre> | ||
{{Hatnote|This infobox is just an example, and it isn't supposed to reflect the present state of this particular piece of software, or even make any sense. It is only shown to demonstrate the effect of the options.}} | {{Hatnote|This infobox is just an example, and it isn't supposed to reflect the present state of this particular piece of software, or even make any sense. It is only shown to demonstrate the effect of the options.}} | ||
<pre style="overflow:auto;"> | <pre style="overflow:auto;"> | ||
| Line 193: | Line 273: | ||
| developer = Debian Project | | developer = Debian Project | ||
| family = [[Unix-like]] | | family = [[Unix-like]] | ||
| − | | | + | | working_state = Current |
| − | | | + | | source_model = [[Open source]] |
| released = {{Start date|df=yes|1993|08|16}} | | released = {{Start date|df=yes|1993|08|16}} | ||
| − | | | + | | latest_release_version = 4.0r2 Etch |
| − | | | + | | latest_release_date = {{start date and age|2007|12|27}} |
| − | | | + | | kernel_type = [[monolithic kernel|Monolithic]] ([[Linux kernel|Linux]], [[FreeBSD]]), [[microkernel|Micro]] ([[GNU Hurd|Hurd]]) |
| userland = [[GNU Core Utilities|GNU]] | | userland = [[GNU Core Utilities|GNU]] | ||
| ui = [[GNOME]], [[KDE]], [[Xfce]], and [[LXDE]] | | ui = [[GNOME]], [[KDE]], [[Xfce]], and [[LXDE]] | ||
| license = [[Free software]], mainly the [[GNU GPL]], and other licenses<ref>{{cite web|url=http://www.debian.org/legal/licenses/|title=License information|publisher=Debian|accessdate=2009-02-28}}</ref> | | license = [[Free software]], mainly the [[GNU GPL]], and other licenses<ref>{{cite web|url=http://www.debian.org/legal/licenses/|title=License information|publisher=Debian|accessdate=2009-02-28}}</ref> | ||
| supported platforms = [[IA-32|i386 (x86)]], [[x86-64|amd64 (x86-64)]], [[PowerPC]], [[SPARC]], [[DEC Alpha]], [[ARM architecture|ARM]], [[MIPS architecture|MIPS]], [[PA-RISC family|HPPA]], [[IBM eServer zSeries|S390]], [[IA-64]] | | supported platforms = [[IA-32|i386 (x86)]], [[x86-64|amd64 (x86-64)]], [[PowerPC]], [[SPARC]], [[DEC Alpha]], [[ARM architecture|ARM]], [[MIPS architecture|MIPS]], [[PA-RISC family|HPPA]], [[IBM eServer zSeries|S390]], [[IA-64]] | ||
| − | | | + | | update_method = [[Advanced Packaging Tool|APT]] (several front-ends available) |
| − | | | + | | package_manager = [[dpkg]] |
| website = {{URL|www.debian.org}} | | website = {{URL|www.debian.org}} | ||
}} | }} | ||
Revision as of 04:46, 11 July 2014
| This is a documentation subpage for Template:Infobox OS. It contains usage information, categories and other content that is not part of the original template page. |
This template can be used to provide a summary for articles on computer operating systems.
Usage
{{Infobox OS
| name = <!-- Name of program or distribution -->
| logo = <!-- Image name is enough -->
| logo_caption =
| logo_size =
| logo_alt =
| screenshot = <!-- Image name is enough -->
| caption =
| screenshot_size =
| screenshot_alt =
| developer = <!-- Name of main developer or sponsor-->
| website = <!-- {{URL|www.example.org}} -->
| marketing_target =
| language = <!-- Supported human languages (English, French, Italian, Arabic, ...) -->
| working_state = <!-- "Current", "Discontinued", or "No longer supported" -->
| supported_platforms = <!-- IA-32, x64, Itanium, ARM, etc. -->
| programmed_in = <!-- programming language -->
| source_model = <!-- "Open source", "Closed source", or "Shared source" -->
| license = <!-- "GPL", etc. -->
| updatemodel = <!-- APT, Windows Update, etc. -->
| package_manager = <!-- dpkg, rpm, Windows installer, etc. -->
| kernel_type = <!-- Hybrid, Monolithic, Microkernel, Exokernel, Nanokernel, etc. -->
| ui =
| userland =
| influenced =
| influenced_by =
| version_of = <!-- Series to which a version release belongs - ex. "Microsoft Windows" -->
| family = <!-- ex. "Unix-like", "x86" -->
| preceded_by =
| succeeded_by =
| discontinued = <!-- yes if discontinued, leave blank if not -->
| RTM_date = <!-- {{Start date|YYYY|MM|DD|df=yes/no}}<ref></ref> -->
| release_date = <!-- {{Start date|YYYY|MM|DD|df=yes/no}}<ref></ref> -->
| latest_release_version =
| latest_release_date = <!-- {{Start date|YYYY|MM|DD|df=yes/no}}<ref></ref> -->
| latest_preview_version =
| latest_preview_date = <!-- {{Start date|YYYY|MM|DD|df=yes/no}}<ref></ref> -->
| support_status =
| other_articles =
}}
;Advanced use only
| collapsible = <!-- set to yes to hide screenshot by default -->
| bodystyle =
Parameters
TemplateData for Infobox OS
This template can be used to provide a summary for articles on computer [[operating system]]s.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | The name of the operating system. This should match the name of the article. For example: 'Microsoft Windows' | String | required |
| Logo | logo | 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' | String | optional |
| Logo size | logo_size | A width for the image, including the 'px'; the default is '250px'. For example: '106px' | String | optional |
| Logo caption | logo_caption | Icon to display in the title. | String | optional |
| Logo alt | logo_alt | An alternative text for the screenshot. For example: 'Fedora 8 logo' | String | optional |
| Screenshot | screenshot | 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. Also, per [[Wikipedia:Avoid self-references]], no references to Wikipedia should be visible. For example: 'File:MacOS81 screenshot.png' | String | optional |
| Screenshot size | screenshot_size | A width for the screenshot, including the 'px'; the default is '290px'. For example: '200px' | String | optional |
| Screenshot alt | screenshot_alt | An alternative text for the screenshot. For example: 'Fedora 8 desktop' | String | optional |
| Screenshot caption | caption | 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 Mac OS 8.1 desktop' | String | optional |
| Developer | developer | Name of the current developer of the software product. It can be either an individual or an organization/business. For example: 'Microsoft' | String | optional |
| Website | website | Use the template {{URL|www.website.zzz}} | String | optional |
| Marketing_target | marketing_target | no description | String | optional |
| Family | family | no description | Page | optional |
| Working state | working_state | Working state of the operating system. Can be 'Current', 'Discontinued', or 'No longer supported' | String | optional |
| Supported_platforms | supported_platforms | no description | Page | optional |
| Source model | source_model | Source model of the operating system. Can be 'Open source', 'Closed source', or 'Shared source' | Page | optional |
| Programmed in | programmed_in | Computer language used | Page | optional |
| License | license | no description | Page | optional |
| Kernel_type | kernel_type | no description | Page | optional |
| User interface | ui | no description | Page | optional |
| Userland | userland | no description | Page | optional |
| Patch process or system | update_method | no description | Page | optional |
| Package_manager | package_manager | no description | Page | optional |
| Influenced | influenced | no description | Page | optional |
| Influences | influences | no description | Page | optional |
| Version_of | version_of | When the OS is part of a series of successive releases: ex. [[Microsoft Windows]] | Page | optional |
| Preceded_by | preceded_by | no description | Page | optional |
| Succeeded_by | succeeded_by | no description | Page | optional |
| Release to manufacturing date ("going gold") | RTM_date | use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref> | Date | optional |
| General release date | release_date | use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref> | Date | optional |
| Discontinued | discontinued | Set YES if discontinued, leave blank otherwise | Unknown | optional |
| Latest_release_version | latest_release_version | no description | String | optional |
| Latest_release_date | latest_release_date | use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref> | Date | optional |
| Latest_preview_version | latest_preview_version | no description | String | optional |
| Latest_preview_date | latest_preview_date | use {{Start date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref> | Date | optional |
| Support_status | support_status | use {{End date|YYYY|MM|DD}} and <ref>{{cite web|url=http://page.zzz}}</ref> | String | optional |
| Other_articles | other_articles | no description | Page | optional |
| Collapsible | collapsible | If the screenshot is too big, this parameter set to 'yes' will collapse this. | String | optional |
| bodystyle | bodystyle | Advanced use only. | String | optional |
Notes
For information about the parameters in this template, see Template:Infobox software/doc. A number of elements of this template, however, need further explanation:
Family - This is the operating system family, examples include Microsoft Windows, Unix-like and Mac OS. Linux and Mac OS X are not OS families.
Source model - This field is should usually have "Open source" or "Closed source". 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.
Kernel type - For Linux distros, this should be [[Linux kernel|Linux]]. It should not be the name of a distro.
Example
{{Infobox OS
| name = Debian
| logo = Debian-OpenLogo.svg
| logo_size = x64px
| screenshot = Debian Etch-ja.png
| developer = Debian Project
| family = [[Unix-like]]
| working_state = Current
| source_model = [[Open source]]
| released = {{Start date|df=yes|1993|08|16}}
| latest_release_version = 4.0r2 Etch
| latest_release_date = {{start date and age|2007|12|27}}
| kernel_type = [[monolithic kernel|Monolithic]] ([[Linux kernel|Linux]], [[FreeBSD]]), [[microkernel|Micro]] ([[GNU Hurd|Hurd]])
| userland = [[GNU Core Utilities|GNU]]
| ui = [[GNOME]], [[KDE]], [[Xfce]], and [[LXDE]]
| license = [[Free software]], mainly the [[GNU GPL]], and other licenses<ref>{{cite web|url=http://www.debian.org/legal/licenses/|title=License information|publisher=Debian|accessdate=2009-02-28}}</ref>
| supported platforms = [[IA-32|i386 (x86)]], [[x86-64|amd64 (x86-64)]], [[PowerPC]], [[SPARC]], [[DEC Alpha]], [[ARM architecture|ARM]], [[MIPS architecture|MIPS]], [[PA-RISC family|HPPA]], [[IBM eServer zSeries|S390]], [[IA-64]]
| update_method = [[Advanced Packaging Tool|APT]] (several front-ends available)
| package_manager = [[dpkg]]
| website = {{URL|www.debian.org}}
}}
{{Infobox OS
| name = Debian
| logo = Debian-OpenLogo.svg
| logo_size = x64px
| screenshot = Debian Etch-ja.png
| developer = Debian Project
| family = [[Unix-like]]
| working_state = Current
| source_model = [[Open source]]
| released = {{Start date|df=yes|1993|08|16}}
| latest_release_version = 4.0r2 Etch
| latest_release_date = {{start date and age|2007|12|27}}
| kernel_type = [[monolithic kernel|Monolithic]] ([[Linux kernel|Linux]], [[FreeBSD]]), [[microkernel|Micro]] ([[GNU Hurd|Hurd]])
| userland = [[GNU Core Utilities|GNU]]
| ui = [[GNOME]], [[KDE]], [[Xfce]], and [[LXDE]]
| license = [[Free software]], mainly the [[GNU GPL]], and other licenses<ref>{{cite web|url=http://www.debian.org/legal/licenses/|title=License information|publisher=Debian|accessdate=2009-02-28}}</ref>
| supported platforms = [[IA-32|i386 (x86)]], [[x86-64|amd64 (x86-64)]], [[PowerPC]], [[SPARC]], [[DEC Alpha]], [[ARM architecture|ARM]], [[MIPS architecture|MIPS]], [[PA-RISC family|HPPA]], [[IBM eServer zSeries|S390]], [[IA-64]]
| update_method = [[Advanced Packaging Tool|APT]] (several front-ends available)
| package_manager = [[dpkg]]
| website = {{URL|www.debian.org}}
}}
See also
- {{Infobox software}}
- {{Infobox OS version}}