Difference between revisions of "Template:Infobox emulator"

From Emulation General Wiki
Jump to navigation Jump to search
m (actually it might be confused with troubleshooting)
(Some rewrites and an example render (it's actually not recursive because of the noinclude element))
Line 87: Line 87:
 
|}</onlyinclude><noinclude><br style="clear:both;"/>
 
|}</onlyinclude><noinclude><br style="clear:both;"/>
 
<center><big>'''Infobox emulator'''</big></center>
 
<center><big>'''Infobox emulator'''</big></center>
Infobox for pages about specific emulators. This role is currently being taken up by [[Template:Infobox]], but this version is improved. It now looks like Wikipedia's primary infobox, and allows for much more parameters, listed below. Many parameters are optional, and have explanations as to ''why'' they are optional.
+
An infobox for pages detailing specific emulators. It's an improvement from [[Template:Infobox|the original template]], with a design closely modelled from Wikipedia, and with support for a lot more parameters. Most parameters are optional but are explained below.
 
+
__NOTOC__
 
==Example==
 
==Example==
:''Note: This example is not shown because the markup is on the same page as the template itself and thus would be recursive.''
+
===Layout===
 
 
 
<pre>{{Infobox emulator
 
<pre>{{Infobox emulator
 
|title        = higan
 
|title        = higan
Line 101: Line 100:
 
|platform      = Windows<br/>macOS<br/>Linux<br/>libretro
 
|platform      = Windows<br/>macOS<br/>Linux<br/>libretro
 
|architecture  = x86_64
 
|architecture  = x86_64
|target        = [[Nintendo Entertainment System emulators|NES]]<br/>[[Super Nintendo emulators|SNES]]<br/>[[Game Boy / Game Boy Color emulators|GB]]<br/>[[Genesis emulators|MD]]<br/>''others''
+
|target        = [[Nintendo Entertainment System emulators|NES]]<br/>[[Super Nintendo emulators|SNES]]<br/>[[Game Boy/Game Boy Color emulators|GB]]<br/>[[Sega Genesis emulators|MD]]<br/>''others''
|compatibility = 100% for commercial titles<br/>Some homebrew may have small defects
+
|compatibility = <small>100% for commercial titles<br/>Some homebrew may have small defects</small>
 
|accuracy      = Cycle-accurate
 
|accuracy      = Cycle-accurate
 
|website      = [http://byuu.org/emulation/higan/ byuu.org]
 
|website      = [http://byuu.org/emulation/higan/ byuu.org]
Line 109: Line 108:
 
}}</pre>
 
}}</pre>
  
==Parameters==
+
===Render===
 +
{{Infobox emulator
 +
|title        = higan
 +
|logo          = Icon.png
 +
|logowidth    = 160
 +
|developer    = byuu et al.
 +
|version      = {{higanVer}}
 +
|active        = Yes
 +
|platform      = Windows<br/>macOS<br/>Linux<br/>libretro
 +
|architecture  = x86_64
 +
|target        = [[Nintendo Entertainment System emulators|NES]]<br/>[[Super Nintendo emulators|SNES]]<br/>[[Game Boy/Game Boy Color emulators|GB]]<br/>[[Sega Genesis emulators|MD]]<br/>''others''
 +
|compatibility = <small>100% for commercial titles<br/>Some homebrew may have small defects</small>
 +
|accuracy      = Cycle-accurate
 +
|website      = [http://byuu.org/emulation/higan/ byuu.org]
 +
|prog-lang    = C
 +
|source        = [https://gitlab.com/higan/higan GitLab]
 +
}}
 +
 
 +
<h2 style="width:100%">Parameters</h2>
  
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 (as opposed to <code>first</code>, <code>second</code>, <code>third</code>, etc.), but it's discouraged because the values will only show up one way. That's how the template is designed.
+
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 (as opposed to <code>first</code>, <code>second</code>, <code>third</code>, etc.), but it's discouraged because the template is designed to have the values show up only one way.
 
;<code>title</code>
 
;<code>title</code>
 
:The name of the emulator. If no value is given, it will default to the name of the page instead.
 
:The name of the emulator. If no value is given, it will default to the name of the page instead.
Line 117: Line 134:
 
:Used to put logos in. It's optional.
 
:Used to put logos in. It's optional.
 
;<code>logowidth</code> <small>(replaces <code>imagewidth</code>)</small>
 
;<code>logowidth</code> <small>(replaces <code>imagewidth</code>)</small>
:Also optional. Set the width of the logo. Might be useful for logos that require detail to be seen that aren't visible at the default size (210 pixels wide).
+
: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.
 
;<code>orig-developer</code>
 
;<code>orig-developer</code>
 
:If development was passed onto other people, use this to write the original developer (and use <code>developer</code> for the current). This will change the text accordingly, and is optional.
 
:If development was passed onto other people, use this to write the original developer (and use <code>developer</code> for the current). This will change the text accordingly, and is optional.

Revision as of 19:26, 2 April 2018

Infobox emulator
Developer(s) Anonymous/Unidentified
Latest version Unknown
Platform(s) {{{platform}}}
Emulates {{{target}}}


Infobox emulator

An infobox for pages detailing specific emulators. It's an improvement from the original template, with a design closely modelled from Wikipedia, and with support for a lot more parameters. Most parameters are optional but are explained below.

Example

Layout

{{Infobox emulator
|title         = higan
|logo          = Icon.png
|logowidth     = 160
|developer     = byuu et al.
|version       = {{higanVer}}
|active        = Yes
|platform      = Windows<br/>macOS<br/>Linux<br/>libretro
|architecture  = x86_64
|target        = [[Nintendo Entertainment System emulators|NES]]<br/>[[Super Nintendo emulators|SNES]]<br/>[[Game Boy/Game Boy Color emulators|GB]]<br/>[[Sega Genesis emulators|MD]]<br/>''others''
|compatibility = <small>100% for commercial titles<br/>Some homebrew may have small defects</small>
|accuracy      = Cycle-accurate
|website       = [http://byuu.org/emulation/higan/ byuu.org]
|prog-lang     = C <!-- this may not actually be true, it could also be C++, but this is just an example -->
|source        = [https://gitlab.com/higan/higan GitLab]
}}

Render

higan
Icon.png
Developer(s) byuu et al.
Latest version v110
Active Yes
Platform(s) Windows
macOS
Linux
libretro
Architecture(s) x86_64
Emulates NES
SNES
GB
MD
others
Compatibility 100% for commercial titles
Some homebrew may have small defects
Accuracy Cycle-accurate
Programmed in C
Website byuu.org
Source code GitLab

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 (as opposed to first, second, third, etc.), but it's discouraged because the template is designed to have the values show up only one way.

title
The name of the emulator. 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 emulator? If the project is inactive, then who made the emulator? 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 }}. See the pages of other emulators if you're confused. For the targeted platform's own table, apply the same template there.
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 emulator run on? Often called the host in virtualization. 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 emulator coded for? Not to be confused with the target architecture, which will always be the same so long as you target the same device.
target
What platforms does the emulator... well, emulate? Often called the guest in virtualization. Required because it's gotta emulate something to be an emulator. Be sure to link to the target's own page.
compatibility
This one's optional, since there's no universally accepted metric for what counts as compatible, but essentially... does it run every game? What can it run?
accuracy
How accurate the emulator is. Optional.
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 emulator. 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 emulator 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 emulators don't provide this (obviously).