Difference between revisions of "Template:Infobox software/doc"

From CHG-Wiki
Jump to navigationJump to search
m
m
 
Line 251: Line 251:
  
 
</includeonly>
 
</includeonly>
−
<noinclude>[[Category:Templates|{{{PAGENAME}}}]]</noinclude>
+
<noinclude>[[Category:Templates|{{PAGENAME}}]]</noinclude>

Latest revision as of 14:23, 13 December 2012

Edit-copy green.png This is a documentation subpage for Template:Infobox software.
It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

Usage

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


Example

The following code 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
64px|Wilber, the GIMP mascotGimp
250px
GIMP, version 2.8 running on Ubuntu 12.04.
Developer(s) The GIMP Development Team
Initial release

January 1996; 28 years ago

 (1996-01)
Stable release

2.8 / May 3, 2012; 12 years ago

 (2012-05-03)
Preview release

2.7.5 / March 14, 2012; 12 years ago

 (2012-03-14)
Development status Active
Written in C and GTK+
Operating system AmigaOS 4, FreeBSD, Mac OS X, Microsoft Windows, Linux, Solaris
Available in 77 languages[1]
Type Raster graphics editor
License GNU LGPL v3+
Alexa rank Increase 4,580 (August 2012)
Website www.gimp.org


{{infobox software
| name                 = GIMP
| logo                 = [[wikipedia:File:The GIMP icon - gnome.svg|64px|Wilber, the GIMP mascot]][[wikipedia:File:Gimp logo.png|Gimp]]
| screenshot           = [[wikipedia:File:GIMP 2.8 running on Ubuntu 12.04.png|250px]]
| caption              = GIMP, version 2.8 running on Ubuntu 12.04.
| developer            = The GIMP Development Team
| released             = {{Start date and age|1996|1}}
| latest preview version = 2.7.5
| latest preview date    = {{Start date and age|2012|03|14}}
| latest release version = 2.8
| latest release date    = {{Start date and age|2012|05|03}}
| programming language = [[wikipedia:C (programming language)|C]] and [[wikipedia:GTK+|GTK+]]
| operating system     = [[wikipedia:AmigaOS 4|AmigaOS 4]], [[wikipedia:FreeBSD|FreeBSD]], [[wikipedia:Mac OS X|Mac OS X]], [[wikipedia:Microsoft Windows|Microsoft Windows]], [[wikipedia:Linux|Linux]], [[wikipedia:Solaris (operating system)|Solaris]]
| language             = '''Fully translated''': German, Greek, Hungarian, Italian, Latvian, Polish, Slovenian, Spanish, Breton, Catalan, Galician, Japanese, Korean, Norwegian Nynorsk, Telugu, Ukrainian, Belarusian, Brazilian Portuguese, Catalan, Czech, Romanian, Lithuanian, British English, French, Vietnamese, Tamil, Basque, Serbian, Serbian Latin, Finnish, Russian, Turkish, Arabic<br />'''Other''': Portuguese, Chinese, Punjabi, Swedish, Dutch, Chinese, Chinese, Danish, Esperanto, Norwegian Bokmål, Burmese, Estonian, Asturian, Macedonian, Canadian English, Bulgarian, Nepali, Khmer, Dzongkha, Persian, Thai, Gujarati, Slovak, Xhosa, Hebrew, Icelandic, Croatian, Malay, Kannada, Tatar, Low German, Georgian, Malayalam, Occitan, Hindi, Azerbaijani, Sinhala, Kazakh, Irish, Amharic, Kinyarwanda, Indonesian, csb, Yiddish
| language count       = 77
| language footnote    = <ref>{{citation |url=http://l10n.gnome.org/module/gimp/#gimp-2-8 |title=Module Statistics: gimp |section=gimp-2-8 |work=[[wikipedia:The GNOME Project|The GNOME Project]] |date=autogenerated |accessdate=August 3, 2012 }}</ref>
| status               = Active
| genre                = [[wikipedia:Raster graphics editor|Raster graphics editor]]
| alexa                = {{increase}} [http://www.alexa.com/siteinfo/gimp.org 4,580] ({{asof|2021|1|21|alt=August 2012}})
| license              = [[wikipedia:GNU Lesser General Public License|GNU LGPL]] v3+
| website              = {{URL|http://www.gimp.org/}}
}}
  1. ↑ "Module Statistics: gimp", The GNOME Project, autogenerated, http://l10n.gnome.org/module/gimp/#gimp-2-8, retrieved August 3, 2012


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 frequently updated parameter, and "Stable release" / "Preview release" fields. When modifying an article which already has an infobox, be careful not to edit this parameter when frequently updated parameter is set to yes. 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. Wikipedia 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:
[[File:File name.ext|Sizepx]]
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: Wikipedia: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:
[[File:File name.ext|Sizepx]]
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: wikipedia: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 developer 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:
{{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 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 latest release date 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 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 MOSDATES.
This parameter and latest release version 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 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.
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 latest release version or latest preview version 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:
    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://wiki.chc.ucsb.edu/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://wiki.chc.ucsb.edu/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, add frequently updated=yes to the infobox, and delete any latest release version, latest release date, latest preview version or latest preview date parameters.
  4. Save the article.
  5. Refresh the article.
programming language
The programming language of that subject of the article. If the program language of the software product has a corresponding article in Wikipedia, please link to it. Here is an example:
Code: [[wikipedia:C++|C++]] and [[wikipedia: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 Wikipedia may be challenged or removed. If you do not have a source, do not include this parameter.
operating system
The operating system on which the given software product works. Please be as accurate as possible in specifying this parameter (but also be mindful of the length) and avoid specifying vague phrases such as Cross-platform (or its redirect, Multi-platform). Please consider these examples:
  • If the software product works on all incarnations of Unix, Linux and derived operating systems, please specify:
    • [[Unix-like]]
  • If the software works unconditionally on ALL incarnations of Microsoft Windows, please specify:
    • [[wikipedia:Microsoft Windows|Microsoft Windows]]
      (Do not specify [[wikipedia:Microsoft Windows|Windows]]; 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:
    • [[wikipedia:Windows XP|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:
    • [[wikipedia:Windows XP|Windows XP]], [[wikipedia:Windows Vista|Windows Vista]] and [[wikipedia:Windows 7|Windows 7]]
      (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:
    • [[wikipedia:BSD|BSD]], [[wikipedia:Linux|Linux]], [[wikipedia:Mac OS|Mac OS]] and [[wikipedia:Microsoft Windows|Microsoft Windows]]
  • If the software is an operating system–independent wikipedia:web application, ignore this parameter.
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;[[Kilobyte|KB]] → 760 KB
  • 32&nbsp;[[Megabyte|MB]] → 32 MB
  • {{Nowrap|842 [[Kilobyte|KB]]}} → 842 KB
  • {{Nowrap|48.5 [[Megabyte|MB]]}} → 48.5 MB
For more information, visit 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 Wikipedia: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 [[wikipedia:#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 then five entries. (Please see: Wikipedia: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.
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 ([[Proprietary software|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 [[Proprietary software]], which is an article about this type of software, and not to [[Proprietary]], 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:
Please avoid specifying phrases that makes no sense to the reader such as "Microsoft EULA", "Adobe End-User License Agreement" or "Symantec Terms of License", etc. (Always bear in mind that you are writing the article for those who do not know about the subject and come to the article to gain knowledge. You are not writing Wikipedia articles for your fellow co-editors who already know!)
licence
Same as 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 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: "{{URL|http://www.example.com}}". Avoid using printer-hostile forms like "[http://www.example.com Example website]".

Microformat

The HTML mark up produced by this template includes an hCalendar microformat, which makes the event details parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a calendar or diary application. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

Dates will only be included if you use {{Start date}} or {{End date}} (use the former for single dates; but do not use any of these if the date is before 1583 CE).

URLs will only be included if you use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCalendar uses HTML classes including:

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



See also

Retrieved from "https://wiki.chc.ucsb.edu/index.php?title=Template:Infobox_software/doc&oldid=1059"