Template:Infobox bot: Difference between revisions
m Add software field |
Fix centered title |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{{Infobox | <includeonly>{{Infobox | ||
| | | above = {{{title|<includeonly>{{PAGENAME}}</includeonly>}}} | ||
| image = {{#if:{{{screenshot|}}} | | image = {{#if:{{{screenshot|}}} | ||
| {{#invoke:InfoboxImage | InfoboxImage | image={{{logo|}}} | title={{{logo caption|}}} | size={{{logo size|{{{logo_size|}}}}}} | sizedefault=300x64px | maxsize=300x64px | alt={{{logo alt|{{{logo_alt|}}}}}} }} | | {{#invoke:InfoboxImage | InfoboxImage | image={{{logo|}}} | title={{{logo caption|}}} | size={{{logo size|{{{logo_size|}}}}}} | sizedefault=300x64px | maxsize=300x64px | alt={{{logo alt|{{{logo_alt|}}}}}} }} | ||
| Line 33: | Line 29: | ||
| data10 = {{{license|}}} | | data10 = {{{license|}}} | ||
| label11 = [[Wikipedia:Repository (version control)|Repository]] | | label11 = [[Wikipedia:Repository (version control)|Repository]] | ||
| data11 = {{{repository|}}} | | data11 = {{{repository|{{{repo|}}}}}} | ||
| label12 = Website | | label12 = Website | ||
| data12 = {{{website|{{{homepage|{{{URL|{{{url|}}}}}}}}}}}} | | data12 = {{{website|{{{homepage|{{{URL|{{{url|}}}}}}}}}}}} | ||
Latest revision as of 15:08, 3 October 2020
}}} | image = | caption = | image2 = | caption2 = | label1 = Other names | data1 = | label2 = Original author(s) | data2 = | label3 = Developer(s) | data3 = | label4 = Initial release | data4 = | label5 = Software | data5 = | label6 = Written in | data6 = | label7 = Library | data7 = | label8 = Predecessor | data8 = | label9 = Successor | data9 = | label10 = License | data10 = | label11 = Repository | data11 = | label12 = Website | data12 = }}</includeonly>
 | This template uses Lua: |
Usage
The following is the base code required to generate an infobox. One can copy and paste the base code into an article and insert relevant information in front of the "=" signs. Removing HTML comments ("<!--", "-->" and anything between these two) is optional. To avoid accidental misuse, this base code does not have a handful of parameters that must be handled with absolute care and are not normally needed, such as {{{bodystyle}}}.
| {{{title}}} | |
|---|---|
| [[File:{{{logo}}}|300x64px|alt={{{logo alt}}}|{{{logo caption}}}]] {{{logo caption}}} | |
| [[File:{{{screenshot}}}|{{{screenshot size}}}|alt={{{screenshot alt}}}|{{{caption}}}]] {{{caption}}} | |
| Other names | {{{other_names}}} |
| Original author(s) | {{{author}}} |
| Developer(s) | {{{developer}}} |
| Initial release | {{{released}}} |
| Written in | {{{programming language}}} |
| Predecessor | {{{replaces}}} |
| Successor | {{{replaced_by}}} |
| License | {{{license}}} |
| Repository | {{{repo}}} |
| Website | {{{website}}} |
{{Infobox bot
| title =
| logo = <!-- Image name is enough. -->
| logo alt =
| logo caption =
| screenshot = <!-- Image name is enough. -->
| screenshot size =
| screenshot alt =
| caption =
| collapsible = <!-- Any text here will collapse the screenshot. -->
| other_names =
| author =
| developer =
| released = <!-- {{Start date and age|YYYY|MM|DD|df=yes/no}} -->
| Software = <!-- if the bot is an instance of some piece of software. -->
| programming language =
| library =
| replaces =
| replaced_by =
| license =
| repository = <!-- {{URL|example.org}} -->
| website = <!-- {{URL|example.org}} -->
}}
Example
| Taunt Bot | |
|---|---|
 | |
| Developer(s) | Cory |
| Initial release | September 19, 2016 |
| Written in | Node.js |
| Library | discord.js |
| License | GPLv3+ |
| Repository | github |
| Website | taunt |
{{Infobox bot
| title = Taunt Bot
| logo = Taunt Bot logo.svg
| logo alt = Taunt Bot logo
| developer = [[Cory]]
| released = {{Start date and age|2016|9|19}}
| programming_language = [[Wikipedia:Node.js|Node.js]]
| library = discord.js
| license = [[Wikipedia:GNU General Public License#Version 3|GPLv3+]]
| repository = {{URL|https://github.com/CorySanin/tauntbot.git}}
| website = {{URL|https://taunt.bot}}
}}
Conditional formatting parameters
The following shows the effect of three parameters which change the formatting of certain infobox fields: |collapsible=.
| Taunt Bot | |
|---|---|
| |
| Developer(s) | Cory |
| Initial release | September 19, 2016 |
| Written in | Node.js |
| Library | discord.js |
| License | GPLv3+ |
| Repository | github |
| Website | taunt |
{{Infobox bot
| title = Taunt Bot
| logo = Taunt Bot logo.svg
| logo alt = Taunt Bot logo
| collapsible = yes
| developer = [[Cory]]
| released = {{Start date and age|2016|9|19}}
| programming_language = [[Wikipedia:Node.js|Node.js]]
| library = discord.js
| license = [[Wikipedia:GNU General Public License#Version 3|GPLv3+]]
| repository = {{URL|https://github.com/CorySanin/tauntbot.git}}
| website = {{URL|https://taunt.bot}}
}}
Parameters
All parameters are optional.
- title
- 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, Wikipedia: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 Wikipedia:accessibility requirements mandates that this field should contain text that can be read by Wikipedia:screen readers.
- logo
- Code for a small image to be displayed as bot's Wikipedia:logo. 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.
- screenshot
- Code for an image to be displayed as software product's Wikipedia: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
- caption
- A caption for screenshot that appears below it. Please include this parameter only when there is an image to display.
- screenshot size
- Size of the screenshot. Defaults to 300px.
- screenshot alt
- Alternative text of the screenshot; very important. Defaults to image caption.
- collapsible
- Whether this screenshot is by default hidden and is only shown when user clicks on a minuscule "Expand" button. Can be set to "yes". Especially useful in case of long vertical screenshot
- author
- Name of the original author(s) or publisher(s) of the software product. It can be 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 the bot went live
- 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 Wikipedia:WP:MOSDATES.
- software
- If this bot is an instance of some other piece of software, provide the name of that software here.
- programming language
- The Wikipedia: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++]] and [[Wikipedia:C Sharp (programming language)|C#]] - Result: Wikipedia:C++ and C#
- Code:
- library
- Library used to interface with the Discord API
- license
- The Wikipedia: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 Wikipedia::Category:Software licenses. For example:
- Proprietary commercial software (
[[Wikipedia:Proprietary license|Proprietary]] [[Wikipedia:commercial software|commercial software]]): Software products which are licensed for use for a price. (As in this example, please be sure to link to[[Wikipedia:Proprietary license|Proprietary License]], which is an article about this type of software, and not to[[Wikipedia:Proprietary|Proprietary]], which is a disambiguation page.) - Trialware/Shareware: Same as proprietary commercial, but the user may try the product for limited time. Most software today are published under this license type.
- GNU General Public License, GNU Lesser General Public License and BSD License: three forms of free and open-source software.
- Proprietary commercial software (
- repo
- The online source code repository, if available. For example, the sourceforge or github project page. As with the
websiteparameter, this should use the {{URL}} template. - 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]".