Template:Infobox holiday/doc: Difference between revisions

Jump to navigation Jump to search
(→‎Optional: document date year+2 parameter)
m (1 revision imported)
 

Latest revision as of 18:10, 22 April 2021

The {{Infobox holiday}} template adds an infobox with data fields for defining a particular holiday.

Usage

{{Infobox holiday
|holiday_name  = required
|type          = required
|image         =
|imagesize     =
|caption       =
|official_name =
|nickname      =
|observedby    =
|litcolor      =
|longtype      =
|significance  =
|begins        =
|ends          =
|date          =
|scheduling    = <!-- e.g. "same day each year" -->
|duration      = <!-- e.g. "1 day", "1 week" -->
|frequency     = <!-- e.g. "Annual", "Every 4 years", "Once" -->
<!-- Use next three if holiday is the same day of the same week every year -->
|week_ordinal  = <!-- "first", "second", "last", etc. -->
|weekday       = <!-- "Sunday", "Monday", "Friday", etc. -->
|month         = <!-- "January", "February", "December", etc. -->
<!-- Use next four if the date changes in an unusual pattern each year -->
|date2023      = <!-- only for days that change each year -->
|date2024      = <!-- only for days that change each year -->
|date2025      = <!-- only for days that change each year -->
|date2026      = <!-- only for days that change each year -->
|celebrations  =
|observances   =
|relatedto     =
}}

For an annual holiday occurring on the same day each year:

{{Infobox holiday
|holiday_name  = Template Day
|type          = 
|image         =
|imagesize     =
|caption       =
|official_name =
|nickname      =
|observedby    =
|litcolor      =
|longtype      =
|significance  =
|begins        =
|ends          =
|date          = 30 February
|scheduling    = same day each year
|duration      = 1 day
|frequency     = Annual
|celebrations  =
|observances   =
|relatedto     =
}}

Parameters

Required

holiday_name
This is the most common holiday name, which appears at the top of the infobox. It should almost always be the name of the article.
type
The type of the holiday, for example: national, Judaism, Islamic, etc. The type parameter has this relation:
Type (param "type") Color
islam, islamic LightGreen
judaism, juda, jewish, jew LightSkyBlue
buddhism, buddhist, buddha PaleGoldenRod
christian, christ, christianity Lavender
asian, asian festival RosyBrown
secular DarkGray
national, international, local, group LightViolet
historical, cultural, patriotic, ethnic LightSalmon
pagan DarkKhaki
commercial Yellow
hindu, hinduism Orange
shinto, shintoism Light red
default LightSteelBlue
begins
required for multi-day holidays - This is the starting date for a multi-day holiday.
ends
required for multi-day holidays - This is the ending date for a multi-day holiday.
date
required for single-day holidays - This is the date of a single-day holiday. (If you use the week_ordinal/weekday/month parameters below, date will default to a phrase like "First Sunday in January". Otherwise it has no default and is required.). Specific phrases for other rules are decoded in Template:Infobox holiday/date. Sample: "first Thursday after 18 April". If no value is given, the value of d:Property:P837 of the holiday's Wikidata item is displayed instead.
date2024
highly recommended for holidays that don't stay on the same Gregorian date - This is the Gregorian date on which the holiday will occur in 2024. At the end of 2024, this will be replaced with date2025, which will later be replaced with date2026. Therefore, it's a good idea to specify the Gregorian date for a few future years. (Not necessary if week_ordinal/weekday/month are specified instead.)

Optional

