Template:Vacation/doc

Usage
The vacation template aims to communicate to fellow editors that a user has gone on vacation. It can be used standalone as, 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 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
Default; no arguments –

Username override –

Location –

Dates –. 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.

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



TemplateData
{	"params": { "1": {			"label": "User", "description": "Overrides the username" },		"image": { "description": "Overrides the default image on the left" },		"country": { "aliases": [ "2"			]		},		"bgcol": {}, "fullwidth": {}, "from": {}, "until": {}, "holiday": {}, "location": {}, "cmt": { "aliases": [ "3"			],			"label": "Comment", "description": "An additional comment" }	},	"description": "Communicates to fellow editors on a user or user talk page that a user has gone on vacation." }