Template:Infobox software/doc

From TechInfoDepot
Jump to navigationJump to search

Template:Uses WikidataTemplate:Tracks Wikidata

Usage

The following is the base code required to generate an infobox. One can copy and paste the base code into an article and insert relevant information in front of the "=" signs. Removing HTML comments ("<!--", "-->" and anything between these two) is optional. To avoid accidental misuse, this base code does not have a handful of parameters that must be handled with absolute care and are not normally needed, such as {{{bodystyle}}}. Template:Parameter names example 

{{Infobox software
| name                   = 
| logo                   = <!-- Image name is enough -->
| logo alt               = 
| logo caption           = 
| screenshot             = <!-- Image name is enough -->
| screenshot alt         = 
| caption                = 
| collapsible            = <!-- any text here will collapse the screenshot -->
| author                 = 
| developer              = 
| released               = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| discontinued           = <!-- no (default) or yes -->
| ver layout             = <!-- simple (default) or stacked -->
| 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}} -->
| status                 = 
| programming language   = 
| operating system       = 
| platform               = 
| size                   = 
| language               = 
| language count         = <!-- Number only -->
| language footnote      = 
| genre                  = 
| license                = 
| alexa                  = 
| website                = <!-- {{URL|example.org}} -->
| repo                   = <!-- {{URL|example.org}} -->
| standard               = 
| AsOf                   = 
}}

Example

The following markup is included only for illustration purposes. It is not intended to provide up-to-date information about GIMP software and should not be updated for the sake of truth.
GIMP
The GIMP icon - gnome.svg
GIMP-main window.png
GIMP version 2.6
Original author(s) Spencer Kimball, Peter Mattis
Developer(s) The GIMP Development Team
Initial release January 1996; 28 years ago (1996-01)
Stable release
2.6.12 / 6 February 2012; 12 years ago (2012-02-06)
Preview release
2.8.0 RC1 / 10 April 2012; 12 years ago (2012-04-10)
Repository git.gnome.org/browse/gimp/
Development status Active
Written in C and GTK+
Operating system Linux, OS X, Windows, FreeBSD, Solaris, AmigaOS 4
Size 19.96 MB
Available in 80 languages[1]
Template:Hidden beginAmharic, Arabic, Asturian, Azerbaijani, Basque, Belarusian, Bosnian, Brazilian Portuguese, Breton, British English, Bulgarian, Burmese, Canadian English, Catalan (Valencian), Catalan, Chinese (China), Chinese (Hong Kong), Chinese (Taiwan), Croatian, Czech, Danish, Dutch, Dzongkha, Esperanto, Estonian, Finnish, French, Galician, Georgian, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Irish, Italian, Japanese, Kannada, Kashubian, Kazakh, Khmer, Kinyarwanda, Kirghiz, Korean, Latvian, Lithuanian, Low German, Macedonian, Malay, Malayalam, Nepali, Norwegian Bokmål, Norwegian Nynorsk, Occitan, Persian, Polish, Portuguese, Punjabi, Romanian, Russian, Scottish Gaelic, Serbian, Serbian Latin, Sinhala, Slovak, Slovenian, Spanish, Swedish, Tamil, Tatar, Telugu, Thai, Turkish, Ukrainian, Vietnamese, Xhosa, YiddishTemplate:Hidden end
Type Raster graphics editor
License GNU GPLv3
Website www.gimp.org
{{Infobox software
| name                   = GIMP
| logo                   = The GIMP icon - gnome.svg
| logo caption           = 
| screenshot             = GIMP-main window.png
| caption                = GIMP version 2.6
| collapsible            = 
| author                 = [[Spencer Kimball (computer programmer)|Spencer Kimball]], [[Peter Mattis]]
| developer              = The GIMP Development Team
| released               = {{Start date and age|1996|01|df=yes}}
| discontinued           = 
| latest release version = 2.6.12
| latest release date    = {{Start date and age|2012|02|06|df=yes}}
| latest preview version = 2.8.0 RC1
| latest preview date    = {{Start date and age|2012|04|10|df=yes}}
| status                 = Active
| programming language   = [[C (programming language)|C]] and [[GTK+]]
| operating system       = [[Linux]], [[OS X]], [[Windows]], [[FreeBSD]], [[Solaris (operating system)|Solaris]], [[AmigaOS 4]]
| platform               = 
| size                   = 19.96 [[Megabyte|MB]]
| language count         = 80
| language footnote      = <ref>{{cite web|url=http://l10n.gnome.org/module/gimp/ |title=GNOME GIMP translation statistics, see GIMP 2.6}}</ref>
| language               = Amharic, Arabic, Asturian, Azerbaijani, Basque, Belarusian, Bosnian, Brazilian Portuguese, Breton, British English, Bulgarian, Burmese, Canadian English, Catalan (Valencian), Catalan, Chinese (China), Chinese (Hong Kong), Chinese (Taiwan), Croatian, Czech, Danish, Dutch, Dzongkha, Esperanto, Estonian, Finnish, French, Galician, Georgian, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Irish, Italian, Japanese, Kannada, Kashubian, Kazakh, Khmer, Kinyarwanda, Kirghiz, Korean, Latvian, Lithuanian, Low German, Macedonian, Malay, Malayalam, Nepali, Norwegian Bokmål, Norwegian Nynorsk, Occitan, Persian, Polish, Portuguese, Punjabi, Romanian, Russian, Scottish Gaelic, Serbian, Serbian Latin, Sinhala, Slovak, Slovenian, Spanish, Swedish, Tamil, Tatar, Telugu, Thai, Turkish, Ukrainian, Vietnamese, Xhosa, Yiddish
| genre                  = [[Raster graphics editor]]
| license                = [[GNU GPLv3]]
| alexa                  = 
| website                = {{URL|http://www.gimp.org/}}
| repo                   = {{URL|https://git.gnome.org/browse/gimp/}}
}}
  1. ↑ "GNOME GIMP translation statistics, see GIMP 2.6". http://l10n.gnome.org/module/gimp/.

Conditional formatting parameters

The following shows the effect of three parameters which change the formatting of certain infobox fields: |collapsible=, |discontinued=, |ver layout=.

GIMP
The GIMP icon - gnome.svg
Template:Hidden beginGIMP-main window.png
GIMP version 2.6Template:Hidden end
Template:Infobox software/stacked
Repository [{{#property:P1324}} {{#property:P1324}}]
Website [{{#property:P856}} {{#property:P856}}]
{{Infobox software
| name         = GIMP
| logo         = The GIMP icon - gnome.svg
| logo caption = 
| screenshot   = GIMP-main window.png
| caption      = GIMP version 2.6
| latest release version = 2.6.12
| latest release date    = {{Start date and age|2012|02|06|df=yes}}
| latest preview version = 2.8.0 RC1
| latest preview date    = {{Start date and age|2012|04|10|df=yes}}


| collapsible  = yes
| discontinued = yes
| ver layout   = stacked
}}

Parameters

All parameters are optional.

name
Name of the infobox. Can affect the title of the infobox but its primary use is to help retrieve release data from outside the article. 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.
bodystyle
CSS styling for the infobox as a whole
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. TechInfoDepot accessibility requirements mandates that this field should contain text that can be read by screen readers.
logo
Code for a small image to be displayed as software product's logo or computer icon. You may specify a full image syntax (see Help:Contents/Images and media) or just a file name, with or without namespace prefix. In other words, the following examples are all acceptable:
The GIMP icon - gnome.svg
File:The GIMP icon - gnome.svg
Image:The GIMP icon - gnome.svg
[[File:The GIMP icon - gnome.svg|64px]]
[[Image:The GIMP icon - gnome.svg|64px]]
logo size
Size of the logo. Defaults to 64px.
logo caption
Caption of the logo that appears below it. Should not be used to provide trivial captions, such as "This is the logo of X", which is automatically assumed. Reserved for special cases when a description beyond telling the obvious is needed, or for inserting {{ffdc}} or {{deletable image-caption}}.
logo alt
Alternative text of the logo; very important.
screenshot
Code for an image to be displayed as software product's screenshot. You may specify a full image syntax (see Help:Contents/Images and media) or just a file name, with or without namespace prefix. In other words, the following examples are all acceptable:
GIMP_screenshot.png
File:GIMP_screenshot.png
Image:GIMP_screenshot.png
[[File:GIMP_screenshot.png|300px]]
[[Image:GIMP_screenshot.png|300px]]
caption
A caption for screenshot that appears below it. Please include this parameter only when there is an image to display.
screenshot size
Size of the screenshot. Defaults to 300px.
screenshot alt
Alternative text of the screenshot; very important. Defaults to image caption.
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
author
Name of the original author(s) or publisher(s) 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 |developer= field is populated.
developer
Name of the current developer of the software product. It can be either an individual or an organization/business.
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:
{{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|df=yes}}
If you are unsure which date format to use, please consult WP:MOSDATES.
discontinued
Whether this product is no longer being developed, thus changing the phrase "Latest release" in the infobox to "Last release". 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 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.
latest release date depends on this parameter.
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 released field would be enough. 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|df=yes}}
If you are unsure which date format to use, please consult WP:MOSDATES.
This parameter only works when a latest release version is present.
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 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 the software product in question (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.
status
The development status of the computer program, such as: Planned, Active, Unmaintained, Discontinued, Stalled or Abandonware
programming language
The programming language of that subject of the article. If the program language of the software product has a corresponding article in TechInfoDepot, 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. Unreferenced assertions in TechInfoDepot 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 but also be mindful of the length and avoid specifying vague phrases such as Cross-platform, Multi-platform, all or none. If the project is a web app or if only an OS-agnostic source code is released, ignore. Please consider these examples:
  • If the software product works on all incarnations of Unix, Linux and derived operating systems, please specify:
    • [[Unix-like]]
  • If the software works unconditionally on ALL incarnations of Microsoft Windows, please specify:
    • [[Microsoft Windows]] or [[Windows]]
  • If the software product works only on Windows XP and all subsequent releases of Microsoft Windows, please specify:
    • [[Windows XP]] and later
  • If the software product works only on Windows XP and all subsequent releases of consumers versions of Microsoft Windows, please specify:
    • [[Windows XP]], [[Windows Vista]], [[Windows 7]] and [[Windows 8]]
      (At the time of this writing, February 2013, Windows 8 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:
    • [[BSD]], [[Linux]], [[Mac OS]] and [[Microsoft Windows]]
platform
The computing platform on which the product runs. You might like to include the following information:
Please avoid specifying vague phrases such as "cross-platform" unless the following conditions meet:
  1. 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.
  2. 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 ("&nbsp;") to prevent numbers and units of measurements from separating when "word wrapping" occurs. You can also use {{Nowrap}} template to produce the same effect.
Observe the following examples:
  • 760&nbsp;KB ? 760 KB
  • 32&nbsp;MB ? 32 MB
  • {{Nowrap|842 KB}} ? 842 KB
  • {{Nowrap|48.5 MB}} ? 48.5 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. 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 TechInfoDepot:Manual of Style/Linking § What generally should not be linked. A large list of languages can disrupt the natural flow of the article. When the list of languages grows large, consider one of the following measures:
  • Use |language count= parameter in conjunction with this parameter. This will allow the list of languages to be hidden and revealed with the click of a mouse. This method is not printer-friendly: A collapsed list does not appear on print and an expanded list may disrupt the natural flow of the article.
  • Add a link to a section of the article which lists languages. Please keep the link printer-friendly. For example, instead of "[[#Localization|Click here to see the list of languages]]", consider "35 languages; see [[#Localization|§ Localization]]". This solution is useful when the inclusion of a list of languages is important or when the localization of the subject of the article is discussed.
  • Ignore this parameter and use |language count= and |language footnote= instead. This approach is useful when the article is short and inclusion of the list of languages is unwanted or contested.
language count
Number of natural languages in which the software product user interface can interact with user. Please supply a number only. Don't use this parameter if the list of languages includes less than five entries. (Please see: TechInfoDepot:Manual of Style/Dates and numbers § Numbers)
If both |language= and |language count= parameters are present, the value of |language= will be collapsed under "List of languages" title.
language footnote
Use this parameter to supply citation on available translations, especially when |language= is not specified. Use of this parameter is not mandatory, as long as appropriate citation information is attached to the text. For instance, citation information may be attached to text itself in the article body or |language=, especially when there are more than one source for it information given. (E.g. when one source includes full translations and another includes partial translations; or when one source specifies the translations of one given version and another discusses what is added to that version after an update.) As a general rule, avoid citing automatically generated reports, statements about development versions or other sources of time-sensitive information.
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 commercial software ([[Proprietary software|Proprietary]] [[commercial software]]): Software products which are licensed for use for a price. (As in this example, please be sure to link to [[Proprietary software]], which is an article about this type of software, and not to [[Proprietary]], which is a disambiguation page.)
    • Trialware/Shareware: Same as proprietary commercial, but the user may try the product for limited time. Most software today are published under this license type.
    • Freemium: Software products that are provided in both freeware and commercial versions, with the free version being usable without the need for any compulsory payment, but lacking certain features (not to be confused with shareware)
    • Freeware: Software products which are licensed for use (and sometimes redistribution) but free of charge.
    • GNU General Public License, GNU Lesser General Public License and BSD License: three forms of free and open-source software.
Please avoid specifying phrases that makes no sense to the unfamiliar 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 TechInfoDepot articles for your fellow contributors or editors who already know.)
licence
Same as |license=. 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 ranking (find on 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 {{URL}} template like this: "{{URL|http://www.example.com}}". Avoid using printer-hostile forms like "[http://www.example.com Example website]". In absence of this parameter, infobox attempts to acquire the website link from Wikidata. This parameter overrides the Wikidata link. (It is useful when a second infobox for something different is defined on a page.) In addition, the special value "hide" suppresses this field, even in presence of a Wikidata link. This is useful for articles with several infoboxes, to avoid repeating one Wikidata link.
repo
The online source code repository, if available. For example, the sourceforge or github project page. As with the website parameter, this should use the {{URL}} template. In the absence of this parameter, infobox attempts to acquire the repository link from Wikidata. This parameter overrides the Wikidata link.
standard
Technical standard of the subject of the article adheres.
AsOf
A pseudo-parameter populated by bots and users tending to maintenance categories. The intricacies of this parameter are not included here. If you don't know what it does, please do not touch.

Moving release data outside the article

The subject's latest release version, latest release date, latest preview version and latest preview date can be moved outside the article. Users visiting the article may click the version number or "[±]" link 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).

Note, however, that if |latest release version= or |latest preview version= parameters are explicitly specified, the infobox does not look for external sources. (This can be useful if, for example, the preview version is frequently updated, but the release version is not.)

To make the infobox retrieve release data from outside the article:

  1. Create an external source that supplies data for latest stable release. To do so: Template:Ordered list
  2. Create an external source that supplies data for latest preview release. To do so: Template:Ordered list
  3. In the main article, delete |latest release version=, |latest release date=, |latest preview version= or |latest preview date= parameters from the corresponding infobox.
  4. Save the article.
  5. Refresh the article.

Microformat

Template:UF-hcal

See also

Compatible derivatives

Related


Retrieved from "https://techinfodepot.shoutwiki.com/w/index.php?title=Template:Infobox_software/doc&oldid=828"