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 game's talk page. Right now it only has two 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>.
<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>.
Line 8: Line 8:
*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.
*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.
*'''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:
*If a videogallery parameter is not found, nothing is displayed and no categories are added.
*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> 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]].

Revision as of 10:40, 22 August 2017

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.

Usage

This template is called with {{Page Status}} from any game's talk page. Right now it has three parameters:

infobox = 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 ~~~~ signature (manually typed signatures are allowed, but they must follow the normal signature's format exactly). An example of usage would be {{Page Status | infobox = ~~~~}}.

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

videogallery = is very similar to infobox, and also takes a signature in the same way, however by default the section is hidden, like so:

  • If a videogallery parameter is not found, nothing is displayed and no categories are added.
  • If a videogallery parameter is found, and it's equal to "none" (e.g. {{Page Status | videogallery = none}}), 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 infobox = above.

id# = is used to add unconfirmed IDs to the template. An example usage would be {{Page Status | id1 = G12E34 | id2 = G56P78 | id3 = ...}}. 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

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

The CSS can definitely be improved. Some regexes are rather complicated and are not yet implemented (grabbing latest test entry revision for example).