View source for Template:Infobox lunar eclipse/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

'''{{tl|Infobox lunar eclipse}}''' is an {{tl|Infobox}}-based template that acts as a summary of information for an article on a specific [[lunar eclipse]]. It is largely designed to present the most relevant information on an eclipse to a casual astronomer, and intentionally omits highly specific details such as [[geocentric coordinates]] and [[ΔT|delta ''T'']] to avoid information bloating and keeping the infobox as short as reasonably possible. This infobox is designed with a subheading parameter, two image parameters, one caption parameter, sixteen cell parameters and two succession link parameters. Its syntax makes use of a collapsible list, two [[mw:Help:Extension:ParserFunctions##if|<code><nowiki>{{#if:}}</nowiki></code>]], and two [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser functions]], along with a [[hCalendar]] microformat.

== Syntax ==
{{Parameter names example | type | image | caption | image2 | date | gamma | magnitude | saros_ser | saros_no | cat_year | cat_no | totality | partiality | penumbral | p1 | u1 | u2 | greatest | u3 | u4 | p4 | previous | next }}
<pre style="width:60%;">
{{Infobox lunar eclipse
| type       = 
| image      = 
| alt        = 
| caption    = 
| date       = 
| gamma      = 
| magnitude  = 
| saros_ser  = 
| saros_no   = 
| totality   = 
| partiality = 
| penumbral  = 
| p1         = 
| u1         = 
| u2         = 
| greatest   = 
| u3         = 
| u4         = 
| p4         = 
| previous   = 
| next       = 
}}
</pre>

== Parameters ==
{| class="wikitable"
! Parameter(s)
! Description
|-
| <code>type</code>
| Specifies in the infobox headline what type of eclipse the event was. This parameter has three defined inputs, all of which correspond to a subheader style. The input <code>total</code> can be used for a total eclipse, <code>partial</code> for a partial eclipse, and <code>penumbral</code> for penumbral eclipses.
|-
| <code>image</code>
| This first image parameter displays an image thumbnail at the size of the user's preferences as specified in their settings. This parameter is intended to be used to display a photograph of the lunar eclipse, preferably in a tight square crop filled with a full disc view of the moon. [[:File:Lunar Total Eclipse on July 27, 2018 (100 2006) (43696968392) (cropped).jpg|This image]] would be an example of the kind intended to be displayed in this parameter. Omit the <code>File:</code> prefix in the filename when pasting it as an input to this parameter.
|-
| <code>alt</code>
| This image alt caption parameter allows for the input of an [[Wikipedia:Extended_image_syntax#Alt text and caption|alt caption]], which displays a description of the image when it fails to load. A simple description such as "{{xtd|A dark-red coloured Moon}}" should suffice.
|-
| <code>caption</code>
| This image caption parameter is intended to describe the photograph used in the <code>image</code> parameter above it, formatted as follows: the point during the eclipse it was taken, the location on Earth it was taken from, and the time it was taken in UTC. For example, "{{xtd|Totality from [[Wollongong|Wollongong, New South Wales]], 09:48 UTC}}"
|-
| <code>date</code>
| This parameter is used to display the date of the eclipse in [[Coordinated Universal Time]] (UTC), formatted in day-month-year. If the eclipse's penumbral stages occur across two dates in UTC, input only the date in which greatest eclipse occurs. For example, the [[July 2019 lunar eclipse]] occurs over 16–17 July 2019, though greatest eclipse occurs on 21:30:45 UTC on 16 July. Therefore, "{{xtd|16 July 2019}}" should be the input for the date.
|-
| <code>gamma</code>
| This parameter is used to display the [[Gamma (eclipse)|gamma]] value of an eclipse, with positive values written as a decimal number and negative values written with a minus sign (−) as a prefix. For example, the gamma of the [[May 2022 lunar eclipse]] is written as "{{xtd|-0.2532}}", and the gamma value for the [[May 2021 lunar eclipse]] is written as "{{xtd|0.4774}}".
|-
| <code>magnitude</code>
| This parameter is used to display either the penumbral or umbral [[Magnitude of eclipse|magnitude]] of the eclipse. If an eclipse is partial or total, the umbral magnitude is written in this parameter, while the penumbral magnitude is written in this parameter for penumbral eclipses.
|-
| <code>saros_ser</code>, <code>saros_no</code>
| These parameters are used to display both the [[Saros (astronomy)|saros series]] that a lunar eclipse belongs to, and which entry in the series it represents in parentheses. The first use is achieved using the <code>saros_ser</code> parameter, which uses the [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser function]] to check if a wikipedia article about a particular series exists. If it does, it automatically creates a [[wikilink]] to that article, and if not it simply displays the input as normal text. The second use is achieved using the <code>saros_no</code> parameter, where both the entry number the eclipse represents is displayed along the total amount of eclipses in the series, preferably conjoined with the preposition "{{xtd|of}}". For example, the [[June 2010 lunar eclipse]] is described in this parameter as "{{xtd|58 of 84}}" in [[Lunar Saros 120]].
|-
| <code>totality</code>, <code>partiality</code>, <code>penumbral</code>
| These parameters are used to display the amount of time each phase of the eclipse lasted, intended to be formatted in worded minutes and seconds. For example, {{xtd|102 minutes, 50 seconds}}. <code>totality</code> is used to display how long the totality phase of the eclipse lasted, <code>partiality</code> for the partiality phase, and <code>penumbral</code> for the penumbral phase. Omit the <code>totality</code> parameter completely if it is only a partial eclipse, and omit both <code>totality</code> and <code>partiality</code> if it is a penumbral eclipse.
|-
| <code>p1</code>, <code>u1</code>, <code>u2</code>, <code>greatest</code>, <code>u3</code>, <code>u4</code>, <code>p4</code>
| These parameters that form part of the collapsed "Contacts" section of the infobox are used to detail the exact times, in [[Coordinated Universal Time]] (UTC), the various contact points of the eclipse. For example, <code>u1</code> and <code>u2</code> correspond to the points where the moon first enters the [[umbra]] (U1 contact) and is completely enveloped by it (U2). The <code>greatest</code> parameter corresponds to the point at which the moon is at its greatest eclipse. If an eclipse occurs over two dates, be sure to note the date that is not represented in the <code>date</code> parameter. For example, <code>u4</code> for the [[July 2019 lunar eclipse]] should be set to "{{xtd|00:17:36 (17 July)}}"
|-
| <code>previous</code>, <code>next</code>
| These succession parameters at the bottom of the infobox are used to display the previous and next eclipse in chronological order and regardless of eclipse type, relative to the current one being detailed. The [[mw:Help:Extension:ParserFunctions##ifexist|<code><nowiki>{{#ifexist:}}</nowiki></code> parser function]] is used in this parameter to automatically create a [[wikilink]] if a wikipedia article on the previous and/or next eclipse exists. For example, setting either parameter to <code>January 2018</code> will set the wikilink to [[January 2018 lunar eclipse]].
|}

== Microformat ==
{{UF-hcal-geo}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Lunar eclipse templates]]

}}</includeonly>