Template:Infobox software/doc

From Official Kodi Wiki
< Template:Infobox software
Revision as of 02:07, 26 August 2010 by >[email protected] (→‎Parameters: Overhauled this part of documentation -- Stopped midway. Resuming later.)
Jump to navigation Jump to search


Usage

{{Infobox software
| name                   = 
| title                  = 
| logo                   = <!-- [[File: ]] -->
| screenshot             = <!-- [[File: ]] -->
| caption                = 
| collapsible            = 
| author                 = 
| developer              = 
| released               = <!-- {{Start date|YYYY|MM|DD}} -->
| discontinued           = 
| latest release version = 
| latest release date    = <!-- {{Start date and age|YYYY|MM|DD}} -->
| latest preview version = 
| latest preview date    = <!-- {{Start date and age|YYYY|MM|DD}} -->
| frequently updated     = <!-- DO NOT include this parameter unless you know what it does -->
| programming language   = 
| operating system       = 
| platform               = 
| size                   = 
| language               = 
| status                 = 
| genre                  = 
| license                = 
| website                = [http://www.example.org/ www.example.org]
}}


Example

Example: Yoyodyne
Yoyo patent 1866.png
Yoyodyne v0.9 screenshot
Developer(s) Yoyodyne Industries Inc.
Initial release Template:Start date
OS Unix-like
Size 25MB
Type Yoyonics
License GNU General Public License
Website www.example.org
{{Infobox software
| name                   = Example: Yoyodyne
| logo                   = 
| screenshot             = [[File:Yoyo patent 1866.png|200px]]
| caption                = Yoyodyne v0.9 screenshot
| developer              = Yoyodyne Industries Inc.
| released               = {{Start date|1911}}
| latest release version = 0.9
| latest release date    = {{Start date and age|2006|01|01}}
| latest preview version = 
| latest preview date    = 
| operating system       = [[Unix-like]]
| size                   = 25MB
| genre                  = Yoyonics
| license                = [[GNU General Public License]]
| website                = [http://www.example.org/ www.example.org]
}}

Parameters

All parameters are optional.

name
Name of the software application. Also used as an internal parameter for use with frequently updated parameter, and “Stable release” / “Preview release” fields. When modifying this parameter, be careful not to edit it when frequently updated parameter is set to yes. In such cases, if you want to edit the title at the top of the infobox, use the title parameter instead.
ATTENTION: Please do not include a wikilink, hyperlink or image in this parameter. This parameter should be composed of pure text.
title
Software application name as displayed above the infobox. When not specified, contents of name parameter will be displayed instead.
Important note: Please do not include an image in this field. Wikipedia accessibility requirements mandates that this field should contain text that can be read by screen readers.
logo
Code for an image to be displayed as software application's logo or computer icon. The contents of this field should look like:
[[File:File name.ext|Sizepx]]
Replace Filename.ext with the name of your image and Size with width of your image in pixels. For more information regarding use of images and their syntax, please consult: Help:Contents/Images and media
screenshot
Code for an image to be displayed as software application's screenshot. The contents of this field should look like:
[[File:File name.ext|Sizepx]]
Replace Filename.ext with the name of your image and Size with width of your image in pixels. For more information regarding use of images and their syntax, please consult: Help:Contents/Images and media
caption
A caption for screenshot that appears below it.
collapsible
Specifies whether this screenshot is by default hidden and is only shown when user clicks on "Expand". Can be set to "yes". Especially useful in case of long vertical screenshot (see QQ for example)
developer
Name of the current developer of the software application. It can be either an individual or an organization/business.
author
Name of the original author or publisher of the software application. It can be either an individual or an organization/business. Most of the times, it only needs to be specified when developer field is populated.
released
The release date of version 1.0 (or closely-matching release) the software application in question. In case the article is about a specific major release of a software applicaton (for instance Internet Explorer 8 or Microsoft Office 2008), this field should contain the release date of the first release (base release) of that specific major release. The content of this field should look like the following:
{{Start date and age|year|month|day}}
In case the article uses DMY as date format, use this code instead:
{{Start date and age|year|month|day}}
If you are unsure which date format to use, please consult WP:MOSDATES.
latest release version
Specifies the latest released version number or release number. Please observe the following examples:
Example #1: If the article is about a product called Example Software whose latest version is 1.5, specify:
v1.5
Example #2: If the article is about a product called Example Software whose latest release is called Example Software 2008 and whose latest version number is 12.2, specify:
2008 (v12.2)
Example #3: If the article is about Famous Example Software 2010, which is a significant release of a product called Famous Example Software and whose latest version number is 14.0.0.25, just specify:
v14.0.0.25
latest release date
Specifies the release date of the latest released version. The content of this field should look like the following:
{{Start date and age|year|month|day}}
In case the article uses DMY as date format, use this code instead:
{{Start date and age|year|month|day}}
If you are unsure which date format to use, please consult WP:MOSDATES.
discontinued
Specifies whether this product is no longer being developed, thus changing the phrase “Latest release” in the infobox to “Discontinued”. For technical reasons, anything for this parameter has the same effect, be it "yes" or "no" or anything else. To nullify the effect of this parameter, you need to omit it.
latest preview version
Specifies the version number of the latest preview version or development branch. Should only be specified when development of a new version of software product (newer than one specified in latest release version) is in progress. Please consult descriptions for latest release version provided above for best practices of specifying this parameter.
latest preview date
Specifies the release date of the latest preview version or development branch. Should only be specified when development of a new version of software product (newer than one specified in latest release version) is in progress. Please consult descriptions for latest release date provided above for best practices of specifying this parameter.
frequently updated
Specifies whether the Frequently Update mode for this infobox is enabled. In this mode, the infobox retrieves the software product's latest release version, latest release date, latest preview version and latest preview date from outside the article. Users visiting the article may click the numbers directly in the infobox to edit that external source.
Frequently Updated mode is useful for article about software products whose vendors keep releasing updates or newer versions. With this mode enabled, users can quickly and effectively edit the release data without affecting the article body.
For technical reasons, anything for this parameter has the same effect, be it "yes" or "no" or anything else. To nullify the effect of this parameter, you need to omit this parameter or specify nothing for it. Note however, that if any of latest release version, latest release date, latest preview version or latest preview date parameters are specified, external source will be ignored.
The external source of Frequently Updated mode is a subpage of Template:Latest preview software release and Template:Latest stable software release. The name of this subpage is same as the value of name parameter. (See above.) For more information, please visit those templates.
programming language
Specifies the programming language of that subject of the article. If the program language of the software product has a corresponding article in Wikipedia, please link to it. Here is an example:
Code: [[C++]] and [[C Sharp (programming language)|C#]]
Result: C++ and C#
When specifying the name of the programming language please make sure that you cite your source for this claim.


operating system
operating system. For Unix-like multi-OS programs use: Any Unix-like
platform
platform (Java, .NET). For multi-platform programs use: Cross-platform
size
in megabytes
language
natural language (English, French)
status
Should probably be one of: Planned, Active, Unmaintained, Discontinued, Abandonware
genre
Type of program. Probably wikilinked to an article such as Geographic information system. For more information, consult List of software categories.
license
License such as proprietary, [[GNU General Public License|GPL]]. Pick either license (American English) or licence (Commonwealth English), not both - select the one which matches the content of the article the template is used in.
website
Web site of software package.

Microformat

Template:UF-hcal

See also


Retrieved from "https://kodi.wiki/index.php?title=Template:Infobox_software/doc&oldid=49399"