Template:Testing/doc: Difference between revisions

Jump to navigation Jump to search
(<tt> to <code> to get a little more highlight. Also split usage in two sections like Template:Image or Template:YouTube)
mNo edit summary
Line 17: Line 17:
=== Start ===
=== Start ===
<pre>{{testing/start|type=XXX}}</pre>
<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").
*<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").


=== Entry ===
=== Entry ===
<pre>{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}</pre>
<pre>{{testing/entry|revision=|OS=|CPU=|GPU=|result=|tester=}}</pre>
*In <code>|revision=</code> 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 <code>|revision=</code> you should specify revision number like you would do with {{tl|Revision}} (The same rules apply here, so any special handling described in {{tl|Revision}} will work too).
*In <code>|OS=</code> 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 <code>|OS=</code> 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 <code>|CPU=</code> 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 <code>|CPU=</code> 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.