Template:Page Status/doc: Difference between revisions

From Dolphin Emulator Wiki
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 article's talk page. By default it displays a blank box, but setting different parameters gives it various functions.
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.


=== Manual section checks ===
=== 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 <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:
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 values:


<code>
<code>
Line 22: Line 22:


==== 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 parameters:
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:


<code>
<code>
Line 39: Line 39:


=== Automatic checks ===
=== 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 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.
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 <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.


== 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.

Revision as of 14:02, 23 August 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 can sign with ~~~~ 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 values:

|infobox =

|issuetracker =

|forumpage =

|enhancements =

|videogallery =

|idcheck =

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 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 id# =. (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.

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 checks automatically for an infobox on the page if infobox = is set, and it checks for all the normal headers expected on a game page when issuetracker = is set. Otherwise, no automatic checks are performed.

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.