Template:Vacation/doc
| This is a documentation subpage for Template:Vacation. It may contain usage information, categories and other content that is not part of the original template page. |
| This is a customized wrapper for the {{Wikibreak}} template, which means it is built upon the other template's code. Parameters from {{Wikibreak}} will only work here if they have been added to this template. |
Usage
[edit]The {{vacation}} template aims to communicate to fellow editors that a user has gone on vacation. It can be used standalone as {{vacation}}, preferably at the top of a user or user talk page, or with any of the parameters outlined below.
- Username
- To override the username (which would be automatically selected based on the page it is on), simply provide a first unnamed parameter.
- Country or region
- Denoted by
|country=or as the second unnamed parameter, this variable defines the destination country or region of the user. Relies on the sames system as the {{flag}} templates – if those templates supply a flag for your country name, your country is supported here. Examples:the United States,Florida,Australia,India. - Country override
- Optionally, to display a particular area, city, or region of a particular country, add the
|location=parameter. Note that this removes the default country name. - Start and end dates
- Informing others of your vacation's start and end points is easy with
|from=and|until=. Simply enter the dates in which your vacation begins and comes to its eventual end, in any format you want. DMY/MDY? ISO? Go for it! Only one of these may be supplied if desired, i.e. only|from=or|until=. The template will adjust its phrasing to match the dates provided with the correct tense (past, present, or future). - Localization
- To change "vacation" to "holiday", include
|holiday=yesin the template. - Background colour
- Define a background colour for the box with the
|bgcol=parameter. See WP:COLOR for more information. Examples: #36C, #F8EABA (talk page colour)
Example usage
[edit]Default; no arguments – {{vacation}}
| John Doe is away on vacation and may not respond swiftly to queries. |
Username override – {{vacation|John at [[English Wikipedia]]}}
| John at English Wikipedia is away on vacation and may not respond swiftly to queries. |
Location – {{vacation|country=Nunavut|location=the [[Canada|Canadian province]] of [[Nunavut]]}}
| John Doe is away on vacation in the Canadian province of Nunavut and may not respond swiftly to queries. |
Dates – {{vacation|from=July 26, 2026|until=August 9, 2026}}. Message automatically changes based on the time of your vacation: it will switch to "present" on the day you set in |from=, if applicable, and switches to "past" once your journey has come to an end.
| Past | Present | Future | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|from= only |
|
| ||||||||||
|from= and |until= |
|
|
| |||||||||
|until= only |
|
| ||||||||||
Shortcuts
[edit]The following template links redirect to this page. You can use each of the following names instead of {{vacation}}.
{{vacation2}}{{vacation3}}{{vacation5}}{{holiday}}{{holiday2}}{{holiday3}}{{holiday4}}{{Holiday abroad}}
TemplateData
[edit]TemplateData for Vacation
| The following TemplateData may be crude, incomplete, or otherwise need significant cleanup. |
Communicates to fellow editors on a user or user talk page that a user has gone on vacation.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| User | 1 | Overrides the username
| String | optional |
| image | image | Overrides the default image on the left
| File | optional |
| Country | country 2 | Destination country or region of the user, relies on the same system as the {{flag}} templates
| String | optional |
| Background Color | bgcol | Define a background colour for the box
| Unknown | optional |
| fullwidth | fullwidth | no description | Unknown | optional |
| Start Date | from | The start date of the user's vacation in any format | Date | optional |
| End Date | until | The start date of the user's vacation in any format | Date | optional |
| Display "Holiday" | holiday | Change "vacation" to "holiday"
| Unknown | optional |
| location | location | Display a particular area, city, or region instead of the country | String | optional |
| Comment | cmt 3 | An additional comment | String | optional |