Changes

Jump to navigation Jump to search

Template:Infobox emulator

4,108 bytes added, 03:01, 29 July 2021
From latest Wayback Machine snapshot
{{!}}-
| }}
<{{#if: {{{screenshot|}}} |{{!}} colspan="2" style="text-align:center;" {{!}} [[File:{{{screenshot}}}|{{{screenshotwidth|285}}}px]]{{!}}- won't be used until screenshot images are implemented | }}{{#if: {{{imagecaptionscreenshotcaption|}}} |{{!}} colspan="2" style="text-align:center; font-size:90%;" {{!}} {{{imagecaptionscreenshotcaption}}}
{{!}}- style="border-top:1px dashed #ccc;"
| }} -->
{{#if: {{{orig-developer|}}} |
! Original developer(s)
|-
! {{#if: {{{last-version|}}} |Last version|Latest version}}
| {{#if: {{{last-version|}}} |{{{last-version}}}|{{{version|''UnknownN/A''}}} }}
|-
{{#if: {{{active|}}} |
! [[Emulation Accuracy|Accuracy]]
{{!}} {{{accuracy}}}
{{!}}-
| }}
{{#if: {{{prog-lang|}}} |
! Programmed in
{{!}} {{{prog-lang}}}
{{!}}-
| }}
! Download(s)
{{!}} {{{download}}}
{{!}}-
| }}
{{#if: {{{support|}}} |
! [[Support emulation projects|Support]] <small>($)</small>
{{!}} {{{support}}}
{{!}}-
| }}
{{#if: {{{prog-lang|}}} |
! Programmed in
{{!}} {{{prog-lang}}}
{{!}}-
| }}
{{#if: {{{license|}}} |
! [[Source_code#Licensing|License]]
{{!}} {{{license}}}
{{!}}-
| }}
! [[Source code]]
{{!}} {{{source}}}
{{!}}-
| }}
{{#if: {{{bios|}}} |
! [[Emulator_Files|BIOS/Keys]]
{{!}} {{{bios}}}
{{!}}-
| }}
|}</onlyinclude><noinclude><br style="clear:both;"/>
<center><big>'''Infobox emulator'''</big></center>
Infobox An infobox for pages about detailing specific emulators. This role is currently being taken up by It's an improvement from [[Template:Infobox|the original template]], but this version is improved. It now looks like with a design closely modelled from Wikipedia's primary infobox, and allows with support for much a lot more parameters, listed below. Many Most parameters are optional, and have explanations as to ''why'' they but are optionalexplained below.__NOTOC__
==Example==
:''Note: This example is not shown because the markup is on the same page as the template itself and thus would be recursive.''===Empty Layout===<pre>{{Infobox emulator|title = |logo = |logowidth = |developer = |version = |active = |platform = |architecture = |target = |compatibility = |accuracy = |website = |prog-lang =|support =|license =|source =|bios =}}</pre>
===Filled Layout===
<pre>{{Infobox emulator
|title = higan
|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 -->
|support = [https://www.patreon.com/byuu Patreon]
|license = GNU GPL v3
|source = [https://gitlab.com/higan/higan GitLab]
|bios = [[Emulator_Files#SNES_.2F_Super_Famicom|Required for some games]]
}}</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|support = [https://www.patreon.com/byuu Patreon]|license = GNU GPL v3|source = [https://gitlab.com/higan/higan GitLab]|bios = [[Emulator_Files#SNES_.2F_Super_Famicom|Required for some games]]}} <h2 style="width:100%">Parameters</h2>
The order of parameters here are arranged according to the order they are displayed on in the pagebox. You can technically place these each parameter in any order you want (as opposed to <code>first</code>, <code>second</code>, <code>third</code>, etc.)in the markup, but it's discouraged because can get confusing as the template is designed to have the values will only show up only one way. That's how the template is designed.
;<code>title</code>
:The name of the emulator. If no value is given, it will default to the name of the page instead. This one might be necessary for emulators that are not capitalized (and also make sure {{t|lowercase title}} is included on the page) because the default behavior relies on MediaWiki's internal name for the page.
;<code>logo</code> <small>(replaces <code>image</code>)</small>
:Used to put logos in. It's optional.
;<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 either exceed the size of the infobox, or have a more vertical (and thus uncomfortable) aspect ratio.;<code>screenshot</code>:Used to be seen put screenshots of the program in. This is optional for a few reasons, the most compelling being that arensome emulators run from the terminal and don't visible at have a recognizable user interface.;<code>screenshotwidth</code>:Also optional. Set the default size (210 pixels wide)width of the screenshot. This may be necessary for programs that only output in much more square aspect ratios like 4:3 and thus extend the infobox a fair bit.;<code>screenshotcaption</code>:What is the screenshot showing? Optional because in many cases the image is self-explanatory, though details may be added if desired.
;<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.
;<code>developer</code> <small>(replaces <code>fourth</code>)</small>
:Who's making the emulator? If the project is inactive, then who ''made'' the emulator? If the project is on GitHub, you can link it to the contributors page and say as "(project) Team". Leave it unanswered and it will say "''Anonymous/Unidentified''".
;<code>version</code> <small>(replaces <code>first</code>)</small>
: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 <code><nowiki>{{ (Project)Ver }}</nowiki></code>. See the pages of other emulators if you're confused. For the targeted platform's own table, apply the same template there. For open-source projects that don't have a version system in place, you can use Git (as is often done on the comparison table). Leave it unanswered and it will say "N/A".
:;<code>last-version</code>
::Replaces <code>version</code> (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.
::If the project is defunct and no longer in development, what happened to the project? '''Do not use for active projects (obviously).'''
;<code>platform</code> <small>(replaces <code>third</code>)</small>
:What platforms does the emulator run on? Often called the host in virtualization. Required because it's gotta run somewhere. If the emulator has a libretro core, include libretro (but do not use RetroArch in place of libretro).:'''List clearly the operating systems and consoles (if it has a the emulator's standalone package runs on, including the names of the platforms.''' Do not use "multi-platform" as a replacement for them)a clear list of platforms, and do not justify it with the fact that it's used on the console page. That usage is different because, in that context, it signifies that the number of platforms the emulator is available for is too many to show in an overview, and that the full list would make the table too wide on smaller displays. When transferred to the emulator's page itself however, otherwise put libretro if they have libretro coresthis doesn't apply because the infobox is a fixed width and can handle the list.
;<code>architecture</code>
: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.
;<code>download</code>
:Optional because most articles link to builds in their downloads section instead.
;<code>support</code>
:The crowdfunding service the emulator uses (with a link to the account). [[Emulators on Patreon|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 <code>patreon</code>. Optional because not every project has one set up, and it probably doesn't exist at all for inactive and outdated projects.
;<code>source</code> <small>(replaces <code>sixth</code>)</small>
:Where can the source code be found? Optional as closed-source emulators don't provide this (obviously).
;<code>bios</code>
:Does the emulator require any additional files/BIOS/keys to run? Link to the appropriate section in [[Emulator Files]] if applicable.
 
[[Category:General wiki templates]]
[[Category:Infobox templates]]
</noinclude>
2,527
edits

Navigation menu