Template:Page Status/doc: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
Line 4: Line 4:
This template is called with <code><nowiki>{{Page Status}}</nowiki></code> from any game's talk page. Right now it has three parameters:
This template is called with <code><nowiki>{{Page Status}}</nowiki></code> from any game's talk page. Right now it has three 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>.
=== Automatic checks ===
*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]].
This template will automatically check for missing parts of its attached page. No user input is required for this function, besides having the template on the talk page.
*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> videogallery =</code> is very similar to infobox, and also takes a signature in the same way, however by default the section is hidden, like so:
=== Manual section checks ===
*If a videogallery parameter is not found, nothing is displayed and no categories are added.
When an editor checks part of a game page, this lets them sign with <nowiki>~~~~</nowiki> to confirm that they did a thorough check, effectively saying "this will be fine to keep as-is for at least six months". It can take the following parameters:
*If a videogallery parameter is found, and it's equal to "none" (e.g. <code><nowiki>{{Page Status | videogallery = none}}</nowiki></code>), then the videogallery is assumed to have never been checked, and the page is added to [[:Category:Pages with an unchecked video gallery]].
*If a video gallery parameter is found, and it's a signature, it works the same as <code> infobox =</code> above.


<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]].
<code>
|infobox      =
 
|issuetracker =
 
|forumpage    =
 
|enhancements =
 
|videogallery =  
</code>
 
When first adding the template, each of the above should be assigned to the value <code>none</code>, to show that no test has occured for that section. The reason that it needs a "none" instead of just detecting existence of the variable is this allows for future expansion of the template to pages other than game pages.
 
=== GameIDs ===
Lastly, any IDs which an editor has failed to confirm by hand can also be added to this template to track them. This is done with the following parameters:
 
<code>
|idcheck      =
 
|id1         =  
 
|id2         =  
 
|id3         =  
 
(...)
</code>
 
After checking the IDs for a page, sign with <nowiki>~~~~</nowiki> after <code>idcheck =</code> to show that the IDs were verified, like the above sections. If in your opinion an ID needs a second opinion, add the full length of it, or as much as you know, to the <code>id# =</code>. (Since it doesn't actually do anything with the IDs besides link to them and check they exist, you can also type in ID prefixes here instead of full length ones if necessary.)


*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.
*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.
Line 23: Line 48:
*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.
*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.
*List unconfirmed GameIDs in a prominent way, and add 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.
*Track 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). The manual check functions that require signatures need error handling for incorrectly formatted input, and also need support for IP editor signatures.
The CSS can definitely be improved. Some regexes are rather complicated and are not yet implemented (grabbing latest test entry revision for example). The manual check functions that require signatures need error handling for incorrectly formatted input, and also need support for IP editor signatures.
6,906

edits

Navigation menu