Template:Update after/doc
| This is a documentation subpage for Template:Update after. It may contain usage information, categories and other content that is not part of the original template page. |
__EXPECTED_UNCONNECTED_PAGE__
| This template is used on approximately 4,200 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
| Use {{Update after}} only in exceptional cases when there is a certainty that an update will be needed. See § Inappropriate use. |
This template is used to flag statements that are likely to become outdated by a specific future date. It is important to distinguish its use on other date-sensitive statements on Wikipedia, where date-sensitive information may require revision without a specific future date in mind. It remains invisible to readers until that date, when it appears and adds the page to Category:Wikipedia articles in need of updating.
See the Wikipedia Manual of Style on chronological items, the editing guidelines on precise language and updating information, and Wikipedia:As of.
Usage
{{Update after|year|month|day|category name|reason=...|text=...}} (all parameters are optional)
- For inline usage, similar to {{Citation needed}}.
- If piece of text is already outdated, use {{Update inline}} or {{Update inline span}} instead.
- {{Update}} can be used to mark an entire article or section needing to be updated. {{Outdated as of}} could be used to automatically trigger it for articles that will need to be improved due to an already determined future development.
- {{Update|inaccurate=yes}} is used to mark an article which may now have inaccuracies (not just missing information) due to being outdated.
Parameters
- Parameters
|1=,|2=, and|3=are respectively the year, (numeric) month, and day that the template should activate. If only the year is specified, the template will activate on 1 January of the year following the specified year. If only the year and month is specified, the template will activate on the first day following the specified month. If all three parameters are blank, the template will activate immediately. At least the month and year should be specified. If parameters 1, 2, and 3 are left blank or not listed, a bot will add the date the template was added to the article later. - Parameter 4 is a custom category, such as a WikiProject's article maintenance category. The article will be placed in the specified category when the template is activated (but only if the template is used in an article in the main namespace, not if it is used on a talk page or in any other non-main namespace). The category name must be specified without square brackets and without the "Category:" prefix. If the custom category is literally given as
categoryorcategory namethen Category:Articles using Template:Update after with a placeholder category is added instead. In addition to any category specified here, articles are automatically placed in Category:Wikipedia articles in need of updating or one of its dated subcategories, when the date is specified. To use this parameter even when the first three parameters are omitted, you can write|4=.- Examples: Specifying
|4=Green Bay Packers articles in need of updatingplaces the article in Category:Green Bay Packers articles in need of updating as well as Category:Wikipedia articles in need of updating.
- Examples: Specifying
- Parameter
|reason=is used to leave a note for future editors about what exactly needs to be changed or where to find the new information. The note is displayed as a tooltip on the "Dated info" link once the template activates. - Named parameter
|text=is the text that will become dated, and is as such used to highlight dated text. Until the template activates, the text is displayed ordinarily, as if it were not wrapped. - Named parameter
|delay=specifies an additional number of days to delay activation of the template after the specified date.
Inappropriate use
Please read Wikipedia:Avoid statements that will date quickly, Manual of Style on chronological items, the editing guidelines on precise language and updating information, and Wikipedia:As of; use {{Update after}} only in exceptional cases. Do not use this template on pages which simply need to be reviewed later to see if they might need updating; it should only be used when there is a certainty or very high probability that an update is needed, or with statements that will be out-of-date at a specifiable future date. Do not use this template on talk pages; it is intended for inline usage, like {{Citation needed}}. It is probably not necessary to use this template on frequently edited articles such as for current events, as they will be being updated on a regular basis. Do not use this template within a section heading as it will count as part of the heading and thus break the heading.
Make sure to use numbers for all date fields, or a message, "Expression error: Unexpected < operator" will appear.
Maintenance categories
- Category:Pages using update after template with unknown parameters (0)
- Category:Articles using Template:Update after with a placeholder category (0)
TemplateData
TemplateData for Update after
Places an in-line note in an article that marks information as [dated] and in need of an update after a given time
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Year | 1 year | The year the template should activate, if not specified the template will activate immediately. Enter a four-digit year. | Number | optional |
| Month | 2 month | The month the template should activate, if not specified the template will activate on 1 January of the following year. Enter the month as two digits, e.g. 06 for June. | Number | optional |
| Day | 3 day | The day the template should activate, if not specified the template will activate on the first of the next month. Enter the day as two digits. | Number | optional |
| Category | 4 category | Additionally add the article to another category (e.g. a WikiProject's maintenance category) when the template is activated. The category name must be specified without square brackets and without the "Category:" prefix. In addition to any category specified here, articles are automatically placed in [[Category:Wikipedia articles in need of updating]] or one of its dated subcategories, when the date is specified. This parameter has no effect outside the main (article) namespace. | Line | optional |
| Reason | reason | An optional note for future editors about what exactly needs to be changed or where to find the new information. Displayed in tooltip. | String | optional |
| Text | text | Dated statement. Becomes highlighted when template activates; displayed normally before activation. | String | optional |
| Delay (by days) | delay | Number of days to delay template activation.
| Number | optional |
Examples
| Description | Code | Result |
|---|---|---|
|
|
|
Some text that was already outdated when the tag was added.[needs update] |
|
|
|
Some text that will be outdated after today. |
|
|
Some text that should be checked next year. | |
|
|
|
Some text that will be outdated after today. |
|
An optional reason may be used as a comment to future editors. |
|
Some text that should be checked.[needs update] |
Dated statement may be included in the template using the |text= param.
|
|
Some text that should be checked.[needs update] |
Effects
When the template is activated in an article, the phrase "needs update" appears in the text of the article at the indicated spot. The page will also appear in Category:Wikipedia articles in need of updating or one of its dated subcategories, when the date is specified, and also any category specified in the 4th parameter.
See Category:Wikipedia articles in need of updating for a list of pages currently needing updates, and Wikipedia:As of for a list of 'As of' pages.
Related templates
- {{Update inline}} or {{Update inline span}} can be used if the text is already outdated, instead of adding this template with a date in the past.
- {{Update}} can be used to mark an entire article or section needing to be updated. Like {{Update after}}, this template adds the article to Category:Wikipedia articles in need of updating.
- {{Update|inaccurate=yes}} is used to mark an article which may now have inaccuracies (not just missing information) due to being outdated. This template adds the article to Category:Articles with obsolete information.
- {{As of}} is used to mark potentially dated statements, and will add an article to the appropriate hidden sub-category of Category:Articles containing potentially dated statements.
- {{subst:Show by}}/{{Show by date}} Shows one of 2 strings depending upon date
- {{Age switch}} can be used to build date-related templates.
See also
Inline cleanup tags | |
|---|---|
| Attribution | |
| Clarity | |
| Miscellaneous | |
| Neutrality | |
| Precision | |
| Time-sensitivity | |
| Verifiability | |
| Wording | |
| General advice |
- Template:Update after invokes Module:Navbox using Lua.
Usage
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.
The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.
Syntax
{{navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
- Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
- Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
- Line breaks: Line-breaks (
<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN. - Bullets: Create unordered lists with lines beginning with *.
- Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! (
{{!}}).
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Plain: Removes the "show/hide" link.
Sub-groups
- For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
- To create sub-groups within
{{navbox}}, certain parameters are to be included:- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = Subgroup (mandatory)
|group2 =
{{navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Collapsible sub-groups
- For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
- To create collapsible sub-groups within
{{navbox}}, these parameters need to be included:- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state = uncollapsed
|name =
|gtype1 = Subgroup
|group1 =
{{navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Use of images
- The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
- Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|alt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|File|alt=Text}}
Categorising
Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.
Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.
Examples
To see the following navboxes in action, see Template:Navbox.
Single line navbox with centered list
{{navbox
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Navbox with standard footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|footer = Centered footer
}}
Navbox with styled footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|fstyle = text-align:right
|footer = Right-aligned footer
}}
Multiple line navbox
{{navbox
|name =
|title =
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}
Collapsed navbox
{{navbox
|state = collapsed
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox with Tnavbar
{{navbox
|state = plain
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox without Tnavbar
{{navbox
|state = plain
|title =
|style1 = text-align:center
|group1 =
}}
Complicated navbox
{{navbox
|state = uncollapsed
|name =
|title =
|gtitle1 = Level 1 Title 1
|group1 =
|gtitle2 = Level 1 Title 2
|group2 =
|gtitle3 = Level 1 Title 3
|group3 =
|gtitle4 = Level 1 Title 4
|group4 =
|gtitle5 = Level 1 Title 5
|gtype5 = Subgroup
|group5 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 2 Title 1
|group1 =
|gtitle2 = Level 2 Title 2
|group2 =
|gtitle3 = Level 2 Title 3
|gtype3 = Subgroup
|group3 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 3 Title 1
|group1 =
|gtitle2 = Level 3 Title 2
|group2 =
}}
|gtitle4 = Level 2 Title 4
|group4 =
}}
|gtitle6 = Level 1 Title 6
|group6 =
|gtitle7 = Level 1 Title 7
|group7 =
|fstyle =
|footer =
}}
Preventing unwanted documentation
The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).
Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.