Template:Testing/doc: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(→‎Entry: I'm sure I've seen some users include their HD settings. I think this shouldn't be enforced anymore. They can say whatever they want in their result summary.)
mNo edit summary
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== About ==
This three-part '''testing''' template should be used to display details of testing against a particular game. Use the {{tl|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.
This three-part '''testing''' template should be used to display details of testing against a particular game. Use the {{tl|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 ==
=== Neighboring Templates ===
To add testing details use entries similar to this code (it'll result in what you see in Example section below):
* [[Template:Testing/start]]
* [[Template:Testing/entry]]
* [[Template:Testing/end]]
 
== Example ==
<pre>
<pre>
{{testing/start|type=XXX}}
{{testing/start}}
{{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/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>


== Example ==
Produces
{{testing/start|type=XXX}}
<div style="background:#fff;border:1px solid #ddd;padding:.5em">
{{testing/start}}
{{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/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}}</div>


== Parameters ==
== Parameters ==
=== Start ===
=== Start ===
<pre>{{testing/start|type=XXX}}</pre>
<pre>{{testing/start}}</pre>
*<code>|type=</code> 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").
No parameters needed.


=== Entry ===
=== Entry ===
Line 31: Line 37:
<pre>{{testing/end}}</pre>
<pre>{{testing/end}}</pre>
No parameters needed.
No parameters needed.
=== Categories ===
The categories below are generated by these templates and provide some data quality checks.
*[[:Category:Testing Templates missing details]] ({{PAGESINCAT:Testing Templates missing details}})
**[[:Category:Testing Templates missing revision details]] ({{PAGESINCAT:Testing Templates missing revision details}})
**[[:Category:Testing Templates missing OS details]] ({{PAGESINCAT:Testing Templates missing OS details}})
**[[:Category:Testing Templates missing GPU details]] ({{PAGESINCAT:Testing Templates missing GPU details}})
**[[:Category:Testing Templates missing result details]] ({{PAGESINCAT:Testing Templates missing result details}})
**[[:Category:Testing Templates missing tester details]] ({{PAGESINCAT:Testing Templates missing tester details}})
*[[:Category:Testing Templates  out of order]] ({{PAGESINCAT:Testing Templates  out of order}})
The categories below are generated by these templates and provide age of testing details.
*[[:Category:Tested]] ({{PAGESINCAT:Tested}})
*[[:Category:Untested for...]]
**[[:Category:Untested]] ({{PAGESINCAT:Untested}})
**[[:Category:Untested for 10000+ revisions]] ({{PAGESINCAT:Untested for 10000+ revisions}})
**[[:Category:Untested for 5000+ revisions]] ({{PAGESINCAT:Untested for 5000+ revisions}})
**[[:Category:Untested for 2500+ revisions]] ({{PAGESINCAT:Untested for 2500+ revisions}})
**[[:Category:Untested for 1000+ revisions]] ({{PAGESINCAT:Untested for 1000+ revisions}})
**[[:Category:Untested for 500+ revisions]] ({{PAGESINCAT:Untested for 500+ revisions}})

Revision as of 00:31, 18 January 2018

About

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.

Neighboring Templates

Example

{{testing/start}}
{{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}}

Produces

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}}

No parameters needed.

Entry

{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}
  • In |revision= you should specify revision number like you would do with {{Revision}} (The same rules apply here, so any special handling described in {{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-6700K @ 4GHz, 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").
  • 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.