Editing Template:Infobox emulator

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 6: Line 6:
 
{{!}}-
 
{{!}}-
 
| }}
 
| }}
{{#if: {{{screenshot|}}} |
+
<!-- won't be used until screenshot images are implemented {{#if: {{{imagecaption|}}} |
{{!}} colspan="2" style="text-align:center;" {{!}} [[File:{{{screenshot}}}|{{{screenshotwidth|285}}}px]]
+
{{!}} colspan="2" style="text-align:center;" {{!}} {{{imagecaption}}}
{{!}}-
 
| }}
 
{{#if: {{{screenshotcaption|}}} |
 
{{!}} colspan="2" style="text-align:center; font-size:90%;" {{!}} {{{screenshotcaption}}}
 
 
{{!}}- style="border-top:1px dashed #ccc;"
 
{{!}}- style="border-top:1px dashed #ccc;"
| }}
+
| }} -->
 
{{#if: {{{orig-developer|}}} |
 
{{#if: {{{orig-developer|}}} |
 
! Original developer(s)
 
! Original developer(s)
Line 23: Line 19:
 
|-
 
|-
 
! {{#if: {{{last-version|}}} |Last version|Latest version}}
 
! {{#if: {{{last-version|}}} |Last version|Latest version}}
| {{#if: {{{last-version|}}} |{{{last-version}}}|{{{version|''N/A''}}} }}
+
| {{#if: {{{last-version|}}} |{{{last-version}}}|{{{version|''Unknown''}}} }}
 
|-
 
|-
 
{{#if: {{{active|}}} |
 
{{#if: {{{active|}}} |
Line 52: Line 48:
 
| }}
 
| }}
 
{{#if: {{{accuracy|}}} |
 
{{#if: {{{accuracy|}}} |
! [[Emulation accuracy|Accuracy]]
+
! [[Emulation Accuracy|Accuracy]]
 
{{!}} {{{accuracy}}}
 
{{!}} {{{accuracy}}}
 +
{{!}}-
 +
| }}
 +
{{#if: {{{prog-lang|}}} |
 +
! Programmed in
 +
{{!}} {{{prog-lang}}}
 
{{!}}-
 
{{!}}-
 
| }}
 
| }}
Line 69: Line 70:
 
! Download(s)
 
! Download(s)
 
{{!}} {{{download}}}
 
{{!}} {{{download}}}
{{!}}-
 
| }}
 
{{#if: {{{support|}}} |
 
! [[Support emulation projects|Support]] <small>($)</small>
 
{{!}} {{{support}}}
 
{{!}}-
 
| }}
 
{{#if: {{{prog-lang|}}} |
 
! Programmed in
 
{{!}} {{{prog-lang}}}
 
{{!}}-
 
| }}
 
{{#if: {{{license|}}} |
 
! [[Source_code#Licensing|License]]
 
{{!}} {{{license}}}
 
 
{{!}}-
 
{{!}}-
 
| }}
 
| }}
Line 89: Line 75:
 
! [[Source code]]
 
! [[Source code]]
 
{{!}} {{{source}}}
 
{{!}} {{{source}}}
{{!}}-
 
| }}
 
{{#if: {{{issuetracker|}}} |
 
! Issue tracker
 
{{!}} {{{issuetracker}}}
 
{{!}}-
 
| }}
 
{{#if: {{{bios|}}} |
 
! [[Emulator_files|BIOS/Keys]]
 
{{!}} {{{bios}}}
 
 
{{!}}-
 
{{!}}-
 
| }}
 
| }}
Line 106: Line 82:
 
|}</onlyinclude><noinclude><br style="clear:both;"/>
 
|}</onlyinclude><noinclude><br style="clear:both;"/>
 
<center><big>'''Infobox emulator'''</big></center>
 
<center><big>'''Infobox emulator'''</big></center>
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.
+
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.
__NOTOC__
+
 
 
==Example==
 
==Example==
===Empty layout===
+
:''Note: This example is not shown because the markup is on the same page as the template itself and thus would be recursive.''
<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
 
<pre>{{Infobox emulator
 
|title        = higan
 
|title        = higan
Line 138: Line 94:
 
|version      = {{higanVer}}
 
|version      = {{higanVer}}
 
|active        = Yes
 
|active        = Yes
|platform      = [[Emulators on Windows|Windows]]<br/>[[Emulators on macOS|macOS]]<br/>[[Emulators on Linux|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/>[[Sega 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/>[[Genesis emulators|MD]]<br/>''others''
|compatibility = <small>100% for commercial titles<br/>Some homebrew may have small defects</small>
+
|compatibility = 100% for commercial titles<br/>Some homebrew may have small defects
 
|accuracy      = Cycle-accurate
 
|accuracy      = Cycle-accurate
 
|website      = [http://byuu.org/emulation/higan/ byuu.org]
 
|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 -->
 
|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]
 
|source        = [https://gitlab.com/higan/higan GitLab]
|bios          = [[Emulator_files#SNES_.2F_Super_Famicom|Required for some games]]
 
 
}}</pre>
 
}}</pre>
  
===Render===
+
==Parameters==
{{Infobox emulator
 
|title        = higan
 
|logo          = Icon.png
 
|logowidth    = 160
 
|developer    = byuu et al.
 
|version      = {{higanVer}}
 
|active        = Yes
 
|platform      = [[Emulators on Windows|Windows]]<br/>[[Emulators on macOS|macOS]]<br/>[[Emulators on Linux|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 in the box. You can technically place 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 can get confusing as the template is designed to have the values show up only one way.
+
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.
 
;<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. 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.
+
:The name of the emulator. If no value is given, it will default to the name of the page instead.
 
;<code>logo</code> <small>(replaces <code>image</code>)</small>
 
;<code>logo</code> <small>(replaces <code>image</code>)</small>
 
: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 either exceed the size of the infobox, or have a more vertical (and thus uncomfortable) aspect ratio.
+
: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).
;<code>screenshot</code>
 
:Used to put screenshots of the program in. This is optional for a few reasons, the most compelling being that some emulators run from the terminal and don't have a recognizable user interface.
 
;<code>screenshotwidth</code>
 
:Also optional. Set the 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>
 
;<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.
 
;<code>developer</code> <small>(replaces <code>fourth</code>)</small>
 
;<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 as "(project) Team". Leave it unanswered and it will say "''Anonymous/Unidentified''".
+
: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''".
 
;<code>version</code> <small>(replaces <code>first</code>)</small>
 
;<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> (or  <code><nowiki>{{ Version|(Project) }}</nowiki></code>, see [[Template:Version]] to know which to use). 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".
+
: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.
 
:;<code>last-version</code>
 
:;<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.
 
::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.
Line 200: Line 126:
 
::If the project is defunct and no longer in development, what happened to the project? '''Do not use for active projects (obviously).'''
 
::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>
 
;<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).
+
: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.
:'''List clearly the operating systems and consoles the emulator's standalone package runs on, including the names of the platforms.''' Do not use "multi-platform" as a replacement for 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, this doesn't apply because the infobox is a fixed width and can handle the list.
 
 
;<code>architecture</code>
 
;<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.
 
: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.
Line 209: Line 134:
 
: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?
 
: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?
 
;<code>accuracy</code>
 
;<code>accuracy</code>
:How [[Emulation accuracy|accurate]] the emulator is. Optional.
+
:How [[Emulation Accuracy|accurate]] the emulator is. Optional.
 
;<code>prog-lang</code>
 
;<code>prog-lang</code>
 
:Optional, especially given that it's difficult to determine what programming languages closed-source projects use.
 
:Optional, especially given that it's difficult to determine what programming languages closed-source projects use.
Line 217: Line 142:
 
: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).
 
: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).
 
;<code>download</code>
 
;<code>download</code>
:Optional because most articles link to builds in their downloads section instead.
+
:Optional because the most articles link to builds in their downloads section.
;<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>
 
;<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).
 
: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.
 
 
</center><noinclude>[[Category:Infobox templates]]</noinclude>
 
 
</noinclude>
 
</noinclude>

Please note that all contributions to Emulation General Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Emulation General Wiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)