Difference between revisions of "Template:Infobox lunar eclipse/doc"
Jump to navigation
Jump to search
imported>PhilipTerryGraham (Updated parameters and examples, after new update of template's design) |
imported>PhilipTerryGraham (Updated documentation with new "Syntax" and "Parameters" sections) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
| − | == | + | |
| − | {{ | + | == Syntax == |
| − | | type | + | {{Parameter names example | type | image | caption | image2 | date | axis | gamma | magnitude | radius | saros | totality | partiality | penumbral | p1 | u1 | u2 | greatest | u3 | u4 | p4 | previous | next }} |
| − | | image | ||
| − | | caption | ||
| − | | image2 | ||
| − | |||
| − | | date | ||
| − | | axis | ||
| − | | gamma | ||
| − | | magnitude | ||
| − | | radius | ||
| − | | saros | ||
| − | | totality | ||
| − | | partiality | ||
| − | | penumbral | ||
| − | | p1 | ||
| − | | u1 | ||
| − | | u2 | ||
| − | | greatest | ||
| − | | u3 | ||
| − | | u4 | ||
| − | | p4 | ||
| − | | previous | ||
| − | | next | ||
| − | }} | ||
<pre style="width:60%;"> | <pre style="width:60%;"> | ||
{{Infobox lunar eclipse | {{Infobox lunar eclipse | ||
| Line 33: | Line 10: | ||
| caption = | | caption = | ||
| image2 = | | image2 = | ||
| − | |||
| date = | | date = | ||
| axis = | | axis = | ||
| Line 54: | Line 30: | ||
}} | }} | ||
</pre> | </pre> | ||
| + | |||
| + | == Parameters == | ||
| + | {| class="wikitable" | ||
| + | ! Parameter | ||
| + | ! 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 when in use. | ||
| + | |- | ||
| + | | <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. | ||
| + | |- | ||
| + | | <code>image2</code> | ||
| + | | This second image parameter also displays a thumbnail image at the size of the user's preference. This parameter is intended to be used to display an infographic of the eclipse. [[:File:Lunar eclipse chart close-2018Jul27.png|This image]] would be an example of the kind intended to be displayed in this parameter. Omit the <code>File:</code> prefix when in use. When <code>image2</code> is active, a caption will also be active, using the <code><nowiki>{{#if:}}</nowiki></code> [[mw:Help:Extension:ParserFunctions##if|parser function]]. It reads "Chart of the eclipse; the ecliptic is up". | ||
| + | |- | ||
| + | | <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 both dates with an en dash. For example, the [[May 2004 lunar eclipse]] can be displayed as 4–5 May 2004. | ||
| + | |- | ||
| + | | <code>axis</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>gamma</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>magnitude</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>radius</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>saros</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>totality</code> | ||
| + | | rowspan="3"| 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>partiality</code> | ||
| + | |- | ||
| + | | <code>penumbral</code> | ||
| + | |- | ||
| + | | <code>p1</code> | ||
| + | | rowspan="7"| 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. | ||
| + | |- | ||
| + | | <code>u1</code> | ||
| + | |- | ||
| + | | <code>u2</code> | ||
| + | |- | ||
| + | | <code>greatest</code> | ||
| + | |- | ||
| + | | <code>u3</code> | ||
| + | |- | ||
| + | | <code>u4</code> | ||
| + | |- | ||
| + | | <code>p4</code> | ||
| + | |- | ||
| + | | <code>previous</code> | ||
| + | | rowspan="2"| These parameters activate succession [[wikilinks]] that help readers navigate to the previous and next lunar eclipses chronologically, regardless of eclipse type. The parameters themselves are encased in wikilinks that are completed by inputting a month and year. For example, setting the parameter to <code>January 2018</code> will set the wikilink to [[January 2018 lunar eclipse]]. | ||
| + | |- | ||
| + | | <code>next</code> | ||
| + | |} | ||
== Microformat == | == Microformat == | ||
Revision as of 10:46, 5 August 2018
| This is a documentation subpage for Template:Infobox lunar eclipse. It contains usage information, categories and other content that is not part of the original template page. |
Syntax
Template:Parameter names example
{{Infobox lunar eclipse
| type =
| image =
| caption =
| image2 =
| date =
| axis =
| gamma =
| magnitude =
| radius =
| saros =
| totality =
| partiality =
| penumbral =
| p1 =
| u1 =
| u2 =
| greatest =
| u3 =
| u4 =
| p4 =
| previous =
| next =
}}
Parameters
| Parameter | Description |
|---|---|
type
|
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 total can be used for a total eclipse, partial for a partial eclipse, and penumbral for penumbral eclipses.
|
image
|
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. This image would be an example of the kind intended to be displayed in this parameter. Omit the File: prefix when in use.
|
caption
|
This image caption parameter is intended to describe the photograph used in the image 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.
|
image2
|
This second image parameter also displays a thumbnail image at the size of the user's preference. This parameter is intended to be used to display an infographic of the eclipse. This image would be an example of the kind intended to be displayed in this parameter. Omit the File: prefix when in use. When image2 is active, a caption will also be active, using the {{#if:}} parser function. It reads "Chart of the eclipse; the ecliptic is up".
|
date
|
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 both dates with an en dash. For example, the May 2004 lunar eclipse can be displayed as 4–5 May 2004. |
axis
|
|
gamma
|
|
magnitude
|
|
radius
|
|
saros
|
|
totality
|
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, 102 minutes, 50 seconds. totality is used to display how long the totality phase of the eclipse lasted, partiality for the partiality phase, and penumbral for the penumbral phase. Omit the totality parameter completely if it is only a partial eclipse, and omit both totality and partiality if it is a penumbral eclipse.
|
partiality
| |
penumbral
| |
p1
|
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, u1 and u2 correspond to the points where the moon first enters the umbra (U1 contact) and is completely enveloped by it (U2). The greatest parameter corresponds to the point at which the moon is at its greatest eclipse.
|
u1
| |
u2
| |
greatest
| |
u3
| |
u4
| |
p4
| |
previous
|
These parameters activate succession wikilinks that help readers navigate to the previous and next lunar eclipses chronologically, regardless of eclipse type. The parameters themselves are encased in wikilinks that are completed by inputting a month and year. For example, setting the parameter to January 2018 will set the wikilink to January 2018 lunar eclipse.
|
next
|