Template:Vacation/doc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

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)

Example usage

[edit source]

Default; no arguments{{vacation}}

Username override{{vacation|John at [[English Wikipedia]]}}

Location{{vacation|country=Nunavut|location=the [[Canada|Canadian province]] of [[Nunavut]]}}

Dates{{vacation|from=April 29, 2026|until=May 13, 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 source]

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 source]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Vacation in articles based on its TemplateData.

TemplateData for Vacation

Communicates to fellow editors on a user or user talk page that a user has gone on vacation.

Template parameters

ParameterDescriptionTypeStatus
User1

Overrides the username

Default
your username
Stringoptional
imageimage

Overrides the default image on the left

Default
the flag of the country
Fileoptional
Countrycountry 2

Destination country or region of the user, relies on the same system as the {{flag}} templates

Example
the United States
Stringoptional
Background Colorbgcol

Define a background colour for the box

Example
#F8EABA
Unknownoptional
fullwidthfullwidth

no description

Unknownoptional
Start Datefrom

The start date of the user's vacation in any format

Dateoptional
End Dateuntil

The start date of the user's vacation in any format

Dateoptional
Display "Holiday"holiday

Change "vacation" to "holiday"

Suggested values
yes
Unknownoptional
locationlocation

Display a particular area, city, or region instead of the country

Stringoptional
Commentcmt 3

An additional comment

Stringoptional

See also

[edit source]