Template:Page Status/doc: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(16 intermediate revisions by the same user not shown)
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. All of its functions are aimed at extended maintenance of various pages on the wiki, helping to categorize and prioritize what pages need attention and in what specific way.


<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>.
=== Manual section 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]].
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 should replace the <code>none</code> in the template with a standard <code><nowiki>~~~~</nowiki></code> signature to confirm that they did a thorough check of that 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 values:
*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:
<pre>
*If a videogallery parameter is not found, nothing is displayed and no categories are added.
|infobox      = none
*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]].
|forumpage    = none
*If a video gallery parameter is found, and it's a signature, it works the same as <code> infobox =</code> above.
|description  = none
|gamelist    = none
|enhancements = none
|videogallery = none
|issuetracker = none
|idcheck      = none
</pre>


<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]].
==== 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 values:


*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.
<pre>
|id1         =
|id2         =
|id3         =
(...)
</pre>


== Function ==
After checking the IDs for a page, sign with <code><nowiki>~~~~</nowiki></code> after <code>idcheck =</code> to show that they were verified, the same way as before. If one of more of them requires a second opinion, add the full length of it, or as much as you know, to the <code>id# =</code>.
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.
*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 <code>id#</code> numbers, and the first must be <code>id1</code>. For example, to display three IDs, those must be assigned to <code>id1</code>, <code>id2</code>, and <code>id3</code>.


*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.
*Since it doesn't actually do anything with the IDs besides link to them and check they exist, you could also type in prefixes here instead of full length ones if desired. Neither Dolphin nor the wiki use 4-digit IDs, however, so it's better practice to replace the missing parts of the ID with <code>?</code>s, for example: <code>|id1 = R12E??</code>.


*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.
==== Flagging ====
Pages can also be flagged as needing immediate help from an administrator through the use of the <code>|flag =</code> parameter. Setting this to any value other than whitespace will add the page to [[:Category:Pages flagged for immediate attention]], and change the color scheme and icon for the template to try and draw as much attention as possible. This should be used sparingly if at all, and once added should be left up until an administrator decides to remove it.
 
=== Automatic checks ===
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 does the following:
 
*Checks for an infobox if <code>infobox =</code> is set.
 
*Checks for all the normal game page headers if <code>issuetracker =</code> is set.
 
*Makes sure that platform pages have [[:Category:Platforms]].


== 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 CSS can definitely be improved. The manual check functions that require signatures need support for IP editor signatures (this can be done later though since users without accounts can't even edit right now).

Latest revision as of 05:10, 17 September 2017

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

This template is called with {{Page Status}} from any article's talk page. All of its functions are aimed at extended maintenance of various pages on the wiki, helping to categorize and prioritize what pages need attention and in what specific way.

Manual section checks

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 |parameter = none to show that the page has that section and add it to applicable categories. When an editor checks parts of an article, that editor should replace the none in the template with a standard ~~~~ signature to confirm that they did a thorough check of that 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 values:

|infobox      = none
|forumpage    = none
|description  = none
|gamelist     = none
|enhancements = none
|videogallery = none
|issuetracker = none
|idcheck      = none

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 values:

|id1          = 
|id2          = 
|id3          = 
(...)

After checking the IDs for a page, sign with ~~~~ after idcheck = to show that they were verified, the same way as before. If one of more of them requires a second opinion, add the full length of it, or as much as you know, to the id# =.

  • 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, and the first must be id1. For example, to display three IDs, those must be assigned to id1, id2, and id3.
  • Since it doesn't actually do anything with the IDs besides link to them and check they exist, you could also type in prefixes here instead of full length ones if desired. Neither Dolphin nor the wiki use 4-digit IDs, however, so it's better practice to replace the missing parts of the ID with ?s, for example: |id1 = R12E??.

Flagging

Pages can also be flagged as needing immediate help from an administrator through the use of the |flag = parameter. Setting this to any value other than whitespace will add the page to Category:Pages flagged for immediate attention, and change the color scheme and icon for the template to try and draw as much attention as possible. This should be used sparingly if at all, and once added should be left up until an administrator decides to remove it.

Automatic checks

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 does the following:

  • Checks for an infobox if infobox = is set.
  • Checks for all the normal game page headers if issuetracker = is set.

TODO

The CSS can definitely be improved. The manual check functions that require signatures need support for IP editor signatures (this can be done later though since users without accounts can't even edit right now).