Template:Infobox software/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
← Older editNewer edit →
Ned Scott (talk | contribs)
15,105 edits
Ned Scott (talk | contribs)
15,105 edits
Line 33: Line 33:
</pre>
</pre>
{{-}}
{{-}}
== Parameters ==
All parameters are optional.
; name: Name of the infobox. Usually, it is used to display the name of the software product, but may be anything, as it used as an internal parameter for use with <code>frequently updated</code> parameter, and "Stable release" / "Preview release" fields. When modifying an article which already has an infobox, be careful not to edit this parameter when <code>frequently updated</code> parameter is set to ''yes''. In such cases, if you want to edit the title at the top of the infobox, use the <code>title</code> parameter instead.
:'''ATTENTION:''' Please do not include a [[Help:Link#Wikilinks|wikilink]], [[hyperlink]] or image in this parameter. This parameter should be composed of pure text.
; title: Name of the software product 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 reader]]s.
; logo: Code for a small image to be displayed as software product's [[logo]] or [[computer icon]]. The contents of this field should look like:
::<tt>&#91;&#91;File:''File name.ext''{{!}}''Size''px&#93;&#93;</tt>
: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 product's [[screenshot]]. The contents of this field should look like:
::<tt>&#91;&#91;File:''File name.ext''{{!}}''Size''px&#93;&#93;</tt>
: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. Please include this parameter only when there is an image to display.
; collapsible: Whether this screenshot is by default hidden and is only shown when user clicks on a minuscule "Expand" button. 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 product. It can be either an individual or an organization/business.
; author: Name of the original author or publisher of the software product. It can be either an individual or an organization/business. Most of the times, it only needs to be specified when <code>developer</code> field is populated.
; released: The date in which version 1.0 (or closely-matching release) of the software product in question reaches its [[release to manufacturing]] (RTM) stage. In case the article is about a specific major release of a software product (for instance [[Internet Explorer 8]] or [[Microsoft Office 2007]]), this field should contain the date in which that specific major release reached RTM stage. In case the software product is still in development and has not reached its RTM stage, please ignore this field; do not use this field to specify the release date of the first preview/test release of the software product; there is already another parameter for that use.
:The content of this field should look like the following:
::{{tlx|Start date and age|''year''|''month''|''day''}}
:In case the article uses DMY as date format, use this code instead:
::{{tlx|Start date and age|''year''|''month''|''day''|df&#61;yes}}
:If you are unsure which date format to use, please consult [[WP:MOSDATES]].
; latest release version: The version number of the latest release of the software product. 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
: Example #4: If the article is about ''Famous Example Software 2010'' for which no update is released since its initial release-to-manufacturing (RTM), please omit this parameter unless there is an evidence that it is necessary for the reader to know this number. One reason would be the presence of preview releases of the software product which can only be distinguished from the RTM by their version number.
:This parameter and <code>latest release date</code> complement each other but none strictly requires the other.
; latest release date: The release date of the latest released version. If no update is released for the software since its initial release, please omit this field; filling in the <code>released</code> field would be enough. The content of this field should look like the following:
::{{tlx|Start date and age|''year''|''month''|''day''}}
:In case the article uses DMY as date format, use this code instead:
::{{tlx|Start date and age|''year''|''month''|''day''|df&#61;yes}}
:If you are unsure which date format to use, please consult [[WP:MOSDATES]].
:This parameter and <code>latest release version</code> complement each other but none strictly requires the presence of the other.
; discontinued: 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", "no" or anything else. To nullify the effect of this parameter, you need to omit it.
; latest preview version: The version number of the latest preview version or development branch. Should only be specified when development of a new version of the software product in question (newer than one specified in <code>latest release version</code>) is in progress. Please consult descriptions for <code>latest release version</code> 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 the software product in question (newer than one specified in <code>latest release version</code>) is in progress. Please consult descriptions for <code>latest release date</code> provided above for best practices of specifying this parameter.
; frequently updated: Specifies whether 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. This mode is very useful for articles about software products whose vendors keep releasing updates or newer versions. With this mode is enabled, users can quickly and effectively edit the release data without editing the article proper (and cluttering its edit history with inconsequential edits).
:For technical reasons, anything for this parameter has the same effect, be it "yes", "no", "true", "false" 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 explicitly specified <code>latest release version</code> or <code>latest preview version</code> parameters are specified, the corresponding external source will be ignored.  (This can be useful if the preview version is frequently updated, but the release version is not.)
:To make the infobox retrieve release data from outside the article:
#Create an external source that supplies data for latest stable release. To do so:
##Copy and paste the following URL into your browser's address bar, replacing ''INFOBOX_NAME'' with the value supplied in <code>name</code> parameter of the infobox: <br/><span class="plainlinks"><code>{{fullurl:Template:Latest stable software release/INFOBOX_NAME|action=edit&preload=Template:LSR/syntax}}</code></span>
##In the page that opens, fill in the required information.
##Save the page.
#Create an external source that supplies data for latest preview release. To do so:
##Copy and paste the following URL into your browser's address bar, replacing ''INFOBOX_NAME'' with the value suppplied in <code>name</code> parameter of the infobox: <br/><span class="plainlinks"><code>{{fullurl:Template:Latest preview software release/INFOBOX_NAME|action=edit&preload=Template:LPR/syntax}}</code></span>
##In the page that opens, fill in the required information.
##Save the page.
#In the main article, add <code>frequently updated=yes</code> to the infobox, and delete any <code>latest release version</code>, <code>latest release date</code>, <code>latest preview version</code> or <code>latest preview date</code> parameters.
#Save the article.
#Refresh the article.
; programming language: 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: <code><nowiki>[[C++]] and [[C Sharp (programming language)|C#]]</nowiki></code>
::Result: [[C++]] and [[C Sharp (programming language)|C#]]
:When specifying the name of the programming language please make sure that you [[WP:V|cite your source]]. Unreferenced assertions in Wikipedia may be challenged or removed. If you do not have a source, do not include this parameter.
; operating system: The [[operating system]] on which the given software product works. Please be as accurate as possible in specifying this parameter (but also be mindful of the length) and avoid specifying vague phrases such as [[Cross-platform]] (or its redirect, [[Multi-platform]]). Please consider these examples:
:*If the software product works on all incarnations of [[Unix]], [[Linux]] and derived operating systems, please specify:
:**<code><nowiki>[[Unix-like]]</nowiki></code>
:*If the software works unconditionally on ALL incarnations of [[Microsoft Windows]], please specify:
:**<code><nowiki>[[Microsoft Windows]]</nowiki></code><br/>(Do not specify <code><nowiki>[[Microsoft Windows|Windows]]</nowiki></code>; always write the full name of a registered trademark when no length restriction is imposed upon you.)
:*If the software product works only on [[Windows XP]] and all subsequent releases of Microsoft Windows, please specify:
:**<code><nowiki>[[Windows XP]] and later</nowiki></code>
:*If the software product works only on [[Windows XP]] and all subsequent releases of consumers versions of Microsoft Windows, please specify:
:**<code><nowiki>[[Windows XP]], [[Windows Vista]] and [[Windows 7]]</nowiki></code><br/>(At the time of this writing, August 2010, Windows 7 was the latest consumers release of Microsoft Windows.)
:*If the software product is released for various families of different operating systems, (such as specific versions of BSD, Linux, Mac OS and Microsoft Windows) so that listing them in the infobox gives it undue length, please leave the details to article body and specify:
:**<code><nowiki>[[BSD]], [[Linux]], [[Mac OS]] and [[Microsoft Windows]]</nowiki></code>
:*If the software is an operating system–independent [[web application]], ignore this parameter.
; platform: The [[computing platform]] on which the product runs. You might like to include the following information:
:*'''Processor architecture:''' Some software products run on a certain processor architecture such as [[IA-32]] (also known as ''x86'' an ''i386''), [[x86-64]] (also known as ''x64'', ''AMD64'' and ''EM64T''), [[Itanium]], [[ARM]] and [[MIPS]]. Please avoid common mistakes highlighted in {{section link|Wikipedia:Manual of Style/Computing|Avoid common mistakes}}.
:*'''Software frameworks:''' Some software products run on [[Java platform]], [[.NET Framework]], [[Adobe Flash]], [[Adobe AIR]], [[Microsoft Silverlight]] or [[XUL]] without regard to the processor architecture. If so, you may ignore processor architecture and instead specify the framework.
:Please avoid specifying vague phrases such as "[[cross-platform]]" unless the following conditions meet:
:#The software product has been released for numerous different platforms, so much so that including all of them causes the infobox size to grow unduly large.
:#The article body lists the platforms under which the product runs.
:If the above do not meet, then specifying such a vague phrase is the same as not specifying it.
; size: Size of the installer package. Only applies to software products that are available via download. For products distributed physically in boxes or other packages, ignore this parameter. Do not forget to include your unit of measurements (i.e. Kilobytes, megabytes or gigabytes).
:'''Note:''' Use a [[non-breaking space]] ("&#x26;nbsp&#x3B;") to prevent numbers and units of measurements from separating when "[[word wrapping]]" occurs. You can also use {{tl|Nowrap}} template to produce the same effect.
:Observe the following examples:
:{|
|-
| width = "50%" |
*<tt><nowiki>760&#x26;nbsp&#x3B;[[Kilobyte|KB]]</nowiki></tt> → 760&nbsp;[[Kilobyte|KB]]
*<tt><nowiki>32&#x26;nbsp&#x3B;[[Megabyte|MB]]</nowiki></tt> → 32&nbsp;[[Megabyte|MB]]
| width = "50%" |
*<tt><nowiki>{{Nowrap|842 [[Kilobyte|KB]]}}</nowiki></tt> → {{Nowrap|842 [[Kilobyte|KB]]}}
*<tt><nowiki>{{Nowrap|48.5 [[Megabyte|MB]]}}</nowiki></tt> → {{Nowrap|48.5 [[Megabyte|MB]]}}
|}
:For more information, visit [[WP:UNITS]]
; language: Lists the Natural languages in which the software product user interface can interact with user. Please do not supply "Multilingual" or such vague phrases which do not add to the knowledge of the reader. When the list of languages is huge AND when those languages are listed in the article body, please specify number of the supported languages instead. Also please do not wikilink the name of languages: Readers are most likely unwilling to read about those languages. For a comprehensive list of items that should not be generally linked to, see {{Section link|Wikipedia:Manual of Style/Linking|What generally should not be linked}}.
; status: The development status of the computer program, such as: Planned, Active, Unmaintained, Discontinued, Stalled or [[Abandonware]]
; genre: Type of program.  Should be wikilinked to an article such as [[Geographic information system]]. For more information, consult [[List of software categories]]. Please do not use this field to briefly describe the role and function of the subject of the article. For example, instead of "SVG creator, editor and converter", consider using "[[Vector graphics editor]]". Instead of "PDF creator, editor, converter and viewer", consider using "[[Desktop publishing software]]". Instead of "DWG creator/editor", consider using "[[Computer-aided design]]".
; license: Type of the software license under which the consumer is allowed to use the product. You may specify it in two forms:
:*You may specify a type of well-known license. For example:
:**[[Proprietary software|Proprietary]] [[commercial software]] (<code><nowiki>[[Proprietary software|Proprietary]] [[commercial software]]</nowiki></code>): Software products which are licensed for use for a price. Most software today are published under this license type. (As in this example, please be sure to link to <code><nowiki>[[Proprietary software]]</nowiki></code>, which is an article about this type of software, and ''not'' to <code><nowiki>[[Proprietary]]</nowiki></code>, which is a disambiguation page.)
:**[[Freeware]]: Software products which are licensed for use (and sometimes redistribution) but free of charge.
:**[[Free software]]: Software products that can be used, studied, and modified without restriction, and which can be copied and redistributed in modified or unmodified form.
:*You may specify a well-known licensing scheme, such as:
:**[[GNU General Public License]]
:**[[GNU Lesser General Public License]]
:**[[BSD License]]
:Please avoid specifying phrases that makes no sense to the reader such as "Microsoft EULA", "Adobe End-User License Agreement" or "Symantec Terms of License", etc. (Always bear in mind that you are writing the article for those who do not know about the subject and come to the article to gain knowledge. You are not writing Wikipedia articles for your fellow co-editors who already know!)
;licence: Same as <code>license</code>. 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.
;alexa: The website's current [[Alexa Internet|Alexa]] ranking (find on [http://www.alexa.com/ Alexa.com]; make sure to cite Alexa's page for this info.)
; website: The web site URL of the software package. This URL must be readable in print. Therefore, you should use {{tl|URL}} template like this: "<code><nowiki>{{URL|http://www.example.com}}</nowiki></code>". Avoid using printer-hostile forms like "<code><nowiki>[http://www.example.com Example website]</nowiki></code>".
<noinclude>[[Category:Templates]]</noinclude>

Revision as of 06:29, 22 March 2012


Usage

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


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