Template:Infobox software/doc

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

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

Parameters
All parameters are optional.
 * bodystyle
 * CSS styling for the infobox as a whole


 * title
 * Name of the software as displayed above the infobox. Defaults to


 * logo
 * Code for a small image to be displayed as the logo or computer icon of the software. 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.


 * 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 a screenshot of the software. 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.


 * 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. 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. It can be an individual or organization.


 * released
 * The date in which version 1.0 (or closely-matching release) of the software in question reaches its release to manufacturing (RTM) stage. In case the article is about a specific major release of a piece of software (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 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; there is already another parameter for that use.
 * The content of this field should look like the following:
 * In case the article uses DMY as date format, use this code instead:
 * If you are unsure which date format to use, please consult WP:MOSDATES.
 * If you are unsure which date format to use, please consult WP:MOSDATES.
 * If you are unsure which date format to use, please consult WP:MOSDATES.


 * ver layout
 * Defines how version number information appear in the infobox. Can be set to "simple" (default) or "stacked". "Simple" allocates an ordinary row to "latest release version" and another to "latest preview version". But "stacked" gives the full width of the row the info and adds a header, so that several version numbers can appear and use the infobox space more efficiently. Additionally, "stacked" could automately generate an edit link at the header to allow editors to update the version number.


 * discontinued
 * Whether this software 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. Please observe the following examples:
 * Example #1: If the article is about Example Software whose latest version is 1.5, specify:
 * 1.5
 * Example #2: If the article is about Example Software whose latest release is called Example Software 2008 and whose latest version number is 12.2, specify:
 * 2008 (12.2)
 * Example #3: If the article is about Famous Example Software 2010, which is a significant release of Famous Example Software and whose latest version number is 14.0.0.25, just specify:
 * 14.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 which can only be distinguished from the RTM by their version number.
 * 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  field would be enough. The content of this field should look like the following:
 * In case the article uses DMY as date format, use this code instead:
 * If you are unsure which date format to use, please consult WP:MOSDATES.
 * This parameter only works when a  is present.
 * If you are unsure which date format to use, please consult WP:MOSDATES.
 * This parameter only works when a  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 in question (newer than one specified in ) is in progress. Please consult descriptions for   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 in question (newer than one specified in ) is in progress. Please consult descriptions for   provided above for best practices of specifying this parameter.


 * repo
 * The online source code repository, if available. For example, the sourceforge or github project page. As with the  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.


 * qid
 * Q-identifier from Wikidata.


 * programming language
 * The programming language of that subject of the article. If the program language of the software has a corresponding article in Wikipedia, please link to it. Here is an example:
 * Code:
 * Result: C++ and C#
 * When specifying the name of the programming language please make sure that you cite your source. Unreferenced assertions in Wikipedia may be challenged or removed. If you do not have a source, do not include this parameter.


 * middleware
 * Middleware for the software.


 * engine
 * Software engine that is used by this software. In absence of this parameter, infobox attempts to acquire the from Wikidata. This parameter overrides the Wikidata engine.


 * engines
 * List of software engines, if multiple are used.


 * operating system
 * The operating system on which the given software 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 works on all incarnations of Unix, Linux and derived operating systems, please specify:
 * If the software works unconditionally on ALL incarnations of Microsoft Windows, please specify:
 * or simply
 * If the software works only on Windows XP and all subsequent releases of Microsoft Windows, please specify:
 * If the software 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:
 * If the software 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:
 * If the software 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:


 * platform
 * The computing platform on which the software runs. You might like to include the following information:
 * Processor architecture: Some software runs 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.
 * Software frameworks: Some software runs 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 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 software runs.
 * If the above do not meet, then specifying such a vague phrase is the same as not specifying it.


 * included with
 * 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 available via download. For software 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 ("&amp;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:


 * width = "50%" |
 * → 760 KB
 * → 32 MB
 * width = "50%" |
 * → 842 KB
 * → 48.5 MB
 * }
 * For more information, visit WP:UNITS


 * standard
 * Technical standard of the subject of the article adheres.


 * language
 * Lists the natural languages in which the software's 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. For a comprehensive list of items that should not be generally linked to, see . 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 " Click here to see the list of languages ", consider " 35 languages; see § 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's 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. (Please see: )
 * 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 user is allowed to use the software. It is recommended to specify the specific license the software is released under by name. See Category:Software licenses. For example:
 * Proprietary : Software with a license which prohibits modifying the software and sharing copies, and where generally a copy of the source code cannot be obtained by the user. (As in this example, please be sure to link to, which is an article about this type of software, and not to  , which is a disambiguation page.)
 * GNU General Public Licenses, GNU Lesser General Public Licenses, BSD Licenses, and other free software licenses: pieces of software released under a free software license provide copies of the source code to users, and give users the freedom to modify and share copies of their copy of the source code. The GNU licenses mentioned have multiple versions each; there are multiple BSD licenses. Please make sure to specify which one.
 * GNU General Public Licenses, GNU Lesser General Public Licenses, BSD Licenses, and other free software licenses: pieces of software released under a free software license provide copies of the source code to users, and give users the freedom to modify and share copies of their copy of the source code. The GNU licenses mentioned have multiple versions each; there are multiple BSD licenses. Please make sure to specify which one.


 * 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: "http://www.example.com". Avoid using printer-hostile forms like " ". 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.

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.

Template Method (single wiki)
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:
 * 2) 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:
 * 3) In the page that opens, fill in the required information.
 * 4) Save the page.
 * 5) Create an external source that supplies data for latest preview release. To do so:
 * 6) 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:
 * 7) In the page that opens, fill in the required information.
 * 8) Save the page.
 * 9) In the main article, delete latest release version, latest release date, latest preview version or latest preview date parameters.
 * 10) Save the article.
 * 11) Refresh the article.

Wikidata Method (multi-language, potentially all wikis)
With a Wikidata entry, OS version information can be input once, and then automatically transcluded to any Wikipedia in any language, as long as they are using a Wikidata template for their data.

See: Template:Wikidata for usage information

See: Template:Infobox software for a usage example. (The Infobox:software example uses this method.)

TemplateData
{	"description": "An infobox for computer software", "format": "block", "params": { "title": { "label": "Title", "type": "string", "required": false, "description": "Name of the computer program. Displayed at the top of the infobox.", "aliases": [ "name" ],			"default": "" },		"logo": { "label": "Logo", "type": "wiki-file-name", "required": false, "description": "Filename for the image e.g. 'The GIMP icon - gnome.svg' ", "default": "" },		"logo size": { "label": "Logo size", "type": "string", "required": false, "description": "Size of the logo.", "aliases": [ "logo_size" ]		},		"logo alt": { "label": "Logo alternative text", "type": "string", "required": false, "description": "Alternative text for the logo (used by the blind and when web browsers cannot or do not load the image)", "aliases": [ "logo_alt" ]		},		"logo caption": { "label": "Logo caption", "type": "string", "required": false, "description": "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 or ." },		"screenshot": { "label": "Screenshot", "type": "wiki-file-name", "required": false, "description": "File name for a screenshot of the image, e.g. 'GIMP screenshot.png'" },		"screenshot size": { "label": "Screenshot size", "type": "string", "required": false, "description": "Size of screenshot", "aliases": [ "screenshot_size" ]		},		"screenshot alt": { "label": "Screenshot alternative text", "type": "string", "required": false, "description": "Alternative text for the screenshot (used by the blind and when web browsers cannot or do not load the image)", "aliases": [ "screenshot_alt" ]		},		"caption": { "label": "Caption", "type": "string", "required": false, "description": "Caption for the screenshot" },		"collapsible": { "label": "Collapsible?", "type": "string", "required": false, "description": "Whether this screenshot is hidden by default, set to 'yes' to place the screenshot in a collapsible section" },		"author": { "label": "Original author", "type": "string", "required": false, "description": "Name of the original author or publisher of the software. It can be either an individual or an organization/business. Most of the time, it only needs to be specified when developer field is populated." },		"developer": { "label": "Developer", "type": "string", "required": false, "description": "Name of the current developer of the software. It can be either an individual or an organization/business." },		"released": { "label": "Initial release date", "type": "string", "required": false, "description": "The date in which version 1.0 (or closely-matching release) of the software in question reaches its release to manufacturing (RTM) stage. In case the article is about a specific major release of a piece of software (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 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; there is already another parameter for that use. The content of this field should look like the following: In case the article uses DMY as date format, use this code instead:  If you are unsure which date format to use, please consult WP:MOSDATES." },		"discontinued": { "label": "Discontinued?", "type": "string", "required": false, "description": "Whether this software is no longer being developed, thus changing the phrase 'Latest release' in the infobox to 'Final 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." },		"ver layout": { "label": "Version info layout", "description": "Defines how version number information appear in the infobox. Can be set to \"simple\" (default) or \"stacked\". \"Simple\" allocates an ordinary row to \"latest release version\" and another to \"latest preview version\". But \"stacked\" gives the full width of the row the info and adds a header, so that several version numbers can appear and use the infobox space more efficiently. Additionally, \"stacked\" could automately generate an edit link at the header to allow editors to update the version number.", "autovalue": "simple", "type": "string" },		"latest release version": { "label": "Latest release version", "type": "string", "required": false, "description": "The version number of the latest release of the software. E.g. 'v1.5', '2008 (v12.2)', ", "aliases": [ "latest_release_version" ]		},		"latest release date": { "label": "Latest release date", "type": "string", "required": false, "description": "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: ", "aliases": [ "latest_release_date" ]		},		"latest preview version": { "label": "Latest preview version", "type": "string", "required": false, "description": "The version number of the latest preview version or development branch. Should only be specified when development of a new version of the software 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.", "aliases": [ "latest_preview_version" ]		},		"latest preview date": { "label": "Latest preview date", "type": "string", "required": false, "description": "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 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.", "aliases": [ "latest_preview_date" ]		},		"programming language": { "label": "Programming language", "type": "string", "required": false, "description": "The programming language in which the subject of the infobox is created. If the programming language of the software has a corresponding article on Wikipedia, please link to it. E.g. 'C++ and C#'. Be advised that Wikipedia policies such as Verifiability and No original research also apply here.", "aliases": [ "programming_language" ]		},		"engine": { "label": "Software engine", "description": "Software engine used by this program. In absence of this parameter, infobox attempts to acquire the engine from Wikidata. This parameter overrides the Wikidata engine. May also use plural.", "type": "wiki-page-name", "aliases": [ "engines" ]		},		"operating system": { "label": "Operating system", "type": "string", "required": false, "description": "The operating system on which the given software 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).", "aliases": [ "operating_system" ]		},		"platform": { "label": "Platform", "type": "string", "required": false, "description": "The computing platform on which the software runs. Can be specific processors like 'IA-32' (i386), 'x86-64' 'Itanium', 'ARM' or 'MIPS'." },		"included with": { "label": "Included with", "description": "Devices and operating systems that come preloaded with this browser.", "type": "string" },		"size": { "label": "Size", "type": "string", "required": false, "description": "Size of the installer package. Only applies to software available via download. E.g. '48 MB'." },		"language": { "label": "Language", "type": "string", "required": false, "description": "Lists the natural languages in which the software's user interface can interact with user. Please do not supply 'Multilingual' or such vague phrases." },		"language count": { "label": "Language count", "type": "number", "required": false, "description": "Number of natural languages in which the software's user interface can interact with user." },		"language footnote": { "label": "Language footnote", "type": "string", "required": false, "description": "Use this parameter to supply citation on available translations." },		"genre": { "label": "Genre", "type": "wiki-page-name", "required": false, "description": "Type of program. Should be wikilinked to an article such as 'Geographic information system'. For more information, consult List of software categories." },		"license": { "label": "License", "type": "string", "required": false, "description": "Name of the software license under which the user is allowed to use the software. E.g. 'Proprietary', 'GNU General Public License version 3', 'Modified BSD License'. May also use Commonwealth English spelling.", "aliases": [ "licence" ]		},		"website": { "label": "Website", "type": "string", "required": false, "description": "The web site URL of the software package. This URL must be readable in print. Therefore, you should use 'undefined' template like this: 'http://www.example.com'. Avoid using printer-hostile forms like '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." },		"repo": { "label": "Source code repository", "type": "string", "required": false, "description": "The online source code repository, if available. For example, the sourceforge or github project page. As with the website parameter, this should use the undefined template. In the absence of this parameter, infobox attempts to acquire the repository link from Wikidata. This parameter overrides the Wikidata link." },		"standard": { "label": "Standard(s)", "type": "string", "required": false, "description": "Technical standard of the software." },		"AsOf": { "label": "Infobox timestamp (AsOf)", "type": "string", "required": false, "description": "Infobox timestamp in the form of month name, space character, year (four digits). Used by maintenance procedures and bots." },		"bodystyle": { "label": "Body style (CSS)", "type": "string", "required": false, "description": "CSS styling for the infobox as a whole" },		"other_names": { "type": "string", "label": "Other names", "description": "Other (or former) names for the software" },		"qid": { "type": "string" },		"middleware": { "type": "string", "label": "Middleware", "description": "The middleware used by the software", "example": "Havok" },		"replaces": { "type": "string", "label": "Replaces", "description": "What the software replaces" },		"replaced_by": { "type": "wiki-page-name", "label": "Replaced by", "description": "Software that replaces this one" },		"service_name": { "type": "string", "label": "Service name", "description": "The service name for the software" }	},	"paramOrder": [ "bodystyle", "title", "screenshot", "logo", "logo caption", "logo size", "logo alt", "collapsible", "screenshot size", "screenshot alt", "caption", "other_names", "author", "developer", "released", "ver layout", "discontinued", "latest release version", "latest release date", "latest preview version", "latest preview date", "repo", "qid", "programming language", "middleware", "engine", "operating system", "platform", "included with", "replaces", "replaced_by", "service_name", "size", "standard", "language", "language count", "language footnote", "genre", "license", "website", "AsOf" ] }

Related

 * Infobox OS for operating systems
 * Infobox software platform for software platforms
 * Infobox video game for video games
 * Infobox website for websites and web applications
 * WP:IB - list of infoboxes