Template:Issue: Difference between revisions

From PCSX2 Wiki
Jump to navigation Jump to search
m (Removing bg coloring, because um... frankly, the color scheme is not good.)
(Added parameter to better indicate when an issue was tested. For example, if an issue is very old, it is more likely that re-testing will discover that it has been fixed. Likewise, if an issue is very new, it indicates to the user that they should try the workaround.)
Line 8: Line 8:
|1=Serious{{#switch:{{{IsFixed}}}|0=[[Category:Games with serious issues]]}}
|1=Serious{{#switch:{{{IsFixed}}}|0=[[Category:Games with serious issues]]}}
|2=Major{{#switch:{{{IsFixed}}}|0=[[Category:Games with major issues]]}}
|2=Major{{#switch:{{{IsFixed}}}|0=[[Category:Games with major issues]]}}
|-1=Note (not an issue)}}}}{{#if:{{{AffectedVersions|}}}|* '''Affected Game Versions:''' {{{AffectedVersions}}}}}{{#if:{{{Description|}}}|* '''Description:''' {{{Description}}}|[[Category:Games with unfinished issue entries]]}}{{#if:{{{Workaround|}}}|*  '''Workaround:''' {{{Workaround}}}}}</includeonly><noinclude>{{documentation}}</noinclude>
|-1=Note (not an issue)}}}}{{#if:{{{AffectedVersions|}}}|* '''Affected Game Versions:''' {{{AffectedVersions}}}}}{{#if:{{{Description|}}}|* '''Description:''' {{{Description}}}|[[Category:Games with unfinished issue entries]]}}{{#if:{{{Workaround|}}}|*  '''Workaround:''' {{{Workaround}}}}}{{#if:{{{TestedOn|}}}|*  '''Tested on:''' {{{TestedOn}}}}}</includeonly><noinclude>{{documentation}}</noinclude>

Revision as of 22:39, 1 April 2024

Documentation ()

This template is used as an issue entry. It includes the following variables:

  • IssueName: The name of the issue (should be present)
  • IsFixed: 0 or 1 (is this issue already fixed and listed here for historical reasons) (can be omitted)
  • IssueLevel: -1,0,1 or 2 (severity level: note, minor, serious and major accordingly) (can be omitted). You can use notes to store some valuable info to avoid obvious issues.
  • AffectedVersions: Which game versions are affected by this issue (can be omitted)
  • Description: Issue description (should be present)
  • Workaround: Issue workaround (can be omitted)
  • FirstTestedOn: The version of PCSX2 this issue was originally discovered on by the tester.
  • LastTestedOn: The latest version of PCSX2 that this issue was tested on.

Usage example:

==Known Issues==

{{Issue
|IssueName=Auron Look!
|IsFixed=1
|IssueLevel=2
|AffectedVersions=All
|Description=Game crashes during the introduction of the game, right after Auron states "Look!"
|Workaround=May need a correct ISO, don't use virtual mount software either.
|FirstTestedOn=1.4.0
|LastTestedOn=1.7.1234
}}
...

Result:

Known Issues

Auron Look!

  • Status: Fixed
  • Type: Major
  • Affected Game Versions: All
  • Description: Game crashes during the introduction of the game, right after Auron states "Look!"
  • Workaround: May need a correct ISO, don't use virtual mount software either.