Template:Page Status/doc: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
Line 1: Line 1:
Because this template needs a game page and a discussion page to function, please use [[Dummy Page]] for testing instead of creating a sandbox normally. A demonstration can be found at [[Talk:Dummy Page]].
Because this template needs an article and its discussion page to function, please use [[Dummy Page]] for testing instead of creating a sandbox normally. A demonstration can be found at [[Talk:Dummy Page]].


== Usage ==
== Usage ==
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 article's talk page. By default it displays a blank box, but setting different parameters gives it various functions.
 
=== Automatic checks ===
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.


=== Manual section checks ===
=== Manual section checks ===
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:
There are many different parameters each dictating their own section of a page which may need review. Depending on the page, these should be included as <code>|parameter = none</code> to show that the page has that section and add it to applicable categories. When an editor checks parts of an article, that editor can sign with <nowiki>~~~~</nowiki> to confirm that they did a thorough check of a specific part of the page, effectively saying "this will be fine to keep as-is for at least a year". It can take the following parameters:


<code>
<code>
Line 20: Line 17:


|videogallery =  
|videogallery =  
|idcheck      =
</code>
</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 ====
 
Additionally, 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:
=== 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>
<code>
|idcheck      =
|id1          =  
|id1          =  


Line 39: Line 34:
</code>
</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.)
After checking the IDs for a page, sign with <nowiki>~~~~</nowiki> after <code>idcheck =</code> to show that the IDs were verified, as stated above. If an ID requires 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.


== Function ==
=== Automatic checks ===
Page Status can currently do the following things:
This template will automatically check for missing parts of its attached page. These automatic checks are hidden within other parameters to determine what kind of page is being checked, making the template as flexible as possible. Right now, it checks automatically for an infobox on the page if the parameter <code>infobox =</code> is set, and it checks for all the normal headers expected on a game page when <code>issuetracker =</code> is set. Otherwise, no automatic checks are performed.
 
*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 add them to a category which will allow the ability to quickly see what games need confirmation by title.
 
*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