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 template is a customized wrapper for {{Wikibreak}}. Any field from {{Wikibreak}} can work so long as it is added to this template first. Questions? Just ask here or over at Template talk:Wikibreak.

This template employs intricate features of template syntax. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here.

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=yes in 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)

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 17, 2024|until=July 31, 2024}}. 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	John Doe is away on vacation in New Zealand and may not respond swiftly to queries.		John Doe will be away on vacation in France from July 31, 2024 and may not respond swiftly to queries.
|from= and |until=	John Doe was away on vacation in Chile from July 10, 2024 to July 17, 2024 and may not have responded swiftly to queries.	John Doe will be away on vacation in Italy until July 31, 2024 and may not respond swiftly to queries.	John Doe will be away on vacation in Thailand from July 31, 2024 to August 7, 2024 and may not respond swiftly to queries.
|until= only	John Doe was away on vacation in Japan until July 17, 2024 and may not have responded swiftly to queries.	John Doe will be away on vacation in Antarctica until July 31, 2024 and may not respond swiftly to queries.

The following template links redirect to this page. You can use each of the following names instead of {{vacation}}.

The following TemplateData may be crude, incomplete, or otherwise need significant cleanup.