Progress Continues
We've already had 21646 updates since Dolphin 5.0. Keep up with Dolphin's continuing progress through the Dolphin Blog: February, March, and April 2024 Dolphin Progress Report.
User-info.png The Dolphin Emulator Wiki needs your help!
Dolphin can play thousands of games, and changes are happening all the time. Help us keep up! Join in and help us make this the best resource for Dolphin.

Template:Page Status/doc: Difference between revisions

Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:


== Usage ==
== Usage ==
This template is called with <code><nowiki>{{Page Status}}</nowiki></code> from any game's talk page. While most of its functionality is automatic, it can also take unconfirmed GameIDs as parameters to display them and track them with a category; this is done with <code><nowiki>{{Page Status | id1 = G12E34 | id2 = G56P78 | id3 = ...}}</nowiki></code>. There is no limit on the amount of IDs that it can take, as it uses a loop to go through all of them. The only restriction is that there can't be any gaps between the id numbers; if you wish to display three IDs, they must be assigned to id1, id2, and id3.
This template is called with <code><nowiki>{{Page Status}}</nowiki></code> from any game's talk page. Right now it only has two parameters:
 
<code> infobox =</code> is used when an editor checks the validity of a page's infobox to sign that the infobox has been checked. The value after the equals sign should be a standard <nowiki>~~~~</nowiki> signature (manually typed signatures are allowed, but they must follow the normal signature's format exactly). An example of usage would be <code><nowiki>{{Page Status | infobox = ~~~~}}</nowiki></code>.
*If an infobox parameter is not found, the infobox is assumed to have never been checked, and the page is added to [[:Category:Pages with an unchecked infobox]].
*If an infobox parameter is found, the date is extracted and converted to a Unix timestamp for arithmetic, then compared to the "current time" (the last time the cache for the page was refreshed). If the difference is greater than 6 months, the page is added to [[:Category:Pages with an infobox checked over 6 months ago]]. The editor's name and the date of the edit are also displayed by the template.
*'''Note:''' custom signatures do not work with this parameter. Thankfully, nobody on the wiki currently uses them.
 
<code> id# =</code> is used to add unconfirmed IDs to the template. An example usage would be <code><nowiki>{{Page Status | id1 = G12E34 | id2 = G56P78 | id3 = ...}}</nowiki></code>. If there's at least one id parameter specified, the page is added to [[Category:Pages with unconfirmed GameIDs]].
 
*There is no limit on the amount of IDs that it can take, as it uses a loop to go through all of them. The only restriction is that there can't be any gaps between the id numbers; to display three IDs for example, those IDs must be assigned to id1, id2, and id3.


== Function ==
== Function ==
Page Status transcludes the entirety of the game page that it's associated with in order to interact with its contents from the talk page. It then uses regex to either find whether or not a section exists, or extract information such as the latest testing and version compatibility revision which can then be used for other operations. It also supports user submitted unconfirmed IDs, to help better track and draw attention to them.
Page Status can currently do the following things:
 
*Transclude the entirety of the game page that it's associated with to a variable in order to interact with its contents from the talk page. This allows the template to do checks for things such as missing page sections or improper formatting through clever regex usage.
 
*List unconfirmed GameIDs in a prominent way, and adds them to a category which will allow the ability to quickly see what games need confirmation by title.
 
*Tracks when the last time a section of a page was cleaned up by having users sign on the talk page for the section they checked.


== TODO ==
== TODO ==
The CSS can definitely be improved. Some regexes are rather complicated and are not yet implemented (grabbing latest test entry revision for example). It might be excessive having categories for all the different missing sections, they could probably be trimmed down to just a few.
The CSS can definitely be improved. Some regexes are rather complicated and are not yet implemented (grabbing latest test entry revision for example).
Retrieved from "https://wiki.dolphin-emu.org/index.php?title=Template:Page_Status/doc"