Template:Testing/doc: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(Geez, that documentation was veeeery old! Rewrote some parts and added some new bits based on what we see today)
Line 6: Line 6:
<pre>
<pre>
{{testing/start|type=XXX}}
{{testing/start|type=XXX}}
{{testing/entry|revision=3.5-123|OS=Windows 7 x64|CPU=Intel Core 2 Duo E7300 @ 2.6GHz|GPU=NVIDIA GeForce GTX 275|result=Intro slow, but in game full speed.|tester=Tester name}}
{{testing/entry|revision=4.0-7654|OS=Windows 7|CPU=Intel Core i5-4690K @ 3.5GHz|GPU=NVIDIA GeForce GTX 960|result=Intro slow, but in game full speed.|tester=User name}}
{{testing/end}}
{{testing/end}}
</pre>
</pre>


{{testing/start|type=XXX}}
{{testing/start|type=XXX}}
{{testing/entry|revision=3.5-123|OS=Windows 7 x64|CPU=Intel Core 2 Duo E7300 @ 2.6GHz|GPU=NVIDIA GeForce GTX 275|result=Intro slow, but in game full speed.|tester=Tester name}}
{{testing/entry|revision=4.0-7654|OS=Windows 7|CPU=Intel Core i5-4690K @ 3.5GHz|GPU=NVIDIA GeForce GTX 960|result=Intro slow, but in game full speed.|tester=User name}}
{{testing/end}}
{{testing/end}}


== Parameters ==
== Parameters ==
=== Start ===
=== Start ===
*<var>|type=</var> is optional, and can be used to specify the type of software, such as channel, game, or anything. When <var>|type=</var> is specified, template will use the string passed, or when it isn't specified, this template will return the default string ("game").
<pre>{{testing/start|type=XXX}}</pre>
*<tt>|type=</tt> is optional, and can be used to specify the type of software, such as channel, game, or anything. When <var>|type=</var> is specified, template will use the string passed, or when it isn't specified, this template will return the default string ("game").


=== Entry ===
=== Entry ===
<pre>{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}</pre>
<pre>{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}</pre>
*In <var>|revision=</var> you must specify only the revision number, since it's parsed by [[Template:Revision]] (The same rules of [[Template:Revision]] apply here, and special handling is included for "2.0" and "3.0" releases).
*In <tt>|revision=</tt> you should specify revision number like you would do with [[Template:Revision]] (The same rules apply here, so any special handling described in [[Template:Revision]] will work too).
*In <tvar>|OS=</var> you must specify only basic info, like OS Brand (or Linux Distro) + Version (For example, Windows 7 or Mac OS X 10.7, Ubuntu 10, etc).  
*In <tt>|OS=</tt> you should provide basic details of your operating system, like OS Brand + Version (e.g. Windows 7, Mac OS X 10.10, Ubuntu 15.04, Android 5.1, etc). For Linux test entries you should specify the official distro naming followed by version. Also, avoid listing OS edition (e.g. Windows 7 Home Premium) and use a version number instead of a release name whenever possible (e.g. Debian 7 instead of Debian Wheezy, Android 5.1 instead of Android Lollipop, Mac OS X 10.10 instead of Mac OS X Yosemite, etc).
*In <var>|CPU=</var> only basic information is required, like CPU Brand + Series + Model + @ + Frequency in GHz (For example, Intel Core 2 Duo E4500 @ 2.2GHz).
*In <tt>|CPU=</tt> you should provide only basic information, like CPU Brand + Series + Model + @ + Frequency in GHz (e.g. Intel Core i5-4690K @ 3.5GHz, AMD FX-6300 @ 3.5GHz). On CPUs with variable clock speed features (like Intel Turbo Boost or AMD Turbo Core) you should provide the base clock or, if overclocked, the frequency you were using when testing (e.g. Intel Pentium G3258 @ 4.2GHz). Other details such as number of cores, cache size, architecture and similar are not needed and should not be listed.
*Only basic info is required on <var>|GPU=</var> too, like GPU Brand + Series + Model (For example, AMD Radeon HD 6450, ATI Radeon HD 5670, NVIDIA GeForce 9800 GTX, or Intel GMA 945G).
*In <tt>|GPU=</tt> the same guidelines from CPU applies here as well, provide basic information like GPU Brand + Series + Model (e.g. AMD Radeon R9 290X, AMD Radeon HD 7990, NVIDIA GeForce GTX 970, NVIDIA GeForce GTX Titan X, Intel HD Graphics 4600, etc). Other details such as GPU Maker, whether it's a factory overclocked model or not, VRAM size and similar are not needed and should not be listed either.
*In <var>|results=</var>. write only the essential! (For example, "Playable 40-60 FPS, intro slow" or "Slow: 25-35 FPS in game due slow CPU (or GPU)". Please doesn't include Dolphin configuration, since we assume that test environment is set as recommended settings described on game page or in the [[Performance Guide]]).
*In <tt>|results=</tt> write a brief description of how Dolphin performed (e.g. "Playable: 40-60 FPS, intro slow" or "Slow: 25-35 FPS in game due slow CPU"). Avoid including Dolphin settings since we assume that test environment is set as recommended settings described on game page or in the [[Performance Guide]].
*<var>|tester=</var> tester ID (i.e. one's name or alias), will link to a user page if one exists.
*In <tt>|tester=</tt> you should list your nickname or alias, it'll automatically link to a user page if a wiki account with the same name/alias exists.


=== End ===
=== End ===
No parameters available.
<pre>{{testing/end}}</pre>
No parameters needed.

Revision as of 04:00, 17 November 2015

This three-part testing template should be used to display details of testing against a particular game. Use the {{testing/start}} template to add rows but remember to use the rules listed in the "parameters" section below. Please list entries in chronological order; oldest to newest, top to bottom.

Usage

To add testing details use entries similar to the code below:

{{testing/start|type=XXX}}
{{testing/entry|revision=4.0-7654|OS=Windows 7|CPU=Intel Core i5-4690K @ 3.5GHz|GPU=NVIDIA GeForce GTX 960|result=Intro slow, but in game full speed.|tester=User name}}
{{testing/end}}

This title has been tested on the environments listed below:

Test Entries
Revision OS CPU GPU Result Tester
4.0-7654 Windows 7 Intel Core i5-4690K @ 3.5GHz NVIDIA GeForce GTX 960 Intro slow, but in game full speed. User name

Parameters

Start

{{testing/start|type=XXX}}
  • |type= is optional, and can be used to specify the type of software, such as channel, game, or anything. When |type= is specified, template will use the string passed, or when it isn't specified, this template will return the default string ("game").

Entry

{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}
  • In |revision= you should specify revision number like you would do with Template:Revision (The same rules apply here, so any special handling described in Template:Revision will work too).
  • In |OS= you should provide basic details of your operating system, like OS Brand + Version (e.g. Windows 7, Mac OS X 10.10, Ubuntu 15.04, Android 5.1, etc). For Linux test entries you should specify the official distro naming followed by version. Also, avoid listing OS edition (e.g. Windows 7 Home Premium) and use a version number instead of a release name whenever possible (e.g. Debian 7 instead of Debian Wheezy, Android 5.1 instead of Android Lollipop, Mac OS X 10.10 instead of Mac OS X Yosemite, etc).
  • In |CPU= you should provide only basic information, like CPU Brand + Series + Model + @ + Frequency in GHz (e.g. Intel Core i5-4690K @ 3.5GHz, AMD FX-6300 @ 3.5GHz). On CPUs with variable clock speed features (like Intel Turbo Boost or AMD Turbo Core) you should provide the base clock or, if overclocked, the frequency you were using when testing (e.g. Intel Pentium G3258 @ 4.2GHz). Other details such as number of cores, cache size, architecture and similar are not needed and should not be listed.
  • In |GPU= the same guidelines from CPU applies here as well, provide basic information like GPU Brand + Series + Model (e.g. AMD Radeon R9 290X, AMD Radeon HD 7990, NVIDIA GeForce GTX 970, NVIDIA GeForce GTX Titan X, Intel HD Graphics 4600, etc). Other details such as GPU Maker, whether it's a factory overclocked model or not, VRAM size and similar are not needed and should not be listed either.
  • In |results= write a brief description of how Dolphin performed (e.g. "Playable: 40-60 FPS, intro slow" or "Slow: 25-35 FPS in game due slow CPU"). Avoid including Dolphin settings since we assume that test environment is set as recommended settings described on game page or in the Performance Guide.
  • In |tester= you should list your nickname or alias, it'll automatically link to a user page if a wiki account with the same name/alias exists.

End

{{testing/end}}

No parameters needed.