Template:Infobox App

From BizApps Wiki, the free Business Applications encyclopedia
Jump to: navigation, search
Template documentation[view] [edit] [history] [purge]

Usage[edit]

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}}}.

Keep in mind that MediaWiki is case-sensitive and be carefull when you are using lowercase and upper case. In this infobox, leading "I" and "A" are uppercases: Infobox App.

Template:Parameter names example

{{Infobox App
| name = 
| logo = <!-- File name without 'File:' -->
| logo caption = 
| logo alt = 
| logo size =
| collapsible = <!-- Any text here will collapse the screenshot. -->
| screenshot = <!-- File name without 'File:' -->
| screenshot size =
| screenshot alt = 
| caption = 
| other_names =
| author = 
| developer = 
| released = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| programming language = 
| middleware =
| operating system = 
| platform = 
| included with = 
| replaces =
| replaced_by =
| service_name = 
| size = 
| language = 
| language count = <!-- Number only -->
| language footnote = 
| genre = 
| license = <!-- or |licence= -->
| website = <!-- {{URL|example.org}} or {{official URL}} -->
| AsOf = 
| games list = 
}}

Example[edit]

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 release2 June 1998; 23 years ago (1998-06-02)
Written inC and GTK+
Operating systemLinux, macOS, Windows, FreeBSD, Solaris, AmigaOS 4
Size19.96 MB
Available in80 languages[1]
List of languages
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
TypeRaster graphics editor
LicenseGNU GPLv3
Websitewww.gimp.org
[[Category:Infobox templates|Template:Remove first word]]
{{Infobox App
| 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|1998|6|2|df=yes}}
| programming language = [[C (programming language)|C]] and [[GTK+]]
| operating system = [[Linux]], [[macOS]], [[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]]
| website = {{URL|https://www.gimp.org/}}
}}

  1. "GNOME GIMP translation statistics, see GIMP 2.6".

Conditional formatting parameters[edit]

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
Screenshot
GIMP-main window.png
GIMP version 2.6
[[Category:Infobox templates|Template:Remove first word]]
{{Infobox App
| name = GIMP
| logo = The GIMP icon - gnome.svg
| screenshot = GIMP-main window.png
| caption = GIMP version 2.6
| collapsible = yes
}}

Parameters[edit]

All parameters are optional.

bodystyle
CSS styling for the infobox as a whole
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.
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. BizApps Wiki 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 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
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.
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
screenshot
Code for an image to be displayed as software product's screenshot. You may specify a file name, with or without namespace prefix. In other words, the following examples are all acceptable:
GIMP screenshot.png
File:GIMP screenshot.png
screenshot size
Size of the screenshot. Defaults to 300px.
screenshot alt
Alternative text of the screenshot; very important. Defaults to image caption.
caption
A caption for screenshot that appears below it. Please include this parameter only when there is an image to display.
other_names
Other names for the software.
author
Name of the original author(s) or publisher(s) of the software product. It can be an individual or organization. Most of the time, it only needs to be specified when |developer= field is populated.
developer
Name of the current developer of the software product. It can be an individual or organization.
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.
programming language
The programming language of that subject of the article. If the program language of the software product has a corresponding article in BizApps Wiki, 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 BizApps Wiki may be challenged or removed. If you do not have a source, do not include this parameter.
middleware
Middleware for the software.
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, macOS 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]], [[macOS]] 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.
included with
Products (devices and operating systems) that come preloaded with this browser.
replaces
What the software replaces, if applicable.
replaced_by
What the software has been replaced with.
service_name
Service name for the software.
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 vague phrases, such as "multilingual", which do not add to the knowledge of the reader. Also please do not wikilink the name of languages; readers are most likely uninterested in reading about those languages. 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 fewer than five entries.
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
The software license under which the consumer is allowed to use the product. You may specify a specific license or the more general category of license to which it belongs. See Category:Software licenses. For example:
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.
website
The web site URL of the software package, if one wants to override the Wikidata official URL value. This URL must be readable in print. Therefore, you should use {{URL}} template like this: "Template:Tl2". Avoid using printer-hostile forms like "[http://www.example.com Example website]". 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. If left blank, the Wikidata official website value will display by default.
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.
games list
List of games.

Moving release data outside the article[edit]

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:
    1. Copy and paste the following URL into your browser's address bar, replacing INFOBOX_NAME with the value supplied in |name= parameter of the infobox:
      https://bizapps.wiki/index.php?title=Template:Latest_stable_software_release/INFOBOX_NAME&action=edit&preload=Template:LSR/syntax
    2. In the page that opens, fill in the required information.
    3. Save the page.
  2. Create an external source that supplies data for latest preview release. To do so:
    1. Copy and paste the following URL into your browser's address bar, replacing INFOBOX_NAME with the value suppplied in |name= parameter of the infobox:
      https://bizapps.wiki/index.php?title=Template:Latest_preview_software_release/INFOBOX_NAME&action=edit&preload=Template:LPR/syntax
    2. In the page that opens, fill in the required information.
    3. Save the page.
  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. Changes to release information may take a few minutes to be reflected in the article when reloaded; wait a while before concluding that you have made an error.

Microformat[edit]

The HTML mark-up produced by this template includes an hCalendar microformat that makes event details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.
Classes used

The HTML classes of this microformat include:

  • attendee
  • contact
  • description
  • dtend
  • dtstart
  • location
  • organiser
  • summary
  • url
  • vevent
Please do not rename or remove these classes
nor collapse nested elements which use them.

TemplateData[edit]

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Infobox App

An infobox for computer software

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Body style (CSS)bodystyle

CSS styling for the infobox as a whole

Default
empty
Example
empty
Auto value
empty
Stringoptional
Titletitlename

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.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Screenshotscreenshot

File name for a screenshot of the image, e.g. 'GIMP screenshot.png'

Default
empty
Example
empty
Auto value
empty
Fileoptional
Logologo

Filename for the image e.g. 'The GIMP icon - gnome.svg'

Default
{{#Property:P154}}
Example
empty
Auto value
empty
Fileoptional
Logo captionlogo caption

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}}.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Logo sizelogo sizelogo_size

Size of the logo.

Default
64px
Example
empty
Auto value
empty
Stringoptional
Logo alternative textlogo altlogo_alt

Alternative text for the logo (used by the blind and when web browsers cannot or do not load the image)

Default
empty
Example
empty
Auto value
empty
Stringoptional
Collapsible?collapsible

Whether this screenshot is hidden by default, set to 'yes' to place the screenshot in a collapsible section

Default
empty
Example
empty
Auto value
empty
Stringoptional
Screenshot sizescreenshot sizescreenshot_size

Size of screenshot

Default
300px
Example
empty
Auto value
empty
Stringoptional
Screenshot alternative textscreenshot altscreenshot_alt

Alternative text for the screenshot (used by the blind and when web browsers cannot or do not load the image)

Default
empty
Example
empty
Auto value
empty
Stringoptional
Captioncaption

Caption for the screenshot

Default
empty
Example
empty
Auto value
empty
Stringoptional
Other_namesother_names

no description

Default
empty
Example
empty
Auto value
empty
Stringoptional
Original authorauthor

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 developer field is populated.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Developerdeveloper

Name of the current developer of the software product. It can be either an individual or an organization/business.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Initial release datereleased

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.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Programming languageprogramming languageprogramming_language

The programming language in which the subject of the infobox is created. If the program language of the software product has a corresponding article in Wikipedia, please link to it. E.g. '[[C++]] and [[C Sharp (programming language)|C#]]'. Be advised that Wikipedia policies such as [[Wikipedia:Verifiability]] and [[Wikipedia:No original research]] also apply here.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Middlewaremiddleware

no description

Default
empty
Example
empty
Auto value
empty
Stringoptional
Operating systemoperating systemoperating_system

The operating system on which the given software product works. E.g. '[[Microsoft Windows]]' or '[[Windows]]', '[[Windows XP]] and later'. If the subject of the article is a web app, library or an SO-agnostic source code, ignore this parameter. 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) or 'Unix-like' (implies that the subject runs on most desktops, server and mobile devices).

Default
empty
Example
empty
Auto value
empty
Stringoptional
Platformplatform

The computing platform on which the product runs. Can be specific processors like '[[IA-32]]' (i386), '[[x86-64]]' 'Itanium', 'ARM' or 'MIPS'.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Included withincluded with

Products (devices and operating systems) that come preloaded with this browser.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Replacesreplaces

no description

Default
empty
Example
empty
Auto value
empty
Stringoptional
Replaced_byreplaced_by

no description

Default
empty
Example
empty
Auto value
empty
Stringoptional
Service_nameservice_name

no description

Default
empty
Example
empty
Auto value
empty
Stringoptional
Sizesize

Size of the installer package. Only applies to software products that are available via download. E.g. '{{Nowrap|48 MB}}'.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Languagelanguage

Lists the natural languages in which the software product user interface can interact with user. Please do not supply 'Multilingual' or such vague phrases.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Language countlanguage count

Number of natural languages in which the software product user interface can interact with user.

Default
empty
Example
empty
Auto value
empty
Numberoptional
Language footnotelanguage footnote

Use this parameter to supply citation on available translations.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Genregenre

Type of program. Should be wikilinked to an article such as '[[Geographic information system]]'. For more information, consult List of software categories.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Licenselicenselicence

Type of the software license under which the consumer is allowed to use the product. E.g. '[[Proprietary software|Proprietary]] [[commercial software]]', '[[Freeware]]', '[[Free software]]', '[[GNU General Public License]]', '[[BSDLicense]]'. May also use Commonwealth English spelling.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Websitewebsite

The web site URL of the software package. This URL must be readable in print. Therefore, you should use '{{tl|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 form 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.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Infobox timestamp (AsOf)AsOf

Infobox timestamp in the form of month name, space character, year (four digits). Used by maintenance procedures and bots.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Games listgames list

no description

Default
empty
Example
empty
Auto value
empty
Stringoptional

See also[edit]

Compatible derivatives

Related[edit]