image
This should be an image that represents the holiday. The value is just the simple target-name, not a full wikilink.
imagesize
The size of the image (default is 225px).
caption
This is a caption that describes the image.
official_name
This should contain the official name of the holiday if it is not the holiday_name; this can also be the name of the holiday in its original language
nickname
This should hold any nicknames, alternatives, and translations for the holiday_name or official_name
observedby
highly recommended - These are the people who celebrate/observe the holiday (e.g. Muslims and Islam, United States, people worldwide)
litcolor
This is the liturgical color of the day, if applicable to a religious holiday; or other color which is applicable to the holiday (e.g. green for Saint Patrick's Day)
longtype
This is a lengthier description of the type, for example if there are two types that could be defined, for example "Cultural, Historical, Islamic"
significance
This is a lengthier description of the holiday's significance
scheduling
define the how the date varies (not displayed). Sample value: "same day each year"
duration
time the holiday or observance last. Sample values: "1 day", "1 week", "3 days"
frequency
the frequency with which the holiday or observance re-occurs. Sample values: "Annual", "Weekly", "Monthly"
week_ordinal, weekday, month
For days that are observed on the same day of the same week every year, these specify the week (week_ordinal), day of the week (weekday), and month. If you use these, you no longer have to specify date2023, date2024, date2025 and date2026. If you specify week_ordinal, then weekday and month are required also.
date2023, date2025, date2026
recommended for holidays that don't stay on the same Gregorian date - The template will display the previous and next year's dates along with that of the current year, if they are provided. Again, it's a good idea to provide dates for a few years further into the future as well. (Not necessary if week_ordinal/weekday/month are specified instead.)
mdy
if set to a non-blank value, auto-formatted dates will be displayed in "month day, year" format instead of the default "day month year" order.
firsttime
first time/year the holiday was observed (if available)
lasttime
last time/year the holiday was observed (if no longer observed)
celebrations
This contains the celebrations that occur on the holiday.
observances
This contains essentially the same thing as the celebrations attribute. However, the word observances is used. This may be more appropriate than celebrations when referring to prayer or more solemn observances. Most likely, you will not need both celebrations and observances.
relatedto
This contains holidays that relate to the current holiday.

Examples

Same date every year

{{Infobox holiday
|holiday_name  = Nice Safe Day
|type          = national
|official_name = The Nice Safe Holiday Day
|nickname      = The Nice & Safe Day
|observedby    = [[Atlantis]]
|significance  = The Nice Safe Day for everyone
|date          = January 31
|celebrations  = The Nice Safe Day parade
|relatedto     = [[Unsafe Day]]
}}
Nice Safe Day
Official nameThe Nice Safe Holiday Day
Also calledThe Nice & Safe Day
Observed byAtlantis
TypeNational
SignificanceThe Nice Safe Day for everyone
CelebrationsThe Nice Safe Day parade
DateJanuary 31
Related toUnsafe Day

Same day of same week every year

{{Infobox holiday
|holiday_name  = Puzzle Saturday
|type          = secular
|image         = Wikipedia-logo-blank.png
|caption       = Commonly seen puzzling encyclopedia
|official_name = The Official Puzzle Saturday
|observedby    = United States
|longtype      = State holiday
|week_ordinal  = last
|weekday       = Saturday
|month         = August
}}
Puzzle Saturday
Wikipedia-logo-blank.png
Commonly seen puzzling encyclopedia
Official nameThe Official Puzzle Saturday
Observed byUnited States
TypeState holiday
DateLast Saturday in August
2023 dateAugust 26  (2023-08-26)
2024 dateAugust 31  (2024-08-31)
2025 dateAugust 30  (2025-08-30)
2026 dateAugust 29  (2026-08-29)

Different days and dates each year

{{Infobox holiday
|holiday_name  = Inscrutable Day
|type          = cultural
|official_name = Day of the Phantom Inscrutable Cheese
|observedby    = [[Chicago]], [[Illinois]]
|date          = Five days after every 13th moon
|date2020      = June 27
|date2021      = July 12
|date2022      = September 1
|date2023      = June 8
|observances   = Night of the Moon Cheese
}}
Inscrutable Day
Official nameDay of the Phantom Inscrutable Cheese
Observed byChicago, Illinois
TypeCultural
ObservancesNight of the Moon Cheese
DateFive days after every 13th moon
2023 dateJune 8

Formulas for calculating occurrences

Sample formulas used in Template:Infobox holiday/date:

For some holidays, this is still defined on the holiday page itself. For First Day of Summer, this would be:

|date                     = first Thursday after 18 April
|date{{LASTYEAR}}         = {{Weekday after date|{{LASTYEAR}}|April|18|Thursday}}
|date{{CURRENTYEAR}}      = {{Weekday after date|{{CURRENTYEAR}}|April|18|Thursday}}
|date{{NEXTYEAR}}         = {{Weekday after date|{{NEXTYEAR}}|April|18|Thursday}}
|date{{#time:Y|+2 years}} = {{Weekday after date|{{#time:Y|+2 years}}|April|18|Thursday}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox holiday

No description.

Template parameters

ParameterDescriptionTypeStatus
typetype

Type of holiday, sets banner color

Default
e.g. secular, national, international, cultural, historic, ethnic, patriotic, default, asian, judaism, shinto, islam, christian, commercial
Example
international
Stringrequired
holiday_nameholiday_name

Usually the same as the page name

Example
World AIDS Day
Unknownrequired
imageimage

Do not include File: and do not wikilink

Example
Easter.svg
Unknownsuggested
image_sizeimage_size

no description

Unknownoptional
imagesizeimagesize

no description

Unknownoptional
altalt

Image description for visually impaired readers

Example
orange awareness ribbon
Unknownsuggested
captioncaption

Image caption

Stringoptional
official_nameofficial_name

no description

Unknownsuggested
nicknamenickname

Nickname for the date, or translations

Example
SAAM
Unknownsuggested
observedbyobservedby

Countries or people who celebrate or observe the date

Example
[[Muslim]]s and [[Islam]], people worldwide
Stringsuggested
litcolorlitcolor

Color used for the holiday

Example
Blue
Stringsuggested
longtypelongtype

Lengthier alternative to type

Example
Cultural, ethnic and Buddhist
Unknownoptional
significancesignificance

Lengthier description of holiday's significance

Stringsuggested
celebrationscelebrations

What usually happens on that date. Observances can be used instead.

Example
gift-giving, Church services
Stringsuggested
observancesobservances

Can be used instead of celebrations to describe what happens on the date

Stringoptional
beginsbegins

Required for multi-day holidays

Example
1 October
Unknownsuggested
endsends

Required for multi-day holidays

Example
31 October
Unknownsuggested
datedate

Date of event, do not use "1st", "5th" use 1, 5

Example
1 October
Unknownrequired
week_ordinalweek_ordinal

For the first, second etc weeks in a month

Example
first
Unknownoptional
weekdayweekday

Day of week if always the same

Example
Sunday
Unknownsuggested
monthmonth

Use for long observances

Example
October
Unknownsuggested
date2023date2023

no description

Unknownoptional
date2022date2022

no description

Unknownoptional
date2020date2020

Use when the date changes every year

Unknownoptional
schedulingscheduling

Not displayed

Example
same day each year
Stringsuggested
mdymdy

if set auto-formatted dates will be displayed in "month day, year"

Example
yes
Stringoptional
durationduration

no description

Default
e.g. 1 day, 1 week, 1 month
Example
1 day
Stringsuggested
frequencyfrequency

How often it occurs

Default
e.g. Annual, Every 4 years, Once
Example
Annual
Unknownsuggested
firsttimefirsttime

either first date or calculation of how long ago

Example
{{start date and age|df=yes|1988}}
Unknownsuggested
lasttimelasttime

Useful for events no longer held or not held every year

Unknownoptional
startedbystartedby

Person or organization

Unknownsuggested
relatedtorelatedto

Any other dates or wiki pages linked to it

Example
[[World Mental Health Day]]
Unknownsuggested
date2021date2021

no description

Unknownoptional

Tracking categories

Pages using the template with unsupported parameters are tracked in Category:Pages using infobox holiday with unknown parameters (2).

Other maintenance categories include: