Difference between revisions of "Template:GA nominee/doc"

From blackwiki
Jump to navigation Jump to search
imported>Prhartcom
(Add helpful statements.)
imported>Prhartcom
(Improve previous edit. Add documentation of note parameter on article talk page.)
Line 10: Line 10:
  
 
An explanation of each parameter:
 
An explanation of each parameter:
* '''<nowiki>~~~~~</nowiki>''' &mdash; Produces a timestamp. This is filled out automatically upon substituting {{tl|GAN}}
+
* '''<nowiki>~~~~~</nowiki>''' &mdash; Produces a timestamp. This field is populated automatically upon substituting {{tl|GAN}}
* '''nominator''' &mdash; The one who nominated the article for good article status. Upon substituting {{tl|GAN}}, this field is filled out automatically.
+
* '''nominator''' &mdash; The one who nominated the article for good article status. This field is populated automatically upon substituting {{tl|GAN}}
* '''page''' &mdash; The page number of the good article review; for example, if an article has never had a good article review before, then page=1. This is filled out automatically upon the substitution of {{tl|GAN}}.
+
* '''page''' &mdash; The page number of the good article review; for example, if an article has never had a good article review before, then page=1. This field is populated automatically upon substituting {{tl|GAN}}
* '''topic''' &mdash; The GA topic that is applicable to this page. See [[Wikipedia:Good articles]] for a list of topics. This parameter should be populated, except for miscellaneous nominations (Example: the topic may be "Art and architecture").
+
* '''status''' &mdash; The status of the GA review. A message indicating the status will appear beneath the article's entry on the nominations page and near the top of the article talk page. Statuses include:
* '''status''' &mdash; The status of the GA review. A message indicating the status will appear beneath the article's entry on the nominations page and near the top of the article's talk page. Statuses include:
 
 
** onreview: the article is in the process of being reviewed
 
** onreview: the article is in the process of being reviewed
 
** onhold: the reviewer has encountered issues with the article and is prescribing an amount of time for them to be corrected
 
** onhold: the reviewer has encountered issues with the article and is prescribing an amount of time for them to be corrected
 
** 2ndopinion: the reviewer is in search of a second opinion
 
** 2ndopinion: the reviewer is in search of a second opinion
* '''note''' &mdash; A miscellaneous note related to the article or the nomination. This note will appear beneath the article's entry on the nominations page.
+
* '''subtopic''' &mdash; The GA subtopic that is applicable to this page. See the subtopics on the [[Wikipedia:Good articles|good article]] page or the [[Wikipedia:Good article nominations/Instructions#Step 2: Nominating the article|instructions]] page. This parameter is normally populated, except for miscellaneous nominations (Example: the subtopic may be "Biology and medicine").
 +
* '''note''' &mdash; A miscellaneous note related to the article or the nomination. This note will appear beneath the article's entry on the nominations page and near the top of the article talk page.
 
* '''time''' &mdash; The amount of time, as stated as a phrase, prescribed by the reviewer for the nominator to address issues with the article while the status is on hold. This phrase will appear near the top of the article talk page. The default is "seven days".
 
* '''time''' &mdash; The amount of time, as stated as a phrase, prescribed by the reviewer for the nominator to address issues with the article while the status is on hold. This phrase will appear near the top of the article talk page. The default is "seven days".
  

Revision as of 08:09, 28 February 2016

{{Wikipedia:Article alerts/Bot use warning}}

Usage

This template adds articles to Category:Good article nominees. It is created automatically by the template substitution Template:Tlps, which should be placed at the top of the talk page of the nominated article.

The syntax is as follows:

{{GA nominee|~~~~~|nominator=|page=|topic=|status=|note=|time=}}

An explanation of each parameter:

  • ~~~~~ — Produces a timestamp. This field is populated automatically upon substituting {{GAN}}
  • nominator — The one who nominated the article for good article status. This field is populated automatically upon substituting {{GAN}}
  • page — The page number of the good article review; for example, if an article has never had a good article review before, then page=1. This field is populated automatically upon substituting {{GAN}}
  • status — The status of the GA review. A message indicating the status will appear beneath the article's entry on the nominations page and near the top of the article talk page. Statuses include:
    • onreview: the article is in the process of being reviewed
    • onhold: the reviewer has encountered issues with the article and is prescribing an amount of time for them to be corrected
    • 2ndopinion: the reviewer is in search of a second opinion
  • subtopic — The GA subtopic that is applicable to this page. See the subtopics on the good article page or the instructions page. This parameter is normally populated, except for miscellaneous nominations (Example: the subtopic may be "Biology and medicine").
  • note — A miscellaneous note related to the article or the nomination. This note will appear beneath the article's entry on the nominations page and near the top of the article talk page.
  • time — The amount of time, as stated as a phrase, prescribed by the reviewer for the nominator to address issues with the article while the status is on hold. This phrase will appear near the top of the article talk page. The default is "seven days".

Technical note

This template uses {{GAN/editintro}}, {{GAN/preload}} and {{subst:GAN/subst}} to provide further instructions and assistance when starting the review subpage.

See also