Difference between revisions of "Template:Testing/doc"

From Dolphin Emulator Wiki
Jump to: navigation, search
(consolidate and update documentation, included imported text from Template:Test Entry/doc)
Line 1: Line 1:
This template should be used to display details of testing against a particular game. Use the [[Template:Test Entry]] template to add rows but remember to use the rules listed at that template. You can also use <tt>|type=</tt> to determine the kind of software, such as channel, game, or anything. When <tt>|type=</tt> is specified, template will use the string passed, or when it isn't specified, this template will return the default string ("game"). 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==
 
To add testing details use entries similar to the code below:
 
To add testing details use entries similar to the code below:
  
<pre>{{Testing|type=template}}
+
<pre>
{{Test Entry|revision=5442|OS=Windows 7 x64|CPU=Intel Core 2 Duo E7300 @ 2.6 GHz|GPU=nVidia GTX 275|result=Intro slow, but in game full speed.|tester=Link to user page}}</pre>
+
{{testing/start|type=template}}
The sample entry above will show on the game page like this (in this example <tt>|type=</tt> was set as "template"):
+
{{testing/entry|revision=5442|OS=Windows 7 x64|CPU=Intel Core 2 Duo E7300 @ 2.6 GHz|GPU=nVidia GTX 275|result=Intro slow, but in game full speed.|tester=Link to user page}}
----
+
{{testing/end}}
{{Testing|type=template}}
+
</pre>
{{Test Entry|revision=5442|OS=Windows 7 (x64)|CPU=Intel Core 2 Duo E7300 @ 2.6 GHz|GPU=nVidia GTX 275|result=Intro slow, but in game full speed.|tester=Link to user page}}
+
 
|}
+
{{testing/start|type=template}}
 +
{{testing/entry|revision=5442|OS=Windows 7 x64|CPU=Intel Core 2 Duo E7300 @ 2.6 GHz|GPU=nVidia GTX 275|result=Intro slow, but in game full speed.|tester=Link to user page}}
 +
{{testing/end}}
 +
 
 +
==Parameters==
 +
===Start===
 +
*<tt>|type=</tt> is optional, and can be used to specify the type of software, such as channel, game, or anything. When <tt>|type=</tt> is specified, template will use the string passed, or when it isn't specified, this template will return the default string ("game").
 +
 
 +
===Entry===
 +
<pre>{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}</pre>
 +
*In <tt>|revision=</tt> you must specify only the revision number, since it's parsed by [[Template:Revision]]. (The same rules of [[Template:Revision]] applies here too).
 +
*In <tt>|OS=</tt> you must specify only basic info, like OS Brand + Version + Processor architecture. (For example, Windows 7 x86 or Mac OSX 10.7 x64 or Ubuntu 10 x86-64, etc).
 +
*In <tt>|CPU=</tt> only basic information is required, like CPU Brand + Series + Model + @ + Frequency in GHz. (For example, Intel Core 2 Duo E4500 @ 2.2GHz)
 +
*Only basic info is required on <tt>|GPU=</tt> too, like GPU Brand + Series + Model, and if the GPU is on-board, + (on-board) (For example, nVidia GeForce 9800GTX, or Intel GMA 945G (on-board). For ATI GPUs, you can also use AMD as GPU Brand if you want).
 +
*In <tt>|results=</tt>. 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 [http://www.dolphin-emulator.com/performance.html performance guide]).
 +
*<tt>|tester=</tt> is optional if you aren't a registered user, and the only value that you need to put is a link to your user page. (For example <tt><nowiki>[[User:Anybody|Anybody]]</nowiki></tt>).
 +
 
 +
===End===
 +
No parameters available.

Revision as of 09:52, 4 July 2011

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=template}}
{{testing/entry|revision=5442|OS=Windows 7 x64|CPU=Intel Core 2 Duo E7300 @ 2.6 GHz|GPU=nVidia GTX 275|result=Intro slow, but in game full speed.|tester=Link to user page}}
{{testing/end}}

This title has been tested on the environments listed below:

Test Entries
Revision OS Version CPU GPU Result Tester
r5442 Windows 7 x64 Intel Core 2 Duo E7300 @ 2.6 GHz nVidia GTX 275 Intro slow, but in game full speed. Link to user page

Parameters

Start

  • |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 must specify only the revision number, since it's parsed by Template:Revision. (The same rules of Template:Revision applies here too).
  • In |OS= you must specify only basic info, like OS Brand + Version + Processor architecture. (For example, Windows 7 x86 or Mac OSX 10.7 x64 or Ubuntu 10 x86-64, etc).
  • In |CPU= only basic information is required, like CPU Brand + Series + Model + @ + Frequency in GHz. (For example, Intel Core 2 Duo E4500 @ 2.2GHz)
  • Only basic info is required on |GPU= too, like GPU Brand + Series + Model, and if the GPU is on-board, + (on-board) (For example, nVidia GeForce 9800GTX, or Intel GMA 945G (on-board). For ATI GPUs, you can also use AMD as GPU Brand if you want).
  • In |results=. 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 performance guide).
  • |tester= is optional if you aren't a registered user, and the only value that you need to put is a link to your user page. (For example [[User:Anybody|Anybody]]).

End

No parameters available.