View source for Template:Infobox holiday/doc

{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{intricate template}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Wikidata|Module:Check for unknown parameters}}
{{Uses Wikidata|P837}}

The <code>{{tl|{{BASEPAGENAME}}}}</code> template adds an infobox with data fields for defining a particular holiday.

=== Usage ===
<!-- Abstract usage of the template -->
<div style="width: 65%; overflow: auto; background: #dddddd; border: 1px solid black; padding:0.5em 1em 0.5em 1em;">
 <nowiki>{{</nowiki>Infobox holiday
 |holiday_name  = required
 |type          = required
 |image         =
 |imagesize     =
 |caption       =
 |official_name =
 |nickname      =
 |observedby    =
 |litcolor      =
 |longtype      =
 |significance  =
 |begins        =
 |ends          =
 |date          =
 |scheduling    = <nowiki><!-- e.g. "same day each year" --></nowiki>
 |duration      = <nowiki><!-- e.g. "1 day", "1 week" --></nowiki>
 |frequency     = <nowiki><!-- e.g. "annual", "every 4 years", "once" --></nowiki>
 <nowiki><!-- Use next three if holiday is the same day of the same week every year --></nowiki>
 |week_ordinal  = <nowiki><!-- "first", "second", "last", etc. --></nowiki>
 |weekday       = <nowiki><!-- "Sunday", "Monday", "Friday", etc. --></nowiki>
 |month         = <nowiki><!-- "January", "February", "December", etc. --></nowiki>
 <nowiki><!-- Use next four if the date changes in an unusual pattern each year --></nowiki>
 |date{{#time:Y|last year}}      = <nowiki><!-- only for days that change each year --></nowiki>
 |date{{#time:Y}}      = <nowiki><!-- only for days that change each year --></nowiki>
 |date{{#time:Y|next year}}      = <nowiki><!-- only for days that change each year --></nowiki>
 |date{{#time:Y|+2 years}}      = <nowiki><!-- only for days that change each year --></nowiki>
 |celebrations  =
 |observances   =
 |relatedto     =
 <nowiki>}}</nowiki>
</div>

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

<div style="width: 65%; overflow: auto; background: #dddddd; border: 1px solid black; padding:0.5em 1em 0.5em 1em;">
 <nowiki>{{</nowiki>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     =
 <nowiki>}}</nowiki>
</div>

=== 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:

{| class="wikitable"
!Type (param "type")!!Color
|-
|islam, islamic||bgcolor="LightGreen"|LightGreen
|-
|judaism, juda, jewish, jew||bgcolor="LightSkyBlue"|LightSkyBlue
|-
|buddhism, buddhist, buddha||bgcolor="PaleGoldenrod"|PaleGoldenRod
|-
|christian, christ, christianity||bgcolor="Lavender"|Lavender
|-
|asian, asian festival||bgcolor="RosyBrown"|RosyBrown
|-
|secular||bgcolor="DarkGray"|DarkGray
|-
|national, international, local, group|| style="background-color:#DDCCFF" |LightViolet
|-
|historical, cultural, patriotic, ethnic||bgcolor="LightSalmon"|LightSalmon
|-
|pagan||bgcolor="DarkKhaki"|DarkKhaki
|-
|commercial||bgcolor="Yellow"|Yellow
|-
|hindu, hinduism||bgcolor="orange"|Orange
|-
|shinto, shintoism||bgcolor="#FF5F5F"|Light red
|-
|default||bgcolor="LightSteelBlue"|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. 
;date{{CURRENTYEAR}}: highly recommended for holidays that don't stay on the same [[Gregorian calendar|Gregorian]] date - This is the Gregorian date on which the holiday will occur in {{CURRENTYEAR}}.  At the end of {{CURRENTYEAR}}, this will be replaced with '''date{{#expr:{{CURRENTYEAR}}+1}}''', which will later be replaced with '''date{{#expr:{{CURRENTYEAR}}+2}}'''. 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. [[Muslim]]s 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 '''date{{#expr:{{CURRENTYEAR}}-1}}''', '''date{{CURRENTYEAR}}''', '''date{{#expr:{{CURRENTYEAR}}+1}}''', etc.  If you specify '''week_ordinal''', then '''weekday''' and '''month''' are required also.
;date{{#expr:{{CURRENTYEAR}}-1}}, date{{#expr:{{CURRENTYEAR}}+1}}: recommended for holidays that don't stay on the same [[Gregorian calendar|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 ===
<!-- for the documentation don't subst the result -->

==== Same date every year ====
{|
| style="vertical-align:top;" | <pre>{{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]]
}}</pre>
| {{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]]
}}
|}

==== Same day of same week every year ====
{|
| style="vertical-align:top;" | <pre>{{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
}}</pre>
| {{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
}}
|}

==== Different days and dates each year ====
{|
| style="vertical-align:top;" | <pre>{{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
|date2019      = June 8
|date2020      = June 27
|date2021      = July 12
|date2022      = September 1
|date2023      = June 8
|observances   = Night of the Moon Cheese
}}</pre>
| {{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
|date2019      = June 8
|date2020      = June 27
|date2021      = July 12
|date2022      = September 1
|date2023      = June 8
|observances   = Night of the Moon Cheese
}}
|}

==== Formulas for calculating occurrences ====

Sample formulas used in [[Template:Infobox holiday/date]]:

*For [[First Day of Summer]]: first Thursday after 18 April:
*:<nowiki>{{Weekday after date|{{{year}}}|April|18|Thursday}}</nowiki>
*:''See also:'' [[Template:Weekday after date]]
*For [[Victoria Day (Scotland)]]: last Monday before or on 24 May
*:<nowiki>{{Weekday before date|{{{year}}}|May|25|Monday}}</nowiki>
*:''See also:'' [[Template:Weekday before date]]
*For [[Sexagesima]]: second Sunday before [[Ash Wednesday]] (56 calendar days before Easter Sunday)
*:<nowiki>{{#invoke:Easter|Calculate|{{{year}}}|day=-56|format=F j}}</nowiki>
*:''See also:'' [[Module:Easter]]

For some holidays, this is still defined on the holiday page itself. For [[First Day of Summer]], this would be: 
<pre>
|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}}
</pre>

=== Tracking categories===
Pages using the template with unsupported parameters are tracked in {{clc|Pages using infobox holiday with unknown parameters}}.

Other maintenance categories include:
* {{clc|Infobox holiday with missing field}}
* {{clc|Moveable holidays (2015 date missing)}}
* {{clc|Moveable holidays (to check)}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Events infobox templates|Holiday]]
[[Category:Infobox templates using Wikidata]]
[[Category:Templates that add a tracking category]]
}}</includeonly>