Template:Infobox software/doc

Usage


Example


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  parameter, and "Stable release" / "Preview release" fields. When modifying an article which already has an infobox, be careful not to edit this parameter when   parameter is set to yes. In such cases, if you want to edit the title at the top of the infobox, use the   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. The contents of this field should look like:
 * &#91;&#91;File:File name.ext|Sizepx&#93;&#93;
 * 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:
 * &#91;&#91;File:File name.ext|Sizepx&#93;&#93;
 * 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  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:
 * 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.


 * 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  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  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 and  complement each other but none strictly requires the presence of the other.
 * If you are unsure which date format to use, please consult WP:MOSDATES.
 * This parameter and  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 ) 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 product in question (newer than one specified in ) is in progress. Please consult descriptions for   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   or   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:


 * 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  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  parameter of the infobox:
 * 7) In the page that opens, fill in the required information.
 * 8) Save the page.
 * 9) In the main article, add  to the infobox, and delete any ,  ,   or   parameters.
 * 10) Save the article.
 * 11) 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 TechInfoDepot, 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 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 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:
 * If the software works unconditionally on ALL incarnations of Microsoft Windows, please specify:
 * (Do not specify ; 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:
 * If the software product works only on Windows XP and all subsequent releases of consumers versions of Microsoft Windows, please specify:
 * (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:
 * If the software is an operating system–independent web application, ignore this parameter.
 * 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:
 * If the software is an operating system–independent web application, ignore this parameter.
 * 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.
 * 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 Nowrap template to produce the same effect.


 * Observe the following examples:


 * width = "50%" |
 *  760&#x26;nbsp&#x3B;KB  → 760 KB
 *  32&#x26;nbsp&#x3B;MB  → 32 MB
 * width = "50%" |
 *  842 KB  → 842 KB
 *  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 . 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 product user interface can interact with user. Please supply a number only. Don't use this parameter if the list of languages includes less then 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.


 * 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 commercial software : 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, which is an article about this type of software, and not to  , 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 TechInfoDepot articles for your fellow co-editors who already know!)


 * licence: Same as . 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 link Alexa's page for this info.) Use increase, decrease or steady to indicate the tendency of ranking, if such information available. Consider filing request for automatic update of this information by OKBot.


 * website: The web site URL of the software package. This URL must be readable in print. Therefore, you should use URL template like this: " ". Avoid using printer-hostile forms like " ".