Template:Article history/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

This template combines all the "content milestone"-related templates into one, to reduce clutter on talk pages, and make it less confusing when an article has had multiple ACRs or been demoted and repromoted etc. B-Class Article status, Articles for Deletion, Peer reviews and WikiProject reviews can also be included. If the article is moved, the actions within the milestones do not usually need to also be moved; the template tacks the milestone actions for an article through article moves and name changes.

This template cannot be used for placing Good article nominations on hold or for nominating articles for processes such as Featured article candidate, Good article candidate, Peer review or Featured article review, and should never be used for processes that are still in progress; items are only added to the template after they are closed.

The parameter |currentstatus= controls what text appears at the top of the box. If the article is a GA, |topic= is needed to show the article topic within the top of the box. A set of up to twenty parameters of the form |action1=|action1date=|action1link=|action1result=|action1oldid= produces a row in the history section at the bottom of the box. Action1 refers to the earliest event.


Syntax

Note: DO NOT put HTML comments inside this template.

A simple use would typically include:

{{Article history
| action1       = 
| action1date   = 
| action1link   = 
| action1result = 
| action1oldid  = 

| currentstatus = 
| topic         = <!--If the article is a GA-->
}}

More complex uses might include other fields:

{{Article history
| action1       = 
| action1date   = 
| action1link   = 
| action1result = 
| action1oldid  = 

| action2       = 
| action2date   = 
| action2link   = 
| action2result = 
| action2oldid  = 

| currentstatus = 
| itndate       = 
| dykdate       = 
| dykentry      = 
| dyknom        = 
| topic         = 
| collapse      = 
}}

Most syntax errors place the talk page in Category:Article history templates with errors. After adding Article history or adding/removing a milestone, please check the bottom of the talk page for this error category.


How to find and use oldid

The "oldid" is a several-digit number which refers to the exact version of the page at the time of that particular action. This version can then be viewed when a user clicks on the date in the list of milestones. If the oldid is not provided, a bot can determine it from the action date.

There are multiple ways to obtain an oldid. For example, while looking at a page's history, it should be possible to hover the mouse over the date of a particular change, and then the URL will appear at the bottom of the window in the browser's status bar:

http://en.wikipedia.org/w/index.php?title=Main_Page&oldid=89723590

In the above example, the final number, 89723590 is what should be used in the oldid field.

This number can also be obtained by stepping through the diffs in an article's history, and looking for the oldid in the URL line.

Errors

This template can produce a number of errors. These are categorised into Category:Article history templates with errors. Explanation of individual errors is given below.

Invalid date

  • invalid date 'abc' detected in parameter 'action4date'

This error occurs when a date is specified, but the date isn't recognized as being valid. If in doubt, use the format "d Month YYYY" (for example, "4 June 2010"). If the date looks correct to you, but you still get this error, you might have inserted an invisible control character at the beginning or end of the date. This can happen when you copy and paste a timestamp. Try pressing backspace after you've pasted; if you hit backspace but the cursor doesn't move, you just deleted a control character.

The date recognition in the template relies on the #time parser function, so for all the technical details of what is allowed see the #time documentation on mediawiki.org.

No date parameter

  • an argument starting with 'abc2' was detected, but no 'abc2date' parameter was specified
  • no date specified for action 3; please add a date to parameter 'action3date' or remove the other parameters beginning with 'action3'

When certain parameter prefixes are followed by a number, e.g. "action4", "dyk2" or "otd3", a date parameter must also be specified, e.g. "action4date", "dyk2date" or "otd3date". This works for parameter names like "action4x", "dyk2abc" and "otd3blah" as well. If you get this error, then you must provide the correct date parameter, or remove all the other parameters with that prefix.

Featured article candidates

  • use the template {{fac}} to nominate an article for Featured article status

The status "FAC" is treated as invalid, as there is a specialized template, Template:Fac, for nominating articles for Featured status. Using two templates would mean more maintenance work. While the featured article candidacy is underway, simply leave this template with the old status. Then a bot will update the {{article history}} template when the featured article candidacy discussion is closed.

Featured article review

  • use the template {{FAR}} to nominate an article for Featured article review

The status "FAR" is treated as invalid for similar reasons as FAC above. Instead of using this template to record featured article reviews, you should use the specialized template, Template:FAR, instead. While the review candidacy is underway, simply leave this template with the old status. Then a bot will update the {{article history}} template when the review discussion is closed.

WikiProject assessments

  • do not use 'stub' as a 'currentstatus' parameter; these assessments are the responsibility of individual WikiProjects

Article ratings such as "B", "C", "Start" and "Stub" are made by individual WikiProjects. Although these ratings are often the same between WikiProjects, they don't have to be: projects are entirely free to rate an article as "C" that others might rate as "Start", for example. For this reason, these kinds of ratings shouldn't be added to the article history template.

Invalid status

  • 'abc' is not a valid status code

This error occurs if you specify a current status with the |currentstatus= parameter, but the status code that you used was not recognized by the template. See above for a list of valid status codes.

Former featured articles

  • former featured articles should have a current status
  • 'abc' is not a valid current status for former featured articles

Former featured articles always have a current status. Depending on the history of the article, that could be any of "FA", "FL", "FFA", "FFL", "FFA/GA", or "GA". ("GA" is automatically converted to "FFA/GA".) You need to use one of these values for the |currentstatus= parameter, otherwise one of the errors above will be triggered. Alternatively, if the article is not really a former featured article, you will need to fix the action parameter that says that the article was demoted at featured article review (FAR).

Featured topic names

  • parameter 'ft2main' is set, but no featured topic name is set in parameter 'ft2name'
  • a parameter starting with 'ft' was detected, but no featured topic names were specified; please check the parameter names

If you specify the parameter "ftmain", "ft2main", etc., or just anything starting with "ft" and a number, then the template assumes you want to add information about a featured topic. These errors occur if you specify one of these parameters, but don't specify the appropriate name parameter. For "ftmain", that would be "ftname", and for "ft2main", that would be "ft2name". Other parameters starting with "ft" are probably a mistake, so check your spelling. (Also, you should use "ftname", not "ft1name", but "ft2name", "ft3name" etc. are fine.)

Missing icon

  • notice bar icon config set to 'true' but no image could be found

This is an error in the module configuration. Please notify the maintainer at Template talk:Article history.

Action codes

  • no action code found in the 'action3' parameter; please add a code or remove other parameters starting with 'action3'
  • invalid action code 'abc' passed to the 'action2' parameter

Every action needs an action code for the template to know what the valid results are, what the default link label should be, and other things. For example, for a featured article candidacy the action code is "FAC", and for peer review the action code is "PR". These codes go in the parameters "action1", "action2", "action3", etc. If you include a parameter like "action3result" but don't include an "action3" parameter, or if you include an action code that isn't recognized, you get one of these errors. To fix them, check the spelling of your parameters, check that you have an action code for every action that you have included, and check the list of valid action codes above to see that you have the right one.

No actions

  • a current status was supplied without any actions

Article history templates where a current status is supplied must also have actions supplied. This is because for an article to have a current status in the first place, some kind of action must have occurred for it to reach that status. For example, articles with a current status of FA (featured article) must have gone through the action FAC (featured article candidates). To fix this error, either add the appropriate actions, or if the article does not have a current status, remove the |currentstatus= parameter.

Action results

  • the 'FTC' action requires a result code; please add a result code to parameter 'action3result'
  • invalid result 'abc' for action 'GAN' detected in parameter 'action4result'

Most actions (but not all) require a result code. For example, the "FAC" action has two possible results, "promoted" and "failed". Please see the table of actions and results above for valid values. If you fail to specify a result parameter for an action that requires it, or if you specify an invalid result code, then you will get one of these errors. You may also get this error if you supplied an action parameter such as "action1", "action2" etc. by mistake: if this is the case, just remove the parameter.

Invalid oldid

  • invalid oldid 'abc' detected in parameter 'action2oldid'; if an oldid is specified it must be a positive integer

It is optional, but recommended, to specify an oldid for all of the actions in the template. This is done by using the parameters "action1oldid", "action2oldid", etc. If any of these values is not a number, or if that number is zero or lower, or is not a whole number, then you will get this error. To fix it, either specify a valid oldid or remove the parameter.