Template:Infobox software

From Emulation General Wiki
Revision as of 16:47, 9 October 2019 by TheTechnician27 (talk | contribs) (Added license parameter to Layout and Render.)
Jump to navigation Jump to search
Infobox software
Developer(s) Anonymous/Unidentified
Latest version Unknown
Platform(s) {{{platform}}}
Type {{{type}}}


Infobox software

An infobox for pages detailing software. A clone of Template:Infobox emulator, but with some parameters changed or removed to focus less on emulators. This infobox is meant to cover software we have articles for that aren't necessarily emulators, such as frontends/launchers (e.g. RetroArch). Most parameters are optional but are explained below.

Example

Layout

{{Infobox software
|title         = RetroArch
|logo          = retroarch.png
|developer     = Squarepusher, themaister, others
|version       = {{RetroArchVer}}
|active        = Yes
|platform      = Multi-platform
|type          = [[libretro]] Frontend
|website       = [http://www.libretro.com/ libretro.com]
|prog-lang     = C <!-- this may not actually be true, it could also be C++, but this is just an example -->
|license       = GNU GPLv3
|source        = [https://github.com/libretro GitHub]
}}

Render

RetroArch
Retroarch.png
Developer(s) Squarepusher, themaister, others
Latest version 1.18.0
Active Yes
Platform(s) Multi-platform
Type libretro Frontend
Programmed in C
Website libretro.com
License GNU GPLv3
Source code GitHub

Parameters

The order of parameters here are arranged according to the order they are displayed on the page. You can technically place these in any order you want, but it's discouraged because the template is designed to have the values show up only one way.

title
The name of the software. If no value is given, it will default to the name of the page instead.
logo (replaces image)
Used to put logos in. It's optional.
logowidth (replaces imagewidth)
Also optional. Set the width of the logo. Might be useful for logos that either exceed the size of the infobox, or have a more vertical (and thus uncomfortable) aspect ratio.
orig-developer
If development was passed onto other people, use this to write the original developer (and use developer for the current). This will change the text accordingly, and is optional.
developer (replaces fourth)
Who's making the software? If the project is inactive, then who made the software? If the project is on GitHub, link the contributors page and say "(project) Team". Leave it unanswered and it will say "Anonymous/Unidentified".
version (replaces first)
What's the current version? For new pages, you will want to templatize this, especially when updates happen often. Emugen naming conventions are usually Template:(Project)Ver and you transclude it into the infobox by doing {{ (Project)Ver }}.
last-version
Replaces version (don't use both at the same time). If the project is actually defunct and no longer in development, this parameter should be used to show the last version published.
active (replaces second)
Is the project active? If its repository hasn't received any activity in the last month or two, it probably went inactive. Always be sure to check other branches. Optional, because not everyone has the time to check.
fate
If the project is defunct and no longer in development, what happened to the project? Do not use for active projects (obviously).
platform (replaces third)
What platforms does the software run on? Required because it's gotta run somewhere. List the operating systems and consoles (if it has a standalone package for them), otherwise put libretro if they have libretro cores.
architecture
What architecture is the software coded for? This one is especially optional because more general-purpose software can be programmed in a high-level language such as Python, where coding for one architecture isn't the goal.
type
The kind of software it is.
prog-lang
Optional, especially given that it's difficult to determine what programming languages closed-source projects use.
language
Optional because this is really only needed if it's not in English, for example XEBRA.
website (replaces fifth)
The hub of the software. Not the location of the downloads, those usually go in the downloads section on the article. Optional because not every project has a website (especially true of older and inactive projects for which we have articles on).
download
Optional because most articles link to builds in their downloads section instead.
support
The crowdfunding service the software uses (with a link to the account). Many projects run on contributions from their users so to help fit that into the article better, this parameter allows you to link to such service whether it be Patreon or any other; the parameter is generalized because there are other services, otherwise it'd be patreon. Optional because not every project has one set up, and it probably doesn't exist at all for inactive and outdated projects.
source (replaces sixth)
Where can the source code be found? Optional as closed-source software doesn't provide this (obviously